parse5

What's Changed

• Expose element creation context to tree adapters

• Treat numeric character reference CR as whitespace

• parser: Match only HTML elements in the "any other end tag" step

• Export InsertionMode enum from parse5

• Allow flushing buffered character tokens

• tokenizer: Append attribute values and character runs as slices of the input

• End attribute names when missing whitespace

What's Changed

• tokenizer: Use String.fromCharCode for BMP characters

• Use Uint8Array bitmaps for faster tag ID lookups

• Revert "perf: use Uint8Array bitmaps for faster tag ID lookups"

What's Changed

• Switch to ESM-only

• Bump to 8.0.0

What's Changed

• Bump dependencies

  • Upgrade entities

• Fix broken links to documentation

• Account for undefined in element stack

What's Changed

• Bump dependencies

• Export tree adapter types as namespace to support TS4.x

What's Changed

• Bump dependencies

• parser: Support search element

• parse5: Change parser/tokenizer methods to be protected

• Don't generate sourcemap on build, close #831

• Fix <noframes> parsing

• Use typedoc config to avoid accidental inheritance

This release includes parse5 and parse5-parser-stream.

• Export ERR as ErrorCodes

• Properly handle CR when peeking

• Add CJS build of parser-stream

This release is only for the parse5 module.

What's Changed

• parse5: Use string types for node names

• parser: Have </button> close <p>

• Added coverage reporting

• Improved code coverage

Welcome to parse5@7.0.0! ✨ This is a huge release with many changes, features and fixes.

From an organisational perspective, the most important change is that parse5 is now maintained by a team, consisting of James (@43081j), Titus (@wooorm) and me (@fb55). We come from three projects that rely on parse5 — namely Cheerio, rehype, and Lit.

We need your support to continue the project! If you care about parse5, please support us financially on OpenCollective.

Headlining features of this release are ES Modules, TypeScript, and performance improvements: 7.0.0 is 45% faster than 6.0.1 with default options, and 167% faster with location information enabled (for the bench/perf benchmark, on an M1 Mac). Version 7.0.0 is a revamp of every part of the library. There are too many changes to list them all here, so here is a high-level overview:

Breaking: ESM

All of parse5’s packages are now ECMAScript Modules. We are providing dual packages for parse5 and parse5-htmlparser2-tree-adapter for now (see #418 and #496).

To migrate, please read this Gist on how to update. Note that private internals are no longer available; instead, everything that you need should be imported from the main package.

Implemented by @43081j in #351

Breaking: TypeScript

The codebase has been ported to TypeScript. This helped uncover a number of subtle logic bugs, such as dc4e269, b4b5d4a, or a0aff95. TypeScript also helps us refactor with confidence and a lot of the changes in this release would have been much harder to do without it.

To migrate, please remove @types/parse5* as we now ship our own types.

Implemented by @fb55 in #362

Potentially breaking changes

• breaking

  parse5 was caught up with the HTML spec, and parsing results might differ in edge-cases (#442, #451)

• breaking

  The parse5-serializer-stream package was removed #481

  • To migrate, use the serialize function exported by parse5.

• breaking

  The rewriting stream now splits very long text sections (#434) and doesn’t escape text in special tags anymore (#434). If you worked around these issues before, you might have to update your code.

• breaking

  The htmlparser2 adapter now uses domhandler’s node interface (#327

  • The format of the tree nodes has changed slightly; eg. some previous properties are now getters and setters, and vice versa.

If you are using deep imports for any parts of the codebase, you will likely encounter some breakages:

Show internal changes

• breaking

  The tokenizer now uses the state machine pattern from htmlparser2 5d7a780 (#362)

• breaking

  The token queue was replaced with callbacks (#404, #405, #419)

• breaking

  The OpenElementStack now uses callbacks #429

• breaking

  Mixins were removed (as part of #362)

  • Location tracking now has a substantially lower overhead #402

• breaking

  getNextToken was removed #461

• breaking

  The parser’s _bootstrap method was removed #384

• breaking

  We now drop chunks from the tokenizer right after they are emitted #432

• breaking

  The serializer is no longer a class; instead, different serializer functions call on each other #383

• breaking

  parse5 now uses the entities module for encoding and decoding entities, sharing maintenance & optimisation work with projects such as htmlparser2 (2b92054 (#362), #486)

  • entities adopted a variant of parse5’s approach of decoding entities. As a result, decoding performance is equivalent, while memory consumption is slightly lower.

Other changes

• minor add hooks for stack events to tree adapter interface #385

• minor add support for fragments in parse5-parser-stream #487

• minor add serializeOuter (like .outerHTML), scriptingEnabled option #383

• patch fix parsing of << in comments parsed wrongly as <!

• patch fix position of endTag for mixed-case foreign elements

• patch fix end position of html, body

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 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 and getNodeSourceCodeLocation methods. Location info property name added by currently implemented tree adapters has been renamed from __location to sourceCodeLocation (GH #189).

• Updated (breaking): Location info line and col properties have been renamed to startLine and
  startCol
  respectively.

• Updated (breaking): SAXParser now passes token objects to event handlers instead of separate arguments. See SAXParser documentation for more info.
  (GH #247).

• Added: endLine and endCol location info
  properties.

• Added: scriptingEnabled flag to the ParserOptions which controls how <noscript> tags are handled by the parser. (GH #192).

• Added: HTML rewriting stream.
  (GH #222).

• Removed (breaking): parse5 no longer ship TypeScript definitions. Existing TypeScript definitions have been moved to DefinitelyTyped repo. Please, track the PR in the DefinitelyTyped repo for the updates.

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 #235 for the details).

• Updated (breaking): TypeScript were disabled by default. See 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).

• Added: parse5 now ships with TypeScript definitions from which new documentation website is generated (GH #125).

• Added: PlainTextConversionStream (GH #135).

• Updated: Significantly reduced initial memory consumption (GH #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).

• Updated (breaking): AST collections (e.g. attributes dictionary) don't have prototype anymore (GH #119).

• Updated (breaking): Doctype now always serialized as <!DOCTYPE html> as per spec (GH #137).

• Fixed: Incorrect line for __location.endTag when the start tag contains newlines (GH #166)

• Added: ParserStream with the scripting support. (GH #26).

• Added: SerializerStream. (GH #26).

• Added: Line/column location info. (GH #67).

• Update (breaking): Location info properties start and end were renamed to startOffset and endOffset respectively.

• Update (breaking): SimpleApiParser was renamed to SAXParser.

• Update (breaking): SAXParser is the transform stream now. (GH #26).

• Update (breaking): SAXParser handler subscription is done via events now.

• Added: SAXParser.stop(). (GH #47).

• Add (breaking): parse5.parse() and parse5.parseFragment() methods as replacement for the Parser class.

• Add (breaking): parse5.serialize() method as replacement for the Serializer class.

• Updated: Parsing algorithm was updated with the latest HTML spec changes.

• removed

  Removed (breaking): decodeHtmlEntities and encodeHtmlEntities options. (GH #75).

• Add (breaking): TreeAdapter.setTemplateContent() and TreeAdapter.getTemplateContent() methods. (GH #78).

• Update (breaking): default tree adapter now stores <template> content in template.content property instead of template.childNodes[0].

• Added: Parser decodeHtmlEntities option.

• Added: SimpleApiParser decodeHtmlEntities option.

• Added: Parser locationInfo option.

• Added: SimpleApiParser locationInfo option.

• Added: Serializer encodeHtmlEntities option.

From 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 .

• Added: SimpleApiParser.

• Fixed: new line serialization in <pre>.

• Fixed: SYSTEM-only DOCTYPE serialization.

• Fixed: quotes serialization in DOCTYPE IDs.