forked from inikulin/parse5
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): Update documentation links (inikulin#472)
Co-authored-by: Titus <tituswormer@gmail.com>
- Loading branch information
Showing
9 changed files
with
17 additions
and
244 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,230 +1,3 @@ | ||
| # Version history | ||
| # Changelog | ||
|
|
||
| # 6.0.1 | ||
| * Fixed: Handling of self-closing `<hr>` tags (by [@43081j](https://github.com/43081j)). | ||
| * Fixed: Broken link in TreeAdapter document (GH [#317](https://github.com/inikulin/parse5/issues/317)) (by [@ursm](https://github.com/ursm)). | ||
| * Fixed: SAXParser example (GH [#316](https://github.com/inikulin/parse5/issues/316)) (by [@mvasilkov](https://github.com/mvasilkov)). | ||
|
|
||
| # 6.0.0 | ||
| * Added (**breaking**): Tree adapter interface now has `updateNodeSourceCodeLocation` method which | ||
| enables usage of custom location info formats (GH [#314](https://github.com/inikulin/parse5/issues/314)) (by [@DMartens](https://github.com/DMartens)). | ||
|
|
||
|
|
||
| # 5.1.1 | ||
| * Fixed: Serialization of attributes in non-standard namespaces (by [@Zirro](https://github.com/Zirro)). | ||
| * Fixed: Quirks and limited-quirks mode detection by doctype (by [@squidfunk](https://github.com/squidfunk)). | ||
|
|
||
| # 5.1.0 | ||
|
|
||
| * Fixed: Location info for `text` events in `SAXParser` and `RewritingStream` now contains | ||
| correct `endCol` and `endLine` covering all concatenated raw tokens (GH [#266](https://github.com/inikulin/parse5/issues/266)). | ||
| * Fixed: `SAXParser` and `RewritingStream` now flush last buffered chunk when calling `.end()` with | ||
| no parameters (GH [#271](https://github.com/inikulin/parse5/issues/271)). | ||
| * Updated (**breaking**): `ParserStream`, `SAXParser` and `RewritingStream` no longer assume that | ||
| each binary chunk is a valid finished UTF-8 chunk, and instead accept only decoded strings (GH [#269](https://github.com/inikulin/parse5/issues/269)). | ||
|
|
||
| # 5.0.0 | ||
|
|
||
| Starting from this release `parse5` functionality will be shipped in separate packages. | ||
| With `parse5` package contatining only basic functionality. Please, refer to the [list of packages](https://github.com/inikulin/parse5/tree/master/) for more info. | ||
|
|
||
| * Updated (**breaking**): source code location now inserted by tree adapter, so tree adapter developers | ||
| have control over location info property name. Tree adapters should implement [setNodeSourceCodeLocation](https://github.com/inikulin/parse5/blob/master/packages/parse5/docs/tree-adapter/interface.md#setnodesourcecodelocation) and | ||
| [getNodeSourceCodeLocation](https://github.com/inikulin/parse5/blob/master/packages/parse5/docs/tree-adapter/interface.md#getnodesourcecodelocation) methods. | ||
| Location info property name added by currently implemented tree adapters has been renamed from `__location` to `sourceCodeLocation` | ||
| (GH [#189](https://github.com/inikulin/parse5/issues/189)). | ||
|
|
||
| * Updated (**breaking**): Location info `line` and `col` properties have been renamed to [startLine](https://github.com/inikulin/parse5/blob/master/packages/parse5/docs/source-code-location/location.md#startline) and | ||
| [startCol](https://github.com/inikulin/parse5/blob/master/packages/parse5/docs/source-code-location/location.md#startcol) | ||
| respectively. | ||
|
|
||
| * Updated (**breaking**): `SAXParser` now passes token objects to event handlers instead of separate arguments. See [SAXParser documentation](https://github.com/inikulin/parse5/blob/master/packages/parse5-sax-parser/docs/index.md) for more info. | ||
| (GH [#247](https://github.com/inikulin/parse5/issues/247)). | ||
|
|
||
| * Added: [endLine](https://github.com/inikulin/parse5/blob/master/packages/parse5/docs/source-code-location/location.md#endline) and [endCol](https://github.com/inikulin/parse5/blob/master/packages/parse5/docs/source-code-location/location.md#endcol) location info | ||
| properties. | ||
|
|
||
| * Added: [scriptingEnabled](https://github.com/inikulin/parse5/blob/master/packages/parse5/docs/options/parser-options.md#scriptingenabled) flag to the `ParserOptions` which controls how `<noscript>` tags are handled by the parser. (GH [#192](https://github.com/inikulin/parse5/issues/192)). | ||
|
|
||
| * Added: [HTML rewriting stream](https://github.com/inikulin/parse5/tree/master/packages/parse5-html-rewriting-stream#readme). | ||
| (GH [#222](https://github.com/inikulin/parse5/issues/222)). | ||
|
|
||
| * Removed (**breaking**): `parse5` no longer ship TypeScript definitions. Existing TypeScript definitions | ||
| have been moved to DefinitelyTyped repo. Please, track the [PR](https://github.com/DefinitelyTyped/DefinitelyTyped/pull/25943) in the DefinitelyTyped repo for the updates. | ||
|
|
||
|
|
||
| ## 4.0.0 | ||
| This is a major release that delivers few minor (but breaking) changes to workaround recently appeared | ||
| issues with TypeScript Node.js typings versioning and usage of parse5 in environments that are | ||
| distinct from Node.js (see https://github.com/inikulin/parse5/issues/235 for the details). | ||
|
|
||
| * Updated (**breaking**): TypeScript were disabled by default. See [TypeScript definitions](#typescript-definitions) section | ||
| for the details on how to enable them. | ||
| * Updated: API that depends on Node.js specific (namely `ParserStream`, `PlainTextConversionStream`, | ||
| `SerializerStream`, `SAXParser`) is now lazily loaded. That enables bundling of the basic functionality | ||
| for other platforms (e.g. for browsers via webpack). | ||
|
|
||
| ## 3.0.3 | ||
| * Fixed: Loosen the dependency version of `@types/node` (by [@gfx](https://github.com/gfx)). | ||
| * Fixed: Incorrect AST generated if empty string fed to `ParserStream` (GH [#195](https://github.com/inikulin/parse5/issues/195)) (by [@stevenvachon](https://github.com/stevenvachon)). | ||
|
|
||
| ## 3.0.2 | ||
| * Fixed: `location.startTag` is not available if end tag is missing (GH [#181](https://github.com/inikulin/parse5/issues/181)). | ||
|
|
||
| ## 3.0.1 | ||
| * Fixed: `MarkupData.Location.col` description in TypeScript definition file (GH [#170](https://github.com/inikulin/parse5/issues/170)). | ||
|
|
||
| ## 3.0.0 | ||
| * Added: parse5 now ships with TypeScript definitions from which [new documentation website](http://inikulin.github.io/parse5/) is generated (GH [#125](https://github.com/inikulin/parse5/issues/125)). | ||
| * Added: [PlainTextConversionStream](http://inikulin.github.io/parse5/classes/plaintextconversionstream.html) (GH [#135](https://github.com/inikulin/parse5/issues/135)). | ||
| * Updated: [Significantly reduced initial memory consumption](https://github.com/inikulin/parse5/tree/master/scripts/generate_named_entity_data#named-entity-array-mapped-radix-tree-generator) (GH [#52](https://github.com/inikulin/parse5/issues/52)). | ||
| * Updated (**breaking**): Added support for limited quirks mode. `document.quirksMode` property was replaced with `document.mode` property which can have | ||
| `'no-quirks'`, `'quirks'` and `'limited-quirks'` values. Tree adapter `setQuirksMode ` and `isQuirksMode` methods were replaced with `setDocumentMode` and `getDocumentMode` methods (GH [#83](https://github.com/inikulin/parse5/issues/83)). | ||
| * Updated (**breaking**): AST collections (e.g. attributes dictionary) don't have prototype anymore (GH [#119](https://github.com/inikulin/parse5/issues/119)). | ||
| * Updated (**breaking**): Doctype now always serialized as `<!DOCTYPE html>` as per spec (GH [#137](https://github.com/inikulin/parse5/issues/137)). | ||
| * Fixed: Incorrect line for `__location.endTag` when the start tag contains newlines (GH [#166](https://github.com/inikulin/parse5/issues/166)) (by [@webdesus](https://github.com/webdesus)). | ||
|
|
||
| ## 2.2.3 | ||
| * Fixed: Fixed incorrect LocationInfo.endOffset for non-implicitly closed elements (refix for GH [#109](https://github.com/inikulin/parse5/issues/109)) (by [@wooorm](https://github.com/wooorm)). | ||
|
|
||
| ## 2.2.2 | ||
| * Fixed: Incorrect location info for text in SAXParser (GH [#153](https://github.com/inikulin/parse5/issues/153)). | ||
| * Fixed: Incorrect `LocationInfo.endOffset` for implicitly closed `<p>` element (GH [#109](https://github.com/inikulin/parse5/issues/109)). | ||
| * Fixed: Infinite input data buffering in streaming parsers. Now parsers try to not buffer more than 64K of input data. | ||
| However, there are still some edge cases left that will lead to significant memory consumption, but they are quite exotic | ||
| and extremely rare in the wild (GH [#102](https://github.com/inikulin/parse5/issues/102), GH [#130](https://github.com/inikulin/parse5/issues/130)); | ||
|
|
||
|
|
||
| ## 2.2.1 | ||
| * Fixed: SAXParser HTML integration point handling for adjustable SVG tags. | ||
| * Fixed: SAXParser now adjust SVG tag names for end tags. | ||
| * Fixed: Location info line calculation on tokenizer character unconsumption (by [@ChadKillingsworth](https://github.com/ChadKillingsworth)). | ||
|
|
||
| ## 2.2.0 | ||
| * SAXParser (by [@RReverser](https://github.com/RReverser)) | ||
| * Fixed: Handling of `\n` in `<pre>`, `<textarea>` and `<listing>`. | ||
| * Fixed: Tag names and attribute names adjustment in foreign content (GH [#99](https://github.com/inikulin/parse5/issues/99)). | ||
| * Fixed: Handling of `<image>`. | ||
|
|
||
| * Latest spec changes | ||
| * Updated: `<isindex>` now don't have special handling (GH [#122](https://github.com/inikulin/parse5/issues/122)). | ||
| * Updated: Adoption agency algorithm now preserves lexical order of text nodes (GH [#129](https://github.com/inikulin/parse5/issues/129)). | ||
| * Updated: `<menuitem>` now behaves like `<option>`. | ||
|
|
||
| * Fixed: Element nesting corrections now take namespaces into consideration. | ||
|
|
||
| ## 2.1.5 | ||
| * Fixed: ParserStream accidentally hangs up on scripts (GH [#101](https://github.com/inikulin/parse5/issues/101)). | ||
|
|
||
| ## 2.1.4 | ||
| * Fixed: Keep ParserStream sync for the inline scripts (GH [#98](https://github.com/inikulin/parse5/issues/98) follow up). | ||
|
|
||
| ## 2.1.3 | ||
| * Fixed: Synchronously calling resume() leads to crash (GH [#98](https://github.com/inikulin/parse5/issues/98)). | ||
|
|
||
| ## 2.1.2 | ||
| * Fixed: SAX parser silently exits on big files (GH [#97](https://github.com/inikulin/parse5/issues/97)). | ||
|
|
||
| ## 2.1.1 | ||
| * Fixed: location info not attached for empty attributes (GH [#96](https://github.com/inikulin/parse5/issues/96)) | ||
| (by [@yyx990803](https://github.com/yyx990803)). | ||
|
|
||
| ## 2.1.0 | ||
| * Added: location info for attributes (GH [#43](https://github.com/inikulin/parse5/issues/43)) (by [@sakagg](https://github.com/sakagg) | ||
| and [@yyx990803](https://github.com/yyx990803)). | ||
| * Fixed: `parseFragment` with `locationInfo` regression when parsing `<template>`(GH [#90](https://github.com/inikulin/parse5/issues/90)) | ||
| (by [@yyx990803](https://github.com/yyx990803)). | ||
|
|
||
| ## 2.0.2 | ||
| * Fixed: yet another case of incorrect `parseFragment` arguments fallback (GH [#84](https://github.com/inikulin/parse5/issues/84)). | ||
|
|
||
| ## 2.0.1 | ||
| * Fixed: `parseFragment` arguments processing (GH [#82](https://github.com/inikulin/parse5/issues/82)). | ||
|
|
||
| ## 2.0.0 | ||
| * Added: [ParserStream](https://github.com/inikulin/parse5/wiki/Documentation#parse5+ParserStream) with the scripting support. (GH [#26](https://github.com/inikulin/parse5/issues/26)). | ||
| * Added: [SerializerStream](https://github.com/inikulin/parse5/wiki/Documentation#parse5+SerializerStream). (GH [#26](https://github.com/inikulin/parse5/issues/26)). | ||
| * Added: Line/column location info. (GH [#67](https://github.com/inikulin/parse5/issues/67)). | ||
| * Update (**breaking**): Location info properties `start` and `end` were renamed to `startOffset` and `endOffset` respectively. | ||
| * Update (**breaking**): `SimpleApiParser` was renamed to [SAXParser](https://github.com/inikulin/parse5/wiki/Documentation#parse5+SAXParser). | ||
| * Update (**breaking**): [SAXParser](https://github.com/inikulin/parse5/wiki/Documentation#parse5+SAXParser) is the [transform stream](https://nodejs.org/api/stream.html#stream_class_stream_transform) | ||
| now. (GH [#26](https://github.com/inikulin/parse5/issues/26)). | ||
| * Update (**breaking**): [SAXParser](https://github.com/inikulin/parse5/wiki/Documentation#parse5+SAXParser) handler subscription is done via events now. | ||
| * Added: [SAXParser.stop()](https://github.com/inikulin/parse5/wiki/Documentation#parse5+SAXParser+stop). (GH [#47](https://github.com/inikulin/parse5/issues/47)). | ||
| * Add (**breaking**): [parse5.parse()](https://github.com/inikulin/parse5/wiki/Documentation#parse5+parse) and [parse5.parseFragment()](https://github.com/inikulin/parse5/wiki/Documentation#parse5+parseFragment) | ||
| methods as replacement for the `Parser` class. | ||
| * Add (**breaking**): [parse5.serialize()](https://github.com/inikulin/parse5/wiki/Documentation#parse5+serialized) method as replacement for the `Serializer` class. | ||
| * Updated: parsing algorithm was updated with the latest [HTML spec](https://html.spec.whatwg.org/) changes. | ||
| * Removed (**breaking**): `decodeHtmlEntities` and `encodeHtmlEntities` options. (GH [#75](https://github.com/inikulin/parse5/issues/75)). | ||
| * Add (**breaking**): [TreeAdapter.setTemplateContent()](https://github.com/inikulin/parse5/wiki/Documentation#TreeAdapter.setTemplateContent) and [TreeAdapter.getTemplateContent()](https://github.com/inikulin/parse5/wiki/Documentation#TreeAdapter.getTemplateContent) methods. (GH [#78](https://github.com/inikulin/parse5/issues/78)). | ||
| * Update (**breaking**): `default` tree adapter now stores `<template>` content in `template.content` property instead of `template.childNodes[0]`. | ||
|
|
||
| ## 1.5.1 | ||
| * Fixed: Qualified tag name emission in Serializer (GH [#79](https://github.com/inikulin/parse5/issues/79)). | ||
|
|
||
| ## 1.5.0 | ||
| * Added: Location info for the element start and end tags (by [@sakagg](https://github.com/sakagg)). | ||
|
|
||
| ## 1.4.2 | ||
| * Fixed: htmlparser2 tree adapter `DocumentType.data` property rendering (GH [#45](https://github.com/inikulin/parse5/issues/45)). | ||
|
|
||
| ## 1.4.1 | ||
| * Fixed: Location info handling for the implicitly generated `<html>` and `<body>` elements (GH [#44](https://github.com/inikulin/parse5/issues/44)). | ||
|
|
||
| ## 1.4.0 | ||
| * Added: Parser [decodeHtmlEntities](https://github.com/inikulin/parse5#optionsdecodehtmlentities) option. | ||
| * Added: SimpleApiParser [decodeHtmlEntities](https://github.com/inikulin/parse5#optionsdecodehtmlentities-1) option. | ||
| * Added: Parser [locationInfo](https://github.com/inikulin/parse5#optionslocationinfo) option. | ||
| * Added: SimpleApiParser [locationInfo](https://github.com/inikulin/parse5#optionslocationinfo-1) option. | ||
|
|
||
| ## 1.3.2 | ||
| * Fixed: `<form>` processing in `<template>` (GH [#40](https://github.com/inikulin/parse5/issues/40)). | ||
|
|
||
| ## 1.3.1 | ||
| * Fixed: text node in `<template>` serialization problem with custom tree adapter (GH [#38](https://github.com/inikulin/parse5/issues/38)). | ||
|
|
||
| ## 1.3.0 | ||
| * Added: Serializer `encodeHtmlEntities` option. | ||
|
|
||
| ## 1.2.0 | ||
| * Added: `<template>` support | ||
| * `parseFragment` now uses `<template>` as default `contextElement`. This leads to the more "forgiving" parsing manner. | ||
| * `TreeSerializer` was renamed to `Serializer`. However, serializer is accessible as `parse5.TreeSerializer` for backward compatibility . | ||
|
|
||
| ## 1.1.6 | ||
| * Fixed: apply latest changes to the `htmlparser2` tree format (DOM Level1 node emulation). | ||
|
|
||
| ## 1.1.5 | ||
| * Added: [jsdom](https://github.com/tmpvar/jsdom)-specific parser with scripting support. Undocumented for `jsdom` internal use only. | ||
|
|
||
| ## 1.1.4 | ||
| * Added: logo | ||
| * Fixed: use fake `document` element for fragment parsing (required by [jsdom](https://github.com/tmpvar/jsdom)). | ||
|
|
||
| ## 1.1.3 | ||
| * Development files (e.g. `.travis.yml`, `.editorconfig`) are removed from NPM package. | ||
|
|
||
| ## 1.1.2 | ||
| * Fixed: crash on Linux due to upper-case leading character in module name used in `require()`. | ||
|
|
||
| ## 1.1.1 | ||
| * Added: [SimpleApiParser](https://github.com/inikulin/parse5/#class-simpleapiparser). | ||
| * Fixed: new line serialization in `<pre>`. | ||
| * Fixed: `SYSTEM`-only `DOCTYPE` serialization. | ||
| * Fixed: quotes serialization in `DOCTYPE` IDs. | ||
|
|
||
| ## 1.0.0 | ||
| * First stable release, switch to semantic versioning. | ||
|
|
||
| ## 0.8.3 | ||
| * Fixed: siblings calculation bug in `appendChild` in `htmlparser2` tree adapter. | ||
|
|
||
| ## 0.8.1 | ||
| * Added: [TreeSerializer](https://github.com/inikulin/parse5/#class-serializer). | ||
| * Added: [htmlparser2 tree adapter](https://github.com/inikulin/parse5/#-treeadaptershtmlparser2). | ||
|
|
||
| ## 0.6.1 | ||
| * Fixed: incorrect `<menuitem>` handling in `<body>`. | ||
|
|
||
| ## 0.6.0 | ||
| * Initial release. | ||
| See [GitHub Releases](https://github.com/inikulin/parse5/releases) for the changelog. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters