This package is a unified (rehype) plugin that defines how to take HTML
as input and turn it into a syntax tree.
When it’s used, HTML can be parsed and other rehype plugins can be used after
it.
This plugin adds support to unified for parsing HTML.
If you also need to serialize HTML, you can alternatively use
rehype, which combines unified, this plugin, and
rehype-stringify.
When you are in a browser, trust your content, don’t need positional info, and
value a smaller bundle size, you can use rehype-dom-parse
instead.
If you don’t use plugins and want to access the syntax tree, you can directly
use hast-util-from-html, which is used inside this
plugin.
rehype focusses on making it easier to transform content by abstracting such
internals away.
Install
This package is ESM only.
In Node.js (version 16+), install with npm:
2
— turn the parse error into an actual error: processing stops
Type
type ErrorSeverity = boolean | 0 | 1 | 2
Options
Configuration (TypeScript type).
👉 Note: this is not an XML parser.
It supports SVG as embedded in HTML.
It does not support the features available in XML.
Passing SVG files might break but fragments of modern SVG should be fine.
Use xast-util-from-xml to parse XML.
Fields
fragment (boolean, default: false)
— whether to parse as a fragment; by default unopened html, head, and
body elements are opened
emitParseErrors (boolean, default: false)
— whether to emit parse errors while parsing
space ('html' or 'svg', default: 'html')
— which space the document is in
verbose (boolean, default: false)
— add extra positional info about attributes, start tags, and end tags
👉 Note: observe that the line ending before <html> is ignored, the line
ending and two spaces before <head> is moved inside it, and the line ending
after </body> is moved before it.
This behavior is described by the HTML standard (see the section 13.2.6.4.1
“The ‘initial’ insertion mode” and adjacent states) which rehype follows.
The changes to this meaningless whitespace should not matter, except when
formatting markup, in which case rehype-format can be used to
improve the source code.
Example: parse errors
The following example shows how HTML parse errors can be enabled and configured:
import rehypeParse from 'rehype-parse'import rehypeStringify from 'rehype-stringify'import {unified} from 'unified'import {reporter} from 'vfile-reporter'const file = await unified() .use(rehypeParse, { emitParseErrors: true, // Emit all. missingWhitespaceBeforeDoctypeName: 2, // Mark one as a fatal error. nonVoidHtmlElementStartTagWithTrailingSolidus: false // Ignore one. }) .use(rehypeStringify).process(`<!doctypehtml><title class="a" class="b">Hello…</title><h1/>World!</h1>`)console.log(reporter(file))
🧑🏫 Info: messages in unified are warnings instead of errors.
Other linters (such as ESLint) almost always use errors.
Why?
Those tools only check code style.
They don’t generate, transform, and format code, which is what rehype and
unified focus on, too.
Errors in unified mean the same as an exception in your JavaScript code: a
crash.
That’s why we use warnings instead, because we continue checking more HTML and
continue running more plugins.
Syntax
HTML is parsed according to WHATWG HTML (the living standard), which is also
followed by all browsers.
Projects maintained by the unified collective are compatible with maintained
versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line, rehype-parse@^9,
compatible with Node.js 16.
Security
As rehype works on HTML and improper use of HTML can open you up to a
cross-site scripting (XSS) attack, use of rehype can also be unsafe.
Use rehype-sanitize to make the tree safe.
Use of rehype plugins could also open you up to other attacks.
Carefully assess each plugin and the risks involved in using them.
For info on how to submit a report, see our security policy.