summaryrefslogtreecommitdiff
path: root/tools/node_modules/eslint/node_modules/parse-entities/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/parse-entities/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/parse-entities/readme.md')
-rw-r--r--tools/node_modules/eslint/node_modules/parse-entities/readme.md157
1 files changed, 157 insertions, 0 deletions
diff --git a/tools/node_modules/eslint/node_modules/parse-entities/readme.md b/tools/node_modules/eslint/node_modules/parse-entities/readme.md
new file mode 100644
index 0000000000..9361031183
--- /dev/null
+++ b/tools/node_modules/eslint/node_modules/parse-entities/readme.md
@@ -0,0 +1,157 @@
+# parse-entities [![Build Status][build-badge]][build-status] [![Coverage Status][coverage-badge]][coverage-status]
+
+Parse HTML character references: fast, spec-compliant, positional
+information.
+
+## Installation
+
+[npm][]:
+
+```bash
+npm install parse-entities
+```
+
+## Usage
+
+```js
+var decode = require('parse-entities');
+
+decode('alpha &amp bravo');
+//=> alpha & bravo
+
+decode('charlie &copycat; delta');
+//=> charlie ©cat; delta
+
+decode('echo &copy; foxtrot &#8800; golf &#x1D306; hotel');
+//=> echo © foxtrot ≠ golf 𝌆 hotel
+```
+
+## API
+
+## `parseEntities(value[, options])`
+
+###### `options`
+
+* `additional` (`string`, optional, default: `''`)
+ — Additional character to accept when following an ampersand (without
+ error)
+* `attribute` (`boolean`, optional, default: `false`)
+ — Whether to parse `value` as an attribute value
+* `nonTerminated` (`boolean`, default: `true`)
+ — Whether to allow non-terminated entities, such as `&copycat` to
+ `©cat`. This behaviour is spec-compliant but can lead to unexpected
+ results
+* `warning` ([`Function`][warning], optional)
+ — Error handler
+* `text` ([`Function`][text], optional)
+ — Text handler
+* `reference` ([`Function`][reference],
+ optional) — Reference handler
+* `warningContext` (`'*'`, optional)
+ — Context used when invoking `warning`
+* `textContext` (`'*'`, optional)
+ — Context used when invoking `text`
+* `referenceContext` (`'*'`, optional)
+ — Context used when invoking `reference`
+* `position` (`Location` or `Position`, optional)
+ — Starting `position` of `value`, useful when dealing with values
+ nested in some sort of syntax tree. The default is:
+
+ ```json
+ {
+ "start": {
+ "line": 1,
+ "column": 1,
+ "offset": 0
+ },
+ "indent": []
+ }
+ ```
+
+###### Returns
+
+`string` — Decoded `value`.
+
+### `function warning(reason, position, code)`
+
+Error handler.
+
+###### Context
+
+`this` refers to `warningContext` when given to `parseEntities`.
+
+###### Parameters
+
+* `reason` (`string`)
+ — Reason (human-readable) for triggering a parse error
+* `position` (`Position`)
+ — Place at which the parse error occurred
+* `code` (`number`)
+ — Identifier of reason for triggering a parse error
+
+The following codes are used:
+
+| Code | Example | Note |
+| ---- | ------------------ | --------------------------------------------- |
+| `1` | `foo &amp bar` | Missing semicolon (named) |
+| `2` | `foo &#123 bar` | Missing semicolon (numeric) |
+| `3` | `Foo &bar baz` | Ampersand did not start a reference |
+| `4` | `Foo &#` | Empty reference |
+| `5` | `Foo &bar; baz` | Unknown entity |
+| `6` | `Foo &#128; baz` | [Disallowed reference][invalid] |
+| `7` | `Foo &#xD800; baz` | Prohibited: outside permissible unicode range |
+
+###### `function text(value, location)`
+
+Text handler.
+
+###### Context
+
+`this` refers to `textContext` when given to `parseEntities`.
+
+###### Parameters
+
+* `value` (`string`) — String of content
+* `location` (`Location`) — Location at which `value` starts and ends
+
+### `function reference(value, location, source)`
+
+Character reference handler.
+
+###### Context
+
+`this` refers to `referenceContext` when given to `parseEntities`.
+
+###### Parameters
+
+* `value` (`string`) — Encoded character reference
+* `location` (`Location`) — Location at which `value` starts and ends
+* `source` (`Location`) — Source of character reference
+
+## License
+
+[MIT][license] © [Titus Wormer][author]
+
+<!-- Definitions -->
+
+[build-badge]: https://img.shields.io/travis/wooorm/parse-entities.svg
+
+[build-status]: https://travis-ci.org/wooorm/parse-entities
+
+[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/parse-entities.svg
+
+[coverage-status]: https://codecov.io/github/wooorm/parse-entities
+
+[npm]: https://docs.npmjs.com/cli/install
+
+[license]: LICENSE
+
+[author]: http://wooorm.com
+
+[warning]: #function-warningreason-position-code
+
+[text]: #function-textvalue-location
+
+[reference]: #function-referencevalue-location-source
+
+[invalid]: https://github.com/wooorm/character-reference-invalid