Comparing version 0.5.0 to 1.0.0
107
package.json
| { | ||
| "name": "he", | ||
| "version": "0.5.0", | ||
| "description": "A robust HTML entities encoder/decoder with full Unicode support.", | ||
| "homepage": "http://mths.be/he", | ||
| "main": "he.js", | ||
| "bin": "bin/he", | ||
| "keywords": [ | ||
| "string", | ||
| "entities", | ||
| "entity", | ||
| "html", | ||
| "encode", | ||
| "decode", | ||
| "unicode" | ||
| ], | ||
| "license": "MIT", | ||
| "author": { | ||
| "name": "Mathias Bynens", | ||
| "url": "https://mathiasbynens.be/" | ||
| }, | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/mathiasbynens/he.git" | ||
| }, | ||
| "bugs": "https://github.com/mathiasbynens/he/issues", | ||
| "files": [ | ||
| "LICENSE-MIT.txt", | ||
| "he.js", | ||
| "bin/", | ||
| "man/" | ||
| ], | ||
| "directories": { | ||
| "bin": "bin", | ||
| "man": "man", | ||
| "test": "tests" | ||
| }, | ||
| "scripts": { | ||
| "test": "node tests/tests.js" | ||
| }, | ||
| "devDependencies": { | ||
| "coveralls": "^2.11.1", | ||
| "grunt": "^0.4.5", | ||
| "grunt-shell": "^1.0.1", | ||
| "grunt-template": "^0.2.3", | ||
| "istanbul": "^0.3.0", | ||
| "jsesc": "^0.5.0", | ||
| "lodash": "^2.4.1", | ||
| "qunit-extras": "^1.1.0", | ||
| "qunitjs": "~1.11.0", | ||
| "regenerate": "^0.6.2", | ||
| "requirejs": "^2.1.14", | ||
| "string.fromcodepoint": "^0.2.1" | ||
| } | ||
| "name": "he", | ||
| "version": "1.0.0", | ||
| "description": "A robust HTML entities encoder/decoder with full Unicode support.", | ||
| "homepage": "https://mths.be/he", | ||
| "main": "he.js", | ||
| "bin": "bin/he", | ||
| "keywords": [ | ||
| "string", | ||
| "entities", | ||
| "entity", | ||
| "html", | ||
| "encode", | ||
| "decode", | ||
| "unicode" | ||
| ], | ||
| "license": "MIT", | ||
| "author": { | ||
| "name": "Mathias Bynens", | ||
| "url": "https://mathiasbynens.be/" | ||
| }, | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "https://github.com/mathiasbynens/he.git" | ||
| }, | ||
| "bugs": "https://github.com/mathiasbynens/he/issues", | ||
| "files": [ | ||
| "LICENSE-MIT.txt", | ||
| "he.js", | ||
| "bin/", | ||
| "man/" | ||
| ], | ||
| "directories": { | ||
| "bin": "bin", | ||
| "man": "man", | ||
| "test": "tests" | ||
| }, | ||
| "scripts": { | ||
| "test": "node tests/tests.js", | ||
| "build": "grunt build" | ||
| }, | ||
| "devDependencies": { | ||
| "codecov.io": "^0.1.6", | ||
| "grunt": "^0.4.5", | ||
| "grunt-shell": "^1.1.1", | ||
| "grunt-template": "^0.2.3", | ||
| "istanbul": "^0.4.2", | ||
| "jsesc": "^1.0.0", | ||
| "lodash": "^4.8.2", | ||
| "qunit-extras": "^1.4.5", | ||
| "qunitjs": "~1.11.0", | ||
| "regenerate": "^1.2.1", | ||
| "requirejs": "^2.1.22", | ||
| "sort-object": "^3.0.2" | ||
| } | ||
| } |
@@ -1,8 +0,8 @@ | ||
| # he [](https://travis-ci.org/mathiasbynens/he) [](https://coveralls.io/r/mathiasbynens/he) [](https://gemnasium.com/mathiasbynens/he) | ||
| # he [](https://travis-ci.org/mathiasbynens/he) [](https://codecov.io/github/mathiasbynens/he?branch=master) [](https://gemnasium.com/mathiasbynens/he) | ||
| _he_ (for “HTML entities”) is a robust HTML entity encoder/decoder written in JavaScript. It supports [all standardized named character references as per HTML](http://www.whatwg.org/specs/web-apps/current-work/multipage/named-character-references.html), handles [ambiguous ampersands](https://mathiasbynens.be/notes/ambiguous-ampersands) and other edge cases [just like a browser would](http://www.whatwg.org/specs/web-apps/current-work/multipage/tokenization.html#tokenizing-character-references), has an extensive test suite, and — contrary to many other JavaScript solutions — _he_ handles astral Unicode symbols just fine. [An online demo is available.](http://mothereff.in/html-entities) | ||
| _he_ (for “HTML entities”) is a robust HTML entity encoder/decoder written in JavaScript. It supports [all standardized named character references as per HTML](https://html.spec.whatwg.org/multipage/syntax.html#named-character-references), handles [ambiguous ampersands](https://mathiasbynens.be/notes/ambiguous-ampersands) and other edge cases [just like a browser would](https://html.spec.whatwg.org/multipage/syntax.html#tokenizing-character-references), has an extensive test suite, and — contrary to many other JavaScript solutions — _he_ handles astral Unicode symbols just fine. [An online demo is available.](https://mothereff.in/html-entities) | ||
| ## Installation | ||
| Via [npm](http://npmjs.org/): | ||
| Via [npm](https://www.npmjs.com/): | ||
@@ -31,3 +31,3 @@ ```bash | ||
| In [Narwhal](http://narwhaljs.org/), [Node.js](http://nodejs.org/), and [RingoJS](http://ringojs.org/): | ||
| In [Node.js](https://nodejs.org/), [io.js](https://iojs.org/), [Narwhal](http://narwhaljs.org/), and [RingoJS](http://ringojs.org/): | ||
@@ -75,3 +75,3 @@ ```js | ||
| As long as the input string contains [allowed code points](http://www.whatwg.org/specs/web-apps/current-work/multipage/parsing.html#preprocessing-the-input-stream) only, the return value of this function is always valid HTML. Any [(invalid) code points that cannot be represented using a character reference](http://www.whatwg.org/specs/web-apps/current-work/multipage/tokenization.html#table-charref-overrides) in the input are not encoded. | ||
| As long as the input string contains [allowed code points](https://html.spec.whatwg.org/multipage/parsing.html#preprocessing-the-input-stream) only, the return value of this function is always valid HTML. Any [(invalid) code points that cannot be represented using a character reference](https://html.spec.whatwg.org/multipage/syntax.html#table-charref-overrides) in the input are not encoded. | ||
@@ -134,3 +134,3 @@ ```js | ||
| The default value for the `strict` option is `false`. This means that `encode()` will encode any HTML text content you feed it, even if it contains any symbols that cause [parse errors](http://www.whatwg.org/specs/web-apps/current-work/multipage/parsing.html#preprocessing-the-input-stream). To throw an error when such invalid HTML is encountered, set the `strict` option to `true`. This option makes it possible to use _he_ as part of HTML parsers and HTML validators. | ||
| The default value for the `strict` option is `false`. This means that `encode()` will encode any HTML text content you feed it, even if it contains any symbols that cause [parse errors](https://html.spec.whatwg.org/multipage/parsing.html#preprocessing-the-input-stream). To throw an error when such invalid HTML is encountered, set the `strict` option to `true`. This option makes it possible to use _he_ as part of HTML parsers and HTML validators. | ||
@@ -185,3 +185,3 @@ ```js | ||
| This function takes a string of HTML and decodes any named and numerical character references in it using [the algorithm described in section 12.2.4.69 of the HTML spec](http://www.whatwg.org/specs/web-apps/current-work/multipage/tokenization.html#tokenizing-character-references). | ||
| This function takes a string of HTML and decodes any named and numerical character references in it using [the algorithm described in section 12.2.4.69 of the HTML spec](https://html.spec.whatwg.org/multipage/syntax.html#tokenizing-character-references). | ||
@@ -197,3 +197,3 @@ ```js | ||
| The default value for the `isAttributeValue` option is `false`. This means that `decode()` will decode the string as if it were used in [a text context in an HTML document](http://www.whatwg.org/specs/web-apps/current-work/multipage/tokenization.html#data-state). HTML has different rules for [parsing character references in attribute values](http://www.whatwg.org/specs/web-apps/current-work/multipage/tokenization.html#character-reference-in-attribute-value-state) — set this option to `true` to treat the input string as if it were used as an attribute value. | ||
| The default value for the `isAttributeValue` option is `false`. This means that `decode()` will decode the string as if it were used in [a text context in an HTML document](https://html.spec.whatwg.org/multipage/syntax.html#data-state). HTML has different rules for [parsing character references in attribute values](https://html.spec.whatwg.org/multipage/syntax.html#character-reference-in-attribute-value-state) — set this option to `true` to treat the input string as if it were used as an attribute value. | ||
@@ -220,3 +220,3 @@ ```js | ||
| The default value for the `strict` option is `false`. This means that `decode()` will decode any HTML text content you feed it, even if it contains any entities that cause [parse errors](http://www.whatwg.org/specs/web-apps/current-work/multipage/tokenization.html#tokenizing-character-references). To throw an error when such invalid HTML is encountered, set the `strict` option to `true`. This option makes it possible to use _he_ as part of HTML parsers and HTML validators. | ||
| The default value for the `strict` option is `false`. This means that `decode()` will decode any HTML text content you feed it, even if it contains any entities that cause [parse errors](https://html.spec.whatwg.org/multipage/syntax.html#tokenizing-character-references). To throw an error when such invalid HTML is encountered, set the `strict` option to `true`. This option makes it possible to use _he_ as part of HTML parsers and HTML validators. | ||
@@ -320,4 +320,16 @@ ```js | ||
| he has been tested in at least Chrome 27-29, Firefox 3-22, Safari 4-6, Opera 10-12, IE 6-10, Node.js v0.10.0, Narwhal 0.3.2, RingoJS 0.8-0.9, PhantomJS 1.9.0, and Rhino 1.7RC4. | ||
| _he_ has been tested in at least: | ||
| * Chrome 27-50 | ||
| * Firefox 3-45 | ||
| * Safari 4-9 | ||
| * Opera 10-12, 15–37 | ||
| * IE 6–11 | ||
| * Edge | ||
| * Narwhal 0.3.2 | ||
| * Node.js v0.10, v0.12, v4, v5 | ||
| * PhantomJS 1.9.0 | ||
| * Rhino 1.7RC4 | ||
| * RingoJS 0.8-0.11 | ||
| ## Unit tests & code coverage | ||
@@ -333,3 +345,3 @@ | ||
| Thanks to [Simon Pieters](http://simon.html5.org/) ([@zcorpan](https://twitter.com/zcorpan)) for the many suggestions. | ||
| Thanks to [Simon Pieters](https://simon.html5.org/) ([@zcorpan](https://twitter.com/zcorpan)) for the many suggestions. | ||
@@ -344,2 +356,2 @@ ## Author | ||
| _he_ is available under the [MIT](http://mths.be/mit) license. | ||
| _he_ is available under the [MIT](https://mths.be/mit) license. |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Fixed alerts
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.08%
105896
- Lines of code
- increased by0.34%
592
- Number of low quality alerts
- decreased by-100%
0
- Number of lines in readme file
- increased by3.56%
349
No dependency changes