summaryrefslogtreecommitdiff
path: root/tools/node_modules/eslint/node_modules/unist-util-remove-position/readme.md
diff options
context:
space:
mode:
authorMichaël Zasso <targos@protonmail.com>2017-12-22 16:53:42 +0100
committerMichaël Zasso <targos@protonmail.com>2018-01-11 09:48:05 +0100
commit3dc30632755713179f345f4af024bd904c6162d0 (patch)
treef28c4f6dd6dfc5992edf301449d1a371d229755b /tools/node_modules/eslint/node_modules/unist-util-remove-position/readme.md
parenta2c7085dd4a8e60d1a47572aca8bb6fcb7a32f88 (diff)
downloadandroid-node-v8-3dc30632755713179f345f4af024bd904c6162d0.tar.gz
android-node-v8-3dc30632755713179f345f4af024bd904c6162d0.tar.bz2
android-node-v8-3dc30632755713179f345f4af024bd904c6162d0.zip
tools: move eslint from tools to tools/node_modules
This is required because we need to add the babel-eslint dependency and it has to be able to resolve "eslint". babel-eslint is required to support future ES features such as async iterators and import.meta. Refs: https://github.com/nodejs/node/pull/17755 PR-URL: https://github.com/nodejs/node/pull/17820 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Diffstat (limited to 'tools/node_modules/eslint/node_modules/unist-util-remove-position/readme.md')
-rw-r--r--tools/node_modules/eslint/node_modules/unist-util-remove-position/readme.md77
1 files changed, 77 insertions, 0 deletions
diff --git a/tools/node_modules/eslint/node_modules/unist-util-remove-position/readme.md b/tools/node_modules/eslint/node_modules/unist-util-remove-position/readme.md
new file mode 100644
index 0000000000..6063836f57
--- /dev/null
+++ b/tools/node_modules/eslint/node_modules/unist-util-remove-position/readme.md
@@ -0,0 +1,77 @@
+# unist-util-remove-position [![Build Status][travis-badge]][travis] [![Coverage Status][codecov-badge]][codecov]
+
+Remove [`position`][position]s from a [Unist][] tree.
+
+## Installation
+
+[npm][]:
+
+```bash
+npm install unist-util-remove-position
+```
+
+## Usage
+
+```javascript
+var remark = require('remark');
+var removePosition = require('unist-util-remove-position');
+
+var tree = remark().parse('Some _emphasis_, **importance**, and `code`.');
+
+console.dir(removePosition(tree, true), {depth: null});
+```
+
+Yields:
+
+```js
+{ type: 'root',
+ children:
+ [ { type: 'paragraph',
+ children:
+ [ { type: 'text', value: 'Some ' },
+ { type: 'emphasis',
+ children: [ { type: 'text', value: 'emphasis' } ] },
+ { type: 'text', value: ', ' },
+ { type: 'strong',
+ children: [ { type: 'text', value: 'importance' } ] },
+ { type: 'text', value: ', and ' },
+ { type: 'inlineCode', value: 'code' },
+ { type: 'text', value: '.' } ] } ] }
+```
+
+## API
+
+### `removePosition(node[, force])`
+
+Remove [`position`][position]s from [`node`][node]. If `force` is given,
+uses `delete`, otherwise, sets `position`s to `undefined`.
+
+###### Returns
+
+The given `node`.
+
+## License
+
+[MIT][license] © [Titus Wormer][author]
+
+<!-- Definitions -->
+
+[travis-badge]: https://img.shields.io/travis/syntax-tree/unist-util-remove-position.svg
+
+[travis]: https://travis-ci.org/syntax-tree/unist-util-remove-position
+
+[codecov-badge]: https://img.shields.io/codecov/c/github/syntax-tree/unist-util-remove-position.svg
+
+[codecov]: https://codecov.io/github/syntax-tree/unist-util-remove-position
+
+[npm]: https://docs.npmjs.com/cli/install
+
+[license]: LICENSE
+
+[author]: http://wooorm.com
+
+[unist]: https://github.com/syntax-tree/unist
+
+[position]: https://github.com/syntax-tree/unist#position
+
+[node]: https://github.com/syntax-tree/unist#node