Refactor routing in App component to enhance navigation and improve error handling by integrating dynamic routes and updating the NotFound route.
This commit is contained in:
4
node_modules/hast-util-from-html/index.d.ts
generated
vendored
Normal file
4
node_modules/hast-util-from-html/index.d.ts
generated
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
// eslint-disable-next-line @typescript-eslint/triple-slash-reference -- needed to register data.
|
||||
/// <reference types="hast-util-from-parse5" />
|
||||
export {fromHtml} from './lib/index.js'
|
||||
export type {ErrorCode, ErrorSeverity, OnError, Options} from './lib/types.js'
|
2
node_modules/hast-util-from-html/index.js
generated
vendored
Normal file
2
node_modules/hast-util-from-html/index.js
generated
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
// Note: types exposed from `index.d.ts`.
|
||||
export {fromHtml} from './lib/index.js'
|
80
node_modules/hast-util-from-html/lib/errors.d.ts
generated
vendored
Normal file
80
node_modules/hast-util-from-html/lib/errors.d.ts
generated
vendored
Normal file
@@ -0,0 +1,80 @@
|
||||
export namespace errors {
|
||||
let abandonedHeadElementChild: ErrorInfo;
|
||||
let abruptClosingOfEmptyComment: ErrorInfo;
|
||||
let abruptDoctypePublicIdentifier: ErrorInfo;
|
||||
let abruptDoctypeSystemIdentifier: ErrorInfo;
|
||||
let absenceOfDigitsInNumericCharacterReference: ErrorInfo;
|
||||
let cdataInHtmlContent: ErrorInfo;
|
||||
let characterReferenceOutsideUnicodeRange: ErrorInfo;
|
||||
let closingOfElementWithOpenChildElements: ErrorInfo;
|
||||
let controlCharacterInInputStream: ErrorInfo;
|
||||
let controlCharacterReference: ErrorInfo;
|
||||
let disallowedContentInNoscriptInHead: ErrorInfo;
|
||||
let duplicateAttribute: ErrorInfo;
|
||||
let endTagWithAttributes: ErrorInfo;
|
||||
let endTagWithTrailingSolidus: ErrorInfo;
|
||||
let endTagWithoutMatchingOpenElement: ErrorInfo;
|
||||
let eofBeforeTagName: ErrorInfo;
|
||||
let eofInCdata: ErrorInfo;
|
||||
let eofInComment: ErrorInfo;
|
||||
let eofInDoctype: ErrorInfo;
|
||||
let eofInElementThatCanContainOnlyText: ErrorInfo;
|
||||
let eofInScriptHtmlCommentLikeText: ErrorInfo;
|
||||
let eofInTag: ErrorInfo;
|
||||
let incorrectlyClosedComment: ErrorInfo;
|
||||
let incorrectlyOpenedComment: ErrorInfo;
|
||||
let invalidCharacterSequenceAfterDoctypeName: ErrorInfo;
|
||||
let invalidFirstCharacterOfTagName: ErrorInfo;
|
||||
let misplacedDoctype: ErrorInfo;
|
||||
let misplacedStartTagForHeadElement: ErrorInfo;
|
||||
let missingAttributeValue: ErrorInfo;
|
||||
let missingDoctype: ErrorInfo;
|
||||
let missingDoctypeName: ErrorInfo;
|
||||
let missingDoctypePublicIdentifier: ErrorInfo;
|
||||
let missingDoctypeSystemIdentifier: ErrorInfo;
|
||||
let missingEndTagName: ErrorInfo;
|
||||
let missingQuoteBeforeDoctypePublicIdentifier: ErrorInfo;
|
||||
let missingQuoteBeforeDoctypeSystemIdentifier: ErrorInfo;
|
||||
let missingSemicolonAfterCharacterReference: ErrorInfo;
|
||||
let missingWhitespaceAfterDoctypePublicKeyword: ErrorInfo;
|
||||
let missingWhitespaceAfterDoctypeSystemKeyword: ErrorInfo;
|
||||
let missingWhitespaceBeforeDoctypeName: ErrorInfo;
|
||||
let missingWhitespaceBetweenAttributes: ErrorInfo;
|
||||
let missingWhitespaceBetweenDoctypePublicAndSystemIdentifiers: ErrorInfo;
|
||||
let nestedComment: ErrorInfo;
|
||||
let nestedNoscriptInHead: ErrorInfo;
|
||||
let nonConformingDoctype: ErrorInfo;
|
||||
let nonVoidHtmlElementStartTagWithTrailingSolidus: ErrorInfo;
|
||||
let noncharacterCharacterReference: ErrorInfo;
|
||||
let noncharacterInInputStream: ErrorInfo;
|
||||
let nullCharacterReference: ErrorInfo;
|
||||
let openElementsLeftAfterEof: ErrorInfo;
|
||||
let surrogateCharacterReference: ErrorInfo;
|
||||
let surrogateInInputStream: ErrorInfo;
|
||||
let unexpectedCharacterAfterDoctypeSystemIdentifier: ErrorInfo;
|
||||
let unexpectedCharacterInAttributeName: ErrorInfo;
|
||||
let unexpectedCharacterInUnquotedAttributeValue: ErrorInfo;
|
||||
let unexpectedEqualsSignBeforeAttributeName: ErrorInfo;
|
||||
let unexpectedNullCharacter: ErrorInfo;
|
||||
let unexpectedQuestionMarkInsteadOfTagName: ErrorInfo;
|
||||
let unexpectedSolidusInTag: ErrorInfo;
|
||||
let unknownNamedCharacterReference: ErrorInfo;
|
||||
}
|
||||
/**
|
||||
* Info on a `parse5` error.
|
||||
*/
|
||||
export type ErrorInfo = {
|
||||
/**
|
||||
* Reason of error.
|
||||
*/
|
||||
reason: string;
|
||||
/**
|
||||
* More info on error.
|
||||
*/
|
||||
description: string;
|
||||
/**
|
||||
* Turn off if this is not documented in the html5 spec (optional).
|
||||
*/
|
||||
url?: false;
|
||||
};
|
||||
//# sourceMappingURL=errors.d.ts.map
|
1
node_modules/hast-util-from-html/lib/errors.d.ts.map
generated
vendored
Normal file
1
node_modules/hast-util-from-html/lib/errors.d.ts.map
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["errors.js"],"names":[],"mappings":";mCAYa,SAAS;qCAOT,SAAS;uCAKT,SAAS;uCAMT,SAAS;oDAMT,SAAS;4BAMT,SAAS;+CAMT,SAAS;+CAMT,SAAS;uCAOT,SAAS;mCAMT,SAAS;2CAMT,SAAS;4BAOT,SAAS;8BAMT,SAAS;mCAKT,SAAS;0CAKT,SAAS;0BAMT,SAAS;oBAKT,SAAS;sBAKT,SAAS;sBAKT,SAAS;4CAMT,SAAS;wCAMT,SAAS;kBAKT,SAAS;kCAKT,SAAS;kCAKT,SAAS;kDAKT,SAAS;wCAKT,SAAS;0BAKT,SAAS;yCAMT,SAAS;+BAOT,SAAS;wBAMT,SAAS;4BAMT,SAAS;wCAKT,SAAS;wCAKT,SAAS;2BAMT,SAAS;mDAKT,SAAS;mDAKT,SAAS;iDAKT,SAAS;oDAKT,SAAS;oDAKT,SAAS;4CAKT,SAAS;4CAKT,SAAS;mEAKT,SAAS;uBAMT,SAAS;8BAKT,SAAS;8BAOT,SAAS;uDAOT,SAAS;wCAKT,SAAS;mCAMT,SAAS;gCAKT,SAAS;kCAKT,SAAS;qCAMT,SAAS;gCAMT,SAAS;yDAMT,SAAS;4CAKT,SAAS;qDAMT,SAAS;iDAKT,SAAS;iCAKT,SAAS;gDAMT,SAAS;gCAKT,SAAS;wCAMT,SAAS;;;;;;;;;YAnVR,MAAM;;;;iBAEN,MAAM;;;;UAEN,KAAK"}
|
349
node_modules/hast-util-from-html/lib/errors.js
generated
vendored
Normal file
349
node_modules/hast-util-from-html/lib/errors.js
generated
vendored
Normal file
@@ -0,0 +1,349 @@
|
||||
/**
|
||||
* @typedef ErrorInfo
|
||||
* Info on a `parse5` error.
|
||||
* @property {string} reason
|
||||
* Reason of error.
|
||||
* @property {string} description
|
||||
* More info on error.
|
||||
* @property {false} [url]
|
||||
* Turn off if this is not documented in the html5 spec (optional).
|
||||
*/
|
||||
|
||||
export const errors = {
|
||||
/** @type {ErrorInfo} */
|
||||
abandonedHeadElementChild: {
|
||||
reason: 'Unexpected metadata element after head',
|
||||
description:
|
||||
'Unexpected element after head. Expected the element before `</head>`',
|
||||
url: false
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
abruptClosingOfEmptyComment: {
|
||||
reason: 'Unexpected abruptly closed empty comment',
|
||||
description: 'Unexpected `>` or `->`. Expected `-->` to close comments'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
abruptDoctypePublicIdentifier: {
|
||||
reason: 'Unexpected abruptly closed public identifier',
|
||||
description:
|
||||
'Unexpected `>`. Expected a closing `"` or `\'` after the public identifier'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
abruptDoctypeSystemIdentifier: {
|
||||
reason: 'Unexpected abruptly closed system identifier',
|
||||
description:
|
||||
'Unexpected `>`. Expected a closing `"` or `\'` after the identifier identifier'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
absenceOfDigitsInNumericCharacterReference: {
|
||||
reason: 'Unexpected non-digit at start of numeric character reference',
|
||||
description:
|
||||
'Unexpected `%c`. Expected `[0-9]` for decimal references or `[0-9a-fA-F]` for hexadecimal references'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
cdataInHtmlContent: {
|
||||
reason: 'Unexpected CDATA section in HTML',
|
||||
description:
|
||||
'Unexpected `<![CDATA[` in HTML. Remove it, use a comment, or encode special characters instead'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
characterReferenceOutsideUnicodeRange: {
|
||||
reason: 'Unexpected too big numeric character reference',
|
||||
description:
|
||||
'Unexpectedly high character reference. Expected character references to be at most hexadecimal 10ffff (or decimal 1114111)'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
closingOfElementWithOpenChildElements: {
|
||||
reason: 'Unexpected closing tag with open child elements',
|
||||
description:
|
||||
'Unexpectedly closing tag. Expected other tags to be closed first',
|
||||
url: false
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
controlCharacterInInputStream: {
|
||||
reason: 'Unexpected control character',
|
||||
description:
|
||||
'Unexpected control character `%x`. Expected a non-control code point, 0x00, or ASCII whitespace'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
controlCharacterReference: {
|
||||
reason: 'Unexpected control character reference',
|
||||
description:
|
||||
'Unexpectedly control character in reference. Expected a non-control code point, 0x00, or ASCII whitespace'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
disallowedContentInNoscriptInHead: {
|
||||
reason: 'Disallowed content inside `<noscript>` in `<head>`',
|
||||
description:
|
||||
'Unexpected text character `%c`. Only use text in `<noscript>`s in `<body>`',
|
||||
url: false
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
duplicateAttribute: {
|
||||
reason: 'Unexpected duplicate attribute',
|
||||
description:
|
||||
'Unexpectedly double attribute. Expected attributes to occur only once'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
endTagWithAttributes: {
|
||||
reason: 'Unexpected attribute on closing tag',
|
||||
description: 'Unexpected attribute. Expected `>` instead'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
endTagWithTrailingSolidus: {
|
||||
reason: 'Unexpected slash at end of closing tag',
|
||||
description: 'Unexpected `%c-1`. Expected `>` instead'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
endTagWithoutMatchingOpenElement: {
|
||||
reason: 'Unexpected unopened end tag',
|
||||
description: 'Unexpected end tag. Expected no end tag or another end tag',
|
||||
url: false
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
eofBeforeTagName: {
|
||||
reason: 'Unexpected end of file',
|
||||
description: 'Unexpected end of file. Expected tag name instead'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
eofInCdata: {
|
||||
reason: 'Unexpected end of file in CDATA',
|
||||
description: 'Unexpected end of file. Expected `]]>` to close the CDATA'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
eofInComment: {
|
||||
reason: 'Unexpected end of file in comment',
|
||||
description: 'Unexpected end of file. Expected `-->` to close the comment'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
eofInDoctype: {
|
||||
reason: 'Unexpected end of file in doctype',
|
||||
description:
|
||||
'Unexpected end of file. Expected a valid doctype (such as `<!doctype html>`)'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
eofInElementThatCanContainOnlyText: {
|
||||
reason: 'Unexpected end of file in element that can only contain text',
|
||||
description: 'Unexpected end of file. Expected text or a closing tag',
|
||||
url: false
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
eofInScriptHtmlCommentLikeText: {
|
||||
reason: 'Unexpected end of file in comment inside script',
|
||||
description: 'Unexpected end of file. Expected `-->` to close the comment'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
eofInTag: {
|
||||
reason: 'Unexpected end of file in tag',
|
||||
description: 'Unexpected end of file. Expected `>` to close the tag'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
incorrectlyClosedComment: {
|
||||
reason: 'Incorrectly closed comment',
|
||||
description: 'Unexpected `%c-1`. Expected `-->` to close the comment'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
incorrectlyOpenedComment: {
|
||||
reason: 'Incorrectly opened comment',
|
||||
description: 'Unexpected `%c`. Expected `<!--` to open the comment'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
invalidCharacterSequenceAfterDoctypeName: {
|
||||
reason: 'Invalid sequence after doctype name',
|
||||
description: 'Unexpected sequence at `%c`. Expected `public` or `system`'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
invalidFirstCharacterOfTagName: {
|
||||
reason: 'Invalid first character in tag name',
|
||||
description: 'Unexpected `%c`. Expected an ASCII letter instead'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
misplacedDoctype: {
|
||||
reason: 'Misplaced doctype',
|
||||
description: 'Unexpected doctype. Expected doctype before head',
|
||||
url: false
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
misplacedStartTagForHeadElement: {
|
||||
reason: 'Misplaced `<head>` start tag',
|
||||
description:
|
||||
'Unexpected start tag `<head>`. Expected `<head>` directly after doctype',
|
||||
url: false
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
missingAttributeValue: {
|
||||
reason: 'Missing attribute value',
|
||||
description:
|
||||
'Unexpected `%c-1`. Expected an attribute value or no `%c-1` instead'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
missingDoctype: {
|
||||
reason: 'Missing doctype before other content',
|
||||
description: 'Expected a `<!doctype html>` before anything else',
|
||||
url: false
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
missingDoctypeName: {
|
||||
reason: 'Missing doctype name',
|
||||
description: 'Unexpected doctype end at `%c`. Expected `html` instead'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
missingDoctypePublicIdentifier: {
|
||||
reason: 'Missing public identifier in doctype',
|
||||
description: 'Unexpected `%c`. Expected identifier for `public` instead'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
missingDoctypeSystemIdentifier: {
|
||||
reason: 'Missing system identifier in doctype',
|
||||
description:
|
||||
'Unexpected `%c`. Expected identifier for `system` instead (suggested: `"about:legacy-compat"`)'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
missingEndTagName: {
|
||||
reason: 'Missing name in end tag',
|
||||
description: 'Unexpected `%c`. Expected an ASCII letter instead'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
missingQuoteBeforeDoctypePublicIdentifier: {
|
||||
reason: 'Missing quote before public identifier in doctype',
|
||||
description: 'Unexpected `%c`. Expected `"` or `\'` instead'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
missingQuoteBeforeDoctypeSystemIdentifier: {
|
||||
reason: 'Missing quote before system identifier in doctype',
|
||||
description: 'Unexpected `%c`. Expected `"` or `\'` instead'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
missingSemicolonAfterCharacterReference: {
|
||||
reason: 'Missing semicolon after character reference',
|
||||
description: 'Unexpected `%c`. Expected `;` instead'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
missingWhitespaceAfterDoctypePublicKeyword: {
|
||||
reason: 'Missing whitespace after public identifier in doctype',
|
||||
description: 'Unexpected `%c`. Expected ASCII whitespace instead'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
missingWhitespaceAfterDoctypeSystemKeyword: {
|
||||
reason: 'Missing whitespace after system identifier in doctype',
|
||||
description: 'Unexpected `%c`. Expected ASCII whitespace instead'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
missingWhitespaceBeforeDoctypeName: {
|
||||
reason: 'Missing whitespace before doctype name',
|
||||
description: 'Unexpected `%c`. Expected ASCII whitespace instead'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
missingWhitespaceBetweenAttributes: {
|
||||
reason: 'Missing whitespace between attributes',
|
||||
description: 'Unexpected `%c`. Expected ASCII whitespace instead'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
missingWhitespaceBetweenDoctypePublicAndSystemIdentifiers: {
|
||||
reason:
|
||||
'Missing whitespace between public and system identifiers in doctype',
|
||||
description: 'Unexpected `%c`. Expected ASCII whitespace instead'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
nestedComment: {
|
||||
reason: 'Unexpected nested comment',
|
||||
description: 'Unexpected `<!--`. Expected `-->`'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
nestedNoscriptInHead: {
|
||||
reason: 'Unexpected nested `<noscript>` in `<head>`',
|
||||
description:
|
||||
'Unexpected `<noscript>`. Expected a closing tag or a meta element',
|
||||
url: false
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
nonConformingDoctype: {
|
||||
reason: 'Unexpected non-conforming doctype declaration',
|
||||
description:
|
||||
'Expected `<!doctype html>` or `<!doctype html system "about:legacy-compat">`',
|
||||
url: false
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
nonVoidHtmlElementStartTagWithTrailingSolidus: {
|
||||
reason: 'Unexpected trailing slash on start tag of non-void element',
|
||||
description: 'Unexpected `/`. Expected `>` instead'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
noncharacterCharacterReference: {
|
||||
reason:
|
||||
'Unexpected noncharacter code point referenced by character reference',
|
||||
description: 'Unexpected code point. Do not use noncharacters in HTML'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
noncharacterInInputStream: {
|
||||
reason: 'Unexpected noncharacter character',
|
||||
description: 'Unexpected code point `%x`. Do not use noncharacters in HTML'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
nullCharacterReference: {
|
||||
reason: 'Unexpected NULL character referenced by character reference',
|
||||
description: 'Unexpected code point. Do not use NULL characters in HTML'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
openElementsLeftAfterEof: {
|
||||
reason: 'Unexpected end of file',
|
||||
description: 'Unexpected end of file. Expected closing tag instead',
|
||||
url: false
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
surrogateCharacterReference: {
|
||||
reason: 'Unexpected surrogate character referenced by character reference',
|
||||
description:
|
||||
'Unexpected code point. Do not use lone surrogate characters in HTML'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
surrogateInInputStream: {
|
||||
reason: 'Unexpected surrogate character',
|
||||
description:
|
||||
'Unexpected code point `%x`. Do not use lone surrogate characters in HTML'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
unexpectedCharacterAfterDoctypeSystemIdentifier: {
|
||||
reason: 'Invalid character after system identifier in doctype',
|
||||
description: 'Unexpected character at `%c`. Expected `>`'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
unexpectedCharacterInAttributeName: {
|
||||
reason: 'Unexpected character in attribute name',
|
||||
description:
|
||||
'Unexpected `%c`. Expected whitespace, `/`, `>`, `=`, or probably an ASCII letter'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
unexpectedCharacterInUnquotedAttributeValue: {
|
||||
reason: 'Unexpected character in unquoted attribute value',
|
||||
description: 'Unexpected `%c`. Quote the attribute value to include it'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
unexpectedEqualsSignBeforeAttributeName: {
|
||||
reason: 'Unexpected equals sign before attribute name',
|
||||
description: 'Unexpected `%c`. Add an attribute name before it'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
unexpectedNullCharacter: {
|
||||
reason: 'Unexpected NULL character',
|
||||
description:
|
||||
'Unexpected code point `%x`. Do not use NULL characters in HTML'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
unexpectedQuestionMarkInsteadOfTagName: {
|
||||
reason: 'Unexpected question mark instead of tag name',
|
||||
description: 'Unexpected `%c`. Expected an ASCII letter instead'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
unexpectedSolidusInTag: {
|
||||
reason: 'Unexpected slash in tag',
|
||||
description:
|
||||
'Unexpected `%c-1`. Expected it followed by `>` or in a quoted attribute value'
|
||||
},
|
||||
/** @type {ErrorInfo} */
|
||||
unknownNamedCharacterReference: {
|
||||
reason: 'Unexpected unknown named character reference',
|
||||
description:
|
||||
'Unexpected character reference. Expected known named character references'
|
||||
}
|
||||
}
|
16
node_modules/hast-util-from-html/lib/index.d.ts
generated
vendored
Normal file
16
node_modules/hast-util-from-html/lib/index.d.ts
generated
vendored
Normal file
@@ -0,0 +1,16 @@
|
||||
/**
|
||||
* Turn serialized HTML into a hast tree.
|
||||
*
|
||||
* @param {VFile | Value} value
|
||||
* Serialized HTML to parse.
|
||||
* @param {Readonly<Options> | null | undefined} [options]
|
||||
* Configuration (optional).
|
||||
* @returns {Root}
|
||||
* Tree.
|
||||
*/
|
||||
export function fromHtml(value: VFile | Value, options?: Readonly<Options> | null | undefined): Root;
|
||||
import { VFile } from 'vfile';
|
||||
import type { Value } from 'vfile';
|
||||
import type { Options } from './types.js';
|
||||
import type { Root } from 'hast';
|
||||
//# sourceMappingURL=index.d.ts.map
|
1
node_modules/hast-util-from-html/lib/index.d.ts.map
generated
vendored
Normal file
1
node_modules/hast-util-from-html/lib/index.d.ts.map
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.js"],"names":[],"mappings":"AAyBA;;;;;;;;;GASG;AACH,gCAPW,KAAK,GAAG,KAAK,YAEb,QAAQ,CAAC,OAAO,CAAC,GAAG,IAAI,GAAG,SAAS,GAElC,IAAI,CAmHhB;sBAzImB,OAAO;2BAPH,OAAO;6BACM,YAAY;0BAH1B,MAAM"}
|
189
node_modules/hast-util-from-html/lib/index.js
generated
vendored
Normal file
189
node_modules/hast-util-from-html/lib/index.js
generated
vendored
Normal file
@@ -0,0 +1,189 @@
|
||||
/**
|
||||
* @import {Root} from 'hast'
|
||||
* @import {ParserError} from 'parse5'
|
||||
* @import {Value} from 'vfile'
|
||||
* @import {ErrorCode, Options} from './types.js'
|
||||
*/
|
||||
|
||||
import {ok as assert} from 'devlop'
|
||||
import {fromParse5} from 'hast-util-from-parse5'
|
||||
import {parse, parseFragment} from 'parse5'
|
||||
import {VFile} from 'vfile'
|
||||
import {VFileMessage} from 'vfile-message'
|
||||
import {errors} from './errors.js'
|
||||
|
||||
const base = 'https://html.spec.whatwg.org/multipage/parsing.html#parse-error-'
|
||||
|
||||
const dashToCamelRe = /-[a-z]/g
|
||||
const formatCRe = /%c(?:([-+])(\d+))?/g
|
||||
const formatXRe = /%x/g
|
||||
|
||||
const fatalities = {2: true, 1: false, 0: null}
|
||||
|
||||
/** @type {Readonly<Options>} */
|
||||
const emptyOptions = {}
|
||||
|
||||
/**
|
||||
* Turn serialized HTML into a hast tree.
|
||||
*
|
||||
* @param {VFile | Value} value
|
||||
* Serialized HTML to parse.
|
||||
* @param {Readonly<Options> | null | undefined} [options]
|
||||
* Configuration (optional).
|
||||
* @returns {Root}
|
||||
* Tree.
|
||||
*/
|
||||
export function fromHtml(value, options) {
|
||||
const settings = options || emptyOptions
|
||||
const onerror = settings.onerror
|
||||
const file = value instanceof VFile ? value : new VFile(value)
|
||||
const parseFunction = settings.fragment ? parseFragment : parse
|
||||
const document = String(file)
|
||||
const p5Document = parseFunction(document, {
|
||||
sourceCodeLocationInfo: true,
|
||||
// Note `parse5` types currently do not allow `undefined`.
|
||||
onParseError: settings.onerror ? internalOnerror : null,
|
||||
scriptingEnabled: false
|
||||
})
|
||||
|
||||
// `parse5` returns document which are always mapped to roots.
|
||||
return /** @type {Root} */ (
|
||||
fromParse5(p5Document, {
|
||||
file,
|
||||
space: settings.space,
|
||||
verbose: settings.verbose
|
||||
})
|
||||
)
|
||||
|
||||
/**
|
||||
* Handle a parse error.
|
||||
*
|
||||
* @param {ParserError} error
|
||||
* Parse5 error.
|
||||
* @returns {undefined}
|
||||
* Nothing.
|
||||
*/
|
||||
function internalOnerror(error) {
|
||||
const code = error.code
|
||||
const name = camelcase(code)
|
||||
const setting = settings[name]
|
||||
const config = setting === null || setting === undefined ? true : setting
|
||||
const level = typeof config === 'number' ? config : config ? 1 : 0
|
||||
|
||||
if (level) {
|
||||
const info = errors[name]
|
||||
assert(info, 'expected known error from `parse5`')
|
||||
|
||||
const message = new VFileMessage(format(info.reason), {
|
||||
place: {
|
||||
start: {
|
||||
line: error.startLine,
|
||||
column: error.startCol,
|
||||
offset: error.startOffset
|
||||
},
|
||||
end: {
|
||||
line: error.endLine,
|
||||
column: error.endCol,
|
||||
offset: error.endOffset
|
||||
}
|
||||
},
|
||||
ruleId: code,
|
||||
source: 'hast-util-from-html'
|
||||
})
|
||||
|
||||
if (file.path) {
|
||||
message.file = file.path
|
||||
message.name = file.path + ':' + message.name
|
||||
}
|
||||
|
||||
message.fatal = fatalities[level]
|
||||
message.note = format(info.description)
|
||||
message.url = info.url === false ? undefined : base + code
|
||||
|
||||
assert(onerror, '`internalOnerror` is not passed if `onerror` is not set')
|
||||
onerror(message)
|
||||
}
|
||||
|
||||
/**
|
||||
* Format a human readable string about an error.
|
||||
*
|
||||
* @param {string} value
|
||||
* Value to format.
|
||||
* @returns {string}
|
||||
* Formatted.
|
||||
*/
|
||||
function format(value) {
|
||||
return value.replace(formatCRe, formatC).replace(formatXRe, formatX)
|
||||
|
||||
/**
|
||||
* Format the character.
|
||||
*
|
||||
* @param {string} _
|
||||
* Match.
|
||||
* @param {string} $1
|
||||
* Sign (`-` or `+`, optional).
|
||||
* @param {string} $2
|
||||
* Offset.
|
||||
* @returns {string}
|
||||
* Formatted.
|
||||
*/
|
||||
function formatC(_, $1, $2) {
|
||||
const offset =
|
||||
($2 ? Number.parseInt($2, 10) : 0) * ($1 === '-' ? -1 : 1)
|
||||
const char = document.charAt(error.startOffset + offset)
|
||||
return visualizeCharacter(char)
|
||||
}
|
||||
|
||||
/**
|
||||
* Format the character code.
|
||||
*
|
||||
* @returns {string}
|
||||
* Formatted.
|
||||
*/
|
||||
function formatX() {
|
||||
return visualizeCharacterCode(document.charCodeAt(error.startOffset))
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {string} value
|
||||
* Error code in dash case.
|
||||
* @returns {ErrorCode}
|
||||
* Error code in camelcase.
|
||||
*/
|
||||
function camelcase(value) {
|
||||
// This should match an error code.
|
||||
return /** @type {ErrorCode} */ (value.replace(dashToCamelRe, dashToCamel))
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {string} $0
|
||||
* Match.
|
||||
* @returns {string}
|
||||
* Camelcased.
|
||||
*/
|
||||
function dashToCamel($0) {
|
||||
return $0.charAt(1).toUpperCase()
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {string} char
|
||||
* Character.
|
||||
* @returns {string}
|
||||
* Formatted.
|
||||
*/
|
||||
function visualizeCharacter(char) {
|
||||
return char === '`' ? '` ` `' : char
|
||||
}
|
||||
|
||||
/**
|
||||
* @param {number} charCode
|
||||
* Character code.
|
||||
* @returns {string}
|
||||
* Formatted.
|
||||
*/
|
||||
function visualizeCharacterCode(charCode) {
|
||||
return '0x' + charCode.toString(16).toUpperCase()
|
||||
}
|
63
node_modules/hast-util-from-html/lib/types.d.ts
generated
vendored
Normal file
63
node_modules/hast-util-from-html/lib/types.d.ts
generated
vendored
Normal file
@@ -0,0 +1,63 @@
|
||||
import type {VFileMessage} from 'vfile-message'
|
||||
import type {Options as FromParse5Options} from 'hast-util-from-parse5'
|
||||
import type {errors} from './errors.js'
|
||||
|
||||
/**
|
||||
* Known names of parse errors.
|
||||
*/
|
||||
export type ErrorCode = keyof typeof errors
|
||||
|
||||
/**
|
||||
* Error severity:
|
||||
*
|
||||
* * `0` or `false`
|
||||
* — turn the parse error off
|
||||
* * `1` or `true`
|
||||
* — turn the parse error into a warning
|
||||
* * `2`
|
||||
* — turn the parse error into an actual error: processing stops.
|
||||
*/
|
||||
export type ErrorSeverity = boolean | 0 | 1 | 2
|
||||
|
||||
/**
|
||||
* Handle parse errors.
|
||||
*/
|
||||
export type OnError = (error: VFileMessage) => undefined | void
|
||||
|
||||
/**
|
||||
* Options that define the severity of errors.
|
||||
*/
|
||||
export type ErrorOptions = Partial<
|
||||
Record<ErrorCode, ErrorSeverity | null | undefined>
|
||||
>
|
||||
|
||||
/**
|
||||
* Configuration.
|
||||
*/
|
||||
export interface Options extends ErrorOptions, FromParse5Options {
|
||||
/**
|
||||
* The `file` field from `hast-util-from-parse5` is not supported.
|
||||
*/
|
||||
file?: never
|
||||
/**
|
||||
* Specify whether to parse a fragment, instead of a complete document
|
||||
* (default: `false`).
|
||||
*
|
||||
* In document mode, unopened `html`, `head`, and `body` elements are opened
|
||||
* in just the right places.
|
||||
*/
|
||||
fragment?: boolean | null | undefined
|
||||
/**
|
||||
* Call `onerror` with parse errors while parsing (optional).
|
||||
*
|
||||
* > 👉 **Note**: parse errors are currently being added to HTML.
|
||||
* > Not all errors emitted by parse5 (or us) are specced yet.
|
||||
* > Some documentation may still be missing.
|
||||
*
|
||||
* Specific rules can be turned off by setting them to `false` (or `0`).
|
||||
* The default, when `emitParseErrors: true`, is `true` (or `1`), and means
|
||||
* that rules emit as warnings.
|
||||
* Rules can also be configured with `2`, to turn them into fatal errors.
|
||||
*/
|
||||
onerror?: OnError | null | undefined
|
||||
}
|
2
node_modules/hast-util-from-html/lib/types.js
generated
vendored
Normal file
2
node_modules/hast-util-from-html/lib/types.js
generated
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
// Note: types exposed from `lib/types.d.ts`.
|
||||
export {}
|
22
node_modules/hast-util-from-html/license
generated
vendored
Normal file
22
node_modules/hast-util-from-html/license
generated
vendored
Normal file
@@ -0,0 +1,22 @@
|
||||
(The MIT License)
|
||||
|
||||
Copyright (c) 2022 Titus Wormer <tituswormer@gmail.com>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
'Software'), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
127
node_modules/hast-util-from-html/package.json
generated
vendored
Normal file
127
node_modules/hast-util-from-html/package.json
generated
vendored
Normal file
@@ -0,0 +1,127 @@
|
||||
{
|
||||
"name": "hast-util-from-html",
|
||||
"version": "2.0.3",
|
||||
"description": "hast utility to parse from HTML",
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"unist",
|
||||
"hast",
|
||||
"hast-util",
|
||||
"util",
|
||||
"utility",
|
||||
"html",
|
||||
"parse",
|
||||
"tokenize"
|
||||
],
|
||||
"repository": "syntax-tree/hast-util-from-html",
|
||||
"bugs": "https://github.com/syntax-tree/hast-util-from-html/issues",
|
||||
"funding": {
|
||||
"type": "opencollective",
|
||||
"url": "https://opencollective.com/unified"
|
||||
},
|
||||
"author": "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)",
|
||||
"contributors": [
|
||||
"Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)"
|
||||
],
|
||||
"sideEffects": false,
|
||||
"type": "module",
|
||||
"exports": "./index.js",
|
||||
"files": [
|
||||
"lib/",
|
||||
"index.d.ts",
|
||||
"index.js"
|
||||
],
|
||||
"dependencies": {
|
||||
"@types/hast": "^3.0.0",
|
||||
"devlop": "^1.1.0",
|
||||
"hast-util-from-parse5": "^8.0.0",
|
||||
"parse5": "^7.0.0",
|
||||
"vfile": "^6.0.0",
|
||||
"vfile-message": "^4.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@types/mdast": "^4.0.0",
|
||||
"@types/node": "^22.0.0",
|
||||
"c8": "^10.0.0",
|
||||
"mdast-zone": "^6.0.0",
|
||||
"prettier": "^3.0.0",
|
||||
"remark-cli": "^12.0.0",
|
||||
"remark-preset-wooorm": "^10.0.0",
|
||||
"to-vfile": "^8.0.0",
|
||||
"type-coverage": "^2.0.0",
|
||||
"type-fest": "^4.0.0",
|
||||
"typescript": "^5.0.0",
|
||||
"unist-builder": "^4.0.0",
|
||||
"xo": "^0.59.0"
|
||||
},
|
||||
"scripts": {
|
||||
"prepack": "npm run build && npm run format",
|
||||
"build": "tsc --build --clean && tsc --build && type-coverage",
|
||||
"format": "remark . -qfo && prettier . -w --log-level warn && xo --fix",
|
||||
"test-api": "node --conditions development test/index.js",
|
||||
"test-coverage": "c8 --100 --reporter lcov npm run test-api",
|
||||
"test": "npm run build && npm run format && npm run test-coverage"
|
||||
},
|
||||
"prettier": {
|
||||
"bracketSpacing": false,
|
||||
"semi": false,
|
||||
"singleQuote": true,
|
||||
"tabWidth": 2,
|
||||
"trailingComma": "none",
|
||||
"useTabs": false
|
||||
},
|
||||
"remarkConfig": {
|
||||
"plugins": [
|
||||
"preset-wooorm",
|
||||
[
|
||||
"remark-lint-no-html",
|
||||
false
|
||||
],
|
||||
"./script/parse-error.js"
|
||||
]
|
||||
},
|
||||
"typeCoverage": {
|
||||
"atLeast": 100,
|
||||
"detail": true,
|
||||
"ignoreCatch": true,
|
||||
"strict": true
|
||||
},
|
||||
"xo": {
|
||||
"overrides": [
|
||||
{
|
||||
"files": [
|
||||
"**/*.d.ts"
|
||||
],
|
||||
"rules": {
|
||||
"@typescript-eslint/array-type": [
|
||||
"error",
|
||||
{
|
||||
"default": "generic"
|
||||
}
|
||||
],
|
||||
"@typescript-eslint/ban-types": [
|
||||
"error",
|
||||
{
|
||||
"extendDefaults": true
|
||||
}
|
||||
],
|
||||
"@typescript-eslint/consistent-type-definitions": [
|
||||
"error",
|
||||
"interface"
|
||||
]
|
||||
}
|
||||
},
|
||||
{
|
||||
"files": "test/**/*.js",
|
||||
"rules": {
|
||||
"no-await-in-loop": "off"
|
||||
}
|
||||
}
|
||||
],
|
||||
"prettier": true,
|
||||
"rules": {
|
||||
"unicorn/prefer-code-point": "off",
|
||||
"unicorn/prefer-string-replace-all": "off"
|
||||
}
|
||||
}
|
||||
}
|
594
node_modules/hast-util-from-html/readme.md
generated
vendored
Normal file
594
node_modules/hast-util-from-html/readme.md
generated
vendored
Normal file
@@ -0,0 +1,594 @@
|
||||
# hast-util-from-html
|
||||
|
||||
[![Build][build-badge]][build]
|
||||
[![Coverage][coverage-badge]][coverage]
|
||||
[![Downloads][downloads-badge]][downloads]
|
||||
[![Size][size-badge]][size]
|
||||
[![Sponsors][sponsors-badge]][collective]
|
||||
[![Backers][backers-badge]][collective]
|
||||
[![Chat][chat-badge]][chat]
|
||||
|
||||
[hast][] utility that turns HTML into a syntax tree.
|
||||
|
||||
## Contents
|
||||
|
||||
* [What is this?](#what-is-this)
|
||||
* [When should I use this?](#when-should-i-use-this)
|
||||
* [Install](#install)
|
||||
* [Use](#use)
|
||||
* [API](#api)
|
||||
* [`fromHtml(value[, options])`](#fromhtmlvalue-options)
|
||||
* [`ErrorCode`](#errorcode)
|
||||
* [`ErrorSeverity`](#errorseverity)
|
||||
* [`OnError`](#onerror)
|
||||
* [`Options`](#options)
|
||||
* [Examples](#examples)
|
||||
* [Example: fragment versus document](#example-fragment-versus-document)
|
||||
* [Example: whitespace around and inside `<html>`](#example-whitespace-around-and-inside-html)
|
||||
* [Example: parse errors](#example-parse-errors)
|
||||
* [Syntax](#syntax)
|
||||
* [Types](#types-2)
|
||||
* [Compatibility](#compatibility)
|
||||
* [Security](#security)
|
||||
* [Related](#related)
|
||||
* [Contribute](#contribute)
|
||||
* [License](#license)
|
||||
|
||||
## What is this?
|
||||
|
||||
This package is a utility that takes HTML input and turns it into a hast syntax
|
||||
tree.
|
||||
|
||||
## When should I use this?
|
||||
|
||||
If you want to handle syntax trees manually, use this.
|
||||
|
||||
Use [`parse5`][parse5] instead when you just want to parse HTML and don’t care
|
||||
about [hast][].
|
||||
You can also use [`hast-util-from-parse5`][hast-util-from-parse5] and
|
||||
[`parse5`][parse5] yourself, or use the rehype plugin
|
||||
[`rehype-parse`][rehype-parse], which wraps this utility to also parse HTML at
|
||||
a higher-level (easier) abstraction.
|
||||
[`xast-util-from-xml`][xast-util-from-xml] can be used if you are dealing with
|
||||
XML instead of HTML.
|
||||
|
||||
If you might run in a browser and prefer a ligher alternative, while not caring
|
||||
about positional info, parse errors, and consistency across browsers, use
|
||||
[`hast-util-from-html-isomorphic`][hast-util-from-html-isomorphic], which
|
||||
wraps this in Node and uses browser APIs otherwise.
|
||||
|
||||
Finally you can use the utility [`hast-util-to-html`][hast-util-to-html] for
|
||||
the inverse of this utility.
|
||||
It turns hast into HTML.
|
||||
|
||||
## Install
|
||||
|
||||
This package is [ESM only][esm].
|
||||
In Node.js (version 16+), install with [npm][]:
|
||||
|
||||
```sh
|
||||
npm install hast-util-from-html
|
||||
```
|
||||
|
||||
In Deno with [`esm.sh`][esmsh]:
|
||||
|
||||
```js
|
||||
import {fromHtml} from 'https://esm.sh/hast-util-from-html@2'
|
||||
```
|
||||
|
||||
In browsers with [`esm.sh`][esmsh]:
|
||||
|
||||
```html
|
||||
<script type="module">
|
||||
import {fromHtml} from 'https://esm.sh/hast-util-from-html@2?bundle'
|
||||
</script>
|
||||
```
|
||||
|
||||
## Use
|
||||
|
||||
```js
|
||||
import {fromHtml} from 'hast-util-from-html'
|
||||
|
||||
const tree = fromHtml('<h1>Hello, world!</h1>', {fragment: true})
|
||||
|
||||
console.log(tree)
|
||||
```
|
||||
|
||||
Yields:
|
||||
|
||||
```js
|
||||
{
|
||||
type: 'root',
|
||||
children: [
|
||||
{
|
||||
type: 'element',
|
||||
tagName: 'h1',
|
||||
properties: {},
|
||||
children: [Array],
|
||||
position: [Object]
|
||||
}
|
||||
],
|
||||
data: { quirksMode: false },
|
||||
position: {
|
||||
start: { line: 1, column: 1, offset: 0 },
|
||||
end: { line: 1, column: 23, offset: 22 }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
This package exports the identifier [`fromHtml`][api-from-html].
|
||||
There is no default export.
|
||||
|
||||
### `fromHtml(value[, options])`
|
||||
|
||||
Turn serialized HTML into a hast tree.
|
||||
|
||||
###### Parameters
|
||||
|
||||
* `value` ([`Compatible`][compatible])
|
||||
— serialized HTML to parse
|
||||
* `options` ([`Options`][api-options], optional)
|
||||
— configuration
|
||||
|
||||
###### Returns
|
||||
|
||||
Tree ([`Root`][root]).
|
||||
|
||||
### `ErrorCode`
|
||||
|
||||
Known names of parse errors (TypeScript type).
|
||||
|
||||
###### Types
|
||||
|
||||
```ts
|
||||
type ErrorCode =
|
||||
| 'abandonedHeadElementChild'
|
||||
| 'abruptClosingOfEmptyComment'
|
||||
| 'abruptDoctypePublicIdentifier'
|
||||
// … see readme on `options[key in ErrorCode]` above.
|
||||
```
|
||||
|
||||
### `ErrorSeverity`
|
||||
|
||||
Error severity (TypeScript type).
|
||||
|
||||
###### Types
|
||||
|
||||
```ts
|
||||
export type ErrorSeverity =
|
||||
// Turn the parse error off:
|
||||
| 0
|
||||
| false
|
||||
// Turn the parse error into a warning:
|
||||
| 1
|
||||
| true
|
||||
// Turn the parse error into an actual error: processing stops.
|
||||
| 2
|
||||
```
|
||||
|
||||
### `OnError`
|
||||
|
||||
Function called when encountering [HTML parse errors][parse-errors].
|
||||
|
||||
###### Parameters
|
||||
|
||||
* `error` ([`VFileMessage`][vfile-message])
|
||||
— message
|
||||
|
||||
###### Returns
|
||||
|
||||
Nothing (`void`).
|
||||
|
||||
### `Options`
|
||||
|
||||
Configuration (TypeScript type).
|
||||
|
||||
##### Fields
|
||||
|
||||
###### `options.space`
|
||||
|
||||
Which space the document is in (`'html'` or `'svg'`, default: `'html'`).
|
||||
|
||||
When an `<svg>` element is found in the HTML space, `hast-util-from-html`
|
||||
already automatically switches to and from the SVG space when entering and
|
||||
exiting it.
|
||||
|
||||
> 👉 **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`][xast-util-from-xml] to parse XML.
|
||||
|
||||
> 👉 **Note**: make sure to set `fragment: true` if `space: 'svg'`.
|
||||
|
||||
###### `options.verbose`
|
||||
|
||||
Add extra positional info about attributes, start tags, and end tags
|
||||
(`boolean`, default: `false`).
|
||||
|
||||
###### `options.fragment`
|
||||
|
||||
Whether to parse as a fragment (`boolean`, default: `false`).
|
||||
The default is to expect a whole document.
|
||||
In document mode, unopened `html`, `head`, and `body` elements are opened.
|
||||
|
||||
###### `options.onerror`
|
||||
|
||||
Function called when encountering [HTML parse errors][parse-errors]
|
||||
([`OnError`][api-on-error], optional).
|
||||
|
||||
###### `options[key in ErrorCode]`
|
||||
|
||||
Specific parse errors can be configured by setting their identifiers (see
|
||||
[`ErrorCode`][api-error-code]) as keys directly in `options` to an
|
||||
[`ErrorSeverity`][api-error-severity] as value.
|
||||
|
||||
The list of parse errors:
|
||||
|
||||
<!-- parse-error start -->
|
||||
|
||||
* `abandonedHeadElementChild` — unexpected metadata element after head ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/abandoned-head-element-child/index.html))
|
||||
* [`abruptClosingOfEmptyComment`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-abrupt-closing-of-empty-comment) — unexpected abruptly closed empty comment ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/abrupt-closing-of-empty-comment/index.html))
|
||||
* [`abruptDoctypePublicIdentifier`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-abrupt-doctype-public-identifier) — unexpected abruptly closed public identifier ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/abrupt-doctype-public-identifier/index.html))
|
||||
* [`abruptDoctypeSystemIdentifier`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-abrupt-doctype-system-identifier) — unexpected abruptly closed system identifier ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/abrupt-doctype-system-identifier/index.html))
|
||||
* [`absenceOfDigitsInNumericCharacterReference`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-absence-of-digits-in-numeric-character-reference) — unexpected non-digit at start of numeric character reference ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/absence-of-digits-in-numeric-character-reference/index.html))
|
||||
* [`cdataInHtmlContent`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-cdata-in-html-content) — unexpected CDATA section in HTML ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/cdata-in-html-content/index.html))
|
||||
* [`characterReferenceOutsideUnicodeRange`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-character-reference-outside-unicode-range) — unexpected too big numeric character reference ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/character-reference-outside-unicode-range/index.html))
|
||||
* `closingOfElementWithOpenChildElements` — unexpected closing tag with open child elements ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/closing-of-element-with-open-child-elements/index.html))
|
||||
* [`controlCharacterInInputStream`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-control-character-in-input-stream) — unexpected control character ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/control-character-in-input-stream/index.html))
|
||||
* [`controlCharacterReference`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-control-character-reference) — unexpected control character reference ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/control-character-reference/index.html))
|
||||
* `disallowedContentInNoscriptInHead` — disallowed content inside `<noscript>` in `<head>` ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/disallowed-content-in-noscript-in-head/index.html))
|
||||
* [`duplicateAttribute`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-duplicate-attribute) — unexpected duplicate attribute ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/duplicate-attribute/index.html))
|
||||
* [`endTagWithAttributes`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-end-tag-with-attributes) — unexpected attribute on closing tag ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/end-tag-with-attributes/index.html))
|
||||
* [`endTagWithTrailingSolidus`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-end-tag-with-trailing-solidus) — unexpected slash at end of closing tag ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/end-tag-with-trailing-solidus/index.html))
|
||||
* `endTagWithoutMatchingOpenElement` — unexpected unopened end tag ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/end-tag-without-matching-open-element/index.html))
|
||||
* [`eofBeforeTagName`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-eof-before-tag-name) — unexpected end of file ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/eof-before-tag-name/index.html))
|
||||
* [`eofInCdata`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-eof-in-cdata) — unexpected end of file in CDATA ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/eof-in-cdata/index.html))
|
||||
* [`eofInComment`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-eof-in-comment) — unexpected end of file in comment ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/eof-in-comment/index.html))
|
||||
* [`eofInDoctype`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-eof-in-doctype) — unexpected end of file in doctype ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/eof-in-doctype/index.html))
|
||||
* `eofInElementThatCanContainOnlyText` — unexpected end of file in element that can only contain text ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/eof-in-element-that-can-contain-only-text/index.html))
|
||||
* [`eofInScriptHtmlCommentLikeText`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-eof-in-script-html-comment-like-text) — unexpected end of file in comment inside script ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/eof-in-script-html-comment-like-text/index.html))
|
||||
* [`eofInTag`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-eof-in-tag) — unexpected end of file in tag ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/eof-in-tag/index.html))
|
||||
* [`incorrectlyClosedComment`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-incorrectly-closed-comment) — incorrectly closed comment ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/incorrectly-closed-comment/index.html))
|
||||
* [`incorrectlyOpenedComment`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-incorrectly-opened-comment) — incorrectly opened comment ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/incorrectly-opened-comment/index.html))
|
||||
* [`invalidCharacterSequenceAfterDoctypeName`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-invalid-character-sequence-after-doctype-name) — invalid sequence after doctype name ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/invalid-character-sequence-after-doctype-name/index.html))
|
||||
* [`invalidFirstCharacterOfTagName`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-invalid-first-character-of-tag-name) — invalid first character in tag name ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/invalid-first-character-of-tag-name/index.html))
|
||||
* `misplacedDoctype` — misplaced doctype ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/misplaced-doctype/index.html))
|
||||
* `misplacedStartTagForHeadElement` — misplaced `<head>` start tag ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/misplaced-start-tag-for-head-element/index.html))
|
||||
* [`missingAttributeValue`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-missing-attribute-value) — missing attribute value ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/missing-attribute-value/index.html))
|
||||
* `missingDoctype` — missing doctype before other content ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/missing-doctype/index.html))
|
||||
* [`missingDoctypeName`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-missing-doctype-name) — missing doctype name ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/missing-doctype-name/index.html))
|
||||
* [`missingDoctypePublicIdentifier`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-missing-doctype-public-identifier) — missing public identifier in doctype ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/missing-doctype-public-identifier/index.html))
|
||||
* [`missingDoctypeSystemIdentifier`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-missing-doctype-system-identifier) — missing system identifier in doctype ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/missing-doctype-system-identifier/index.html))
|
||||
* [`missingEndTagName`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-missing-end-tag-name) — missing name in end tag ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/missing-end-tag-name/index.html))
|
||||
* [`missingQuoteBeforeDoctypePublicIdentifier`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-missing-quote-before-doctype-public-identifier) — missing quote before public identifier in doctype ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/missing-quote-before-doctype-public-identifier/index.html))
|
||||
* [`missingQuoteBeforeDoctypeSystemIdentifier`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-missing-quote-before-doctype-system-identifier) — missing quote before system identifier in doctype ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/missing-quote-before-doctype-system-identifier/index.html))
|
||||
* [`missingSemicolonAfterCharacterReference`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-missing-semicolon-after-character-reference) — missing semicolon after character reference ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/missing-semicolon-after-character-reference/index.html))
|
||||
* [`missingWhitespaceAfterDoctypePublicKeyword`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-missing-whitespace-after-doctype-public-keyword) — missing whitespace after public identifier in doctype ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/missing-whitespace-after-doctype-public-keyword/index.html))
|
||||
* [`missingWhitespaceAfterDoctypeSystemKeyword`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-missing-whitespace-after-doctype-system-keyword) — missing whitespace after system identifier in doctype ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/missing-whitespace-after-doctype-system-keyword/index.html))
|
||||
* [`missingWhitespaceBeforeDoctypeName`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-missing-whitespace-before-doctype-name) — missing whitespace before doctype name ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/missing-whitespace-before-doctype-name/index.html))
|
||||
* [`missingWhitespaceBetweenAttributes`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-missing-whitespace-between-attributes) — missing whitespace between attributes ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/missing-whitespace-between-attributes/index.html))
|
||||
* [`missingWhitespaceBetweenDoctypePublicAndSystemIdentifiers`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-missing-whitespace-between-doctype-public-and-system-identifiers) — missing whitespace between public and system identifiers in doctype ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/missing-whitespace-between-doctype-public-and-system-identifiers/index.html))
|
||||
* [`nestedComment`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-nested-comment) — unexpected nested comment ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/nested-comment/index.html))
|
||||
* `nestedNoscriptInHead` — unexpected nested `<noscript>` in `<head>` ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/nested-noscript-in-head/index.html))
|
||||
* `nonConformingDoctype` — unexpected non-conforming doctype declaration ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/non-conforming-doctype/index.html))
|
||||
* [`nonVoidHtmlElementStartTagWithTrailingSolidus`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-non-void-html-element-start-tag-with-trailing-solidus) — unexpected trailing slash on start tag of non-void element ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/non-void-html-element-start-tag-with-trailing-solidus/index.html))
|
||||
* [`noncharacterCharacterReference`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-noncharacter-character-reference) — unexpected noncharacter code point referenced by character reference ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/noncharacter-character-reference/index.html))
|
||||
* [`noncharacterInInputStream`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-noncharacter-in-input-stream) — unexpected noncharacter character ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/noncharacter-in-input-stream/index.html))
|
||||
* [`nullCharacterReference`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-null-character-reference) — unexpected NULL character referenced by character reference ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/null-character-reference/index.html))
|
||||
* `openElementsLeftAfterEof` — unexpected end of file ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/open-elements-left-after-eof/index.html))
|
||||
* [`surrogateCharacterReference`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-surrogate-character-reference) — unexpected surrogate character referenced by character reference ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/surrogate-character-reference/index.html))
|
||||
* [`surrogateInInputStream`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-surrogate-in-input-stream) — unexpected surrogate character
|
||||
* [`unexpectedCharacterAfterDoctypeSystemIdentifier`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-unexpected-character-after-doctype-system-identifier) — invalid character after system identifier in doctype ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/unexpected-character-after-doctype-system-identifier/index.html))
|
||||
* [`unexpectedCharacterInAttributeName`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-unexpected-character-in-attribute-name) — unexpected character in attribute name ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/unexpected-character-in-attribute-name/index.html))
|
||||
* [`unexpectedCharacterInUnquotedAttributeValue`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-unexpected-character-in-unquoted-attribute-value) — unexpected character in unquoted attribute value ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/unexpected-character-in-unquoted-attribute-value/index.html))
|
||||
* [`unexpectedEqualsSignBeforeAttributeName`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-unexpected-equals-sign-before-attribute-name) — unexpected equals sign before attribute name ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/unexpected-equals-sign-before-attribute-name/index.html))
|
||||
* [`unexpectedNullCharacter`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-unexpected-null-character) — unexpected NULL character ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/unexpected-null-character/index.html))
|
||||
* [`unexpectedQuestionMarkInsteadOfTagName`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-unexpected-question-mark-instead-of-tag-name) — unexpected question mark instead of tag name ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/unexpected-question-mark-instead-of-tag-name/index.html))
|
||||
* [`unexpectedSolidusInTag`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-unexpected-solidus-in-tag) — unexpected slash in tag ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/unexpected-solidus-in-tag/index.html))
|
||||
* [`unknownNamedCharacterReference`](https://html.spec.whatwg.org/multipage/parsing.html#parse-error-unknown-named-character-reference) — unexpected unknown named character reference ([example](https://github.com/syntax-tree/hast-util-from-html/blob/main/test/parse-error/unknown-named-character-reference/index.html))
|
||||
|
||||
<!-- parse-error end -->
|
||||
|
||||
## Examples
|
||||
|
||||
### Example: fragment versus document
|
||||
|
||||
The following example shows the difference between parsing as a document and
|
||||
parsing as a fragment:
|
||||
|
||||
```js
|
||||
import {fromHtml} from 'hast-util-from-html'
|
||||
|
||||
const doc = '<title>Hi!</title><h1>Hello!</h1>'
|
||||
|
||||
console.log(fromHtml(doc))
|
||||
|
||||
console.log(fromHtml(doc, {fragment: true}))
|
||||
```
|
||||
|
||||
…yields (positional info and data omitted for brevity):
|
||||
|
||||
```js
|
||||
{
|
||||
type: 'root',
|
||||
children: [
|
||||
{type: 'element', tagName: 'html', properties: {}, children: [Array]}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
```js
|
||||
{
|
||||
type: 'root',
|
||||
children: [
|
||||
{type: 'element', tagName: 'title', properties: {}, children: [Array]},
|
||||
{type: 'element', tagName: 'h1', properties: {}, children: [Array]}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
> 👉 **Note**: observe that when a whole document is expected (first example),
|
||||
> missing elements are opened and closed.
|
||||
|
||||
### Example: whitespace around and inside `<html>`
|
||||
|
||||
The following example shows how whitespace is handled when around and directly
|
||||
inside the `<html>` element:
|
||||
|
||||
```js
|
||||
import {fromHtml} from 'hast-util-from-html'
|
||||
import {inspect} from 'unist-util-inspect'
|
||||
|
||||
const doc = `<!doctype html>
|
||||
<html lang=en>
|
||||
<head>
|
||||
<title>Hi!</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1>Hello!</h1>
|
||||
</body>
|
||||
</html>`
|
||||
|
||||
console.log(inspect(fromHtml(doc)))
|
||||
```
|
||||
|
||||
…yields:
|
||||
|
||||
```txt
|
||||
root[2] (1:1-9:8, 0-119)
|
||||
│ data: {"quirksMode":false}
|
||||
├─0 doctype (1:1-1:16, 0-15)
|
||||
└─1 element<html>[3] (2:1-9:8, 16-119)
|
||||
│ properties: {"lang":"en"}
|
||||
├─0 element<head>[3] (3:3-5:10, 33-72)
|
||||
│ │ properties: {}
|
||||
│ ├─0 text "\n " (3:9-4:5, 39-44)
|
||||
│ ├─1 element<title>[1] (4:5-4:23, 44-62)
|
||||
│ │ │ properties: {}
|
||||
│ │ └─0 text "Hi!" (4:12-4:15, 51-54)
|
||||
│ └─2 text "\n " (4:23-5:3, 62-65)
|
||||
├─1 text "\n " (5:10-6:3, 72-75)
|
||||
└─2 element<body>[3] (6:3-8:10, 75-111)
|
||||
│ properties: {}
|
||||
├─0 text "\n " (6:9-7:5, 81-86)
|
||||
├─1 element<h1>[1] (7:5-7:20, 86-101)
|
||||
│ │ properties: {}
|
||||
│ └─0 text "Hello!" (7:9-7:15, 90-96)
|
||||
└─2 text "\n \n" (7:20-9:1, 101-112)
|
||||
```
|
||||
|
||||
> 👉 **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 we follow.
|
||||
|
||||
The changes to this meaningless whitespace should not matter, except when
|
||||
formatting markup, in which case [`rehype-format`][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:
|
||||
|
||||
```js
|
||||
import {fromHtml} from 'hast-util-from-html'
|
||||
|
||||
const doc = `<!doctypehtml>
|
||||
<title class="a" class="b">Hello…</title>
|
||||
<h1/>World!</h1>`
|
||||
|
||||
fromHtml(doc, {
|
||||
onerror: console.log,
|
||||
missingWhitespaceBeforeDoctypeName: 2, // Mark one as a fatal error.
|
||||
nonVoidHtmlElementStartTagWithTrailingSolidus: false // Ignore one.
|
||||
})
|
||||
```
|
||||
|
||||
…yields:
|
||||
|
||||
```txt
|
||||
[1:10-1:10: Missing whitespace before doctype name] {
|
||||
ancestors: undefined,
|
||||
cause: undefined,
|
||||
column: 10,
|
||||
fatal: true,
|
||||
line: 1,
|
||||
place: {
|
||||
start: { line: 1, column: 10, offset: 9 },
|
||||
end: { line: 1, column: 10, offset: 9 }
|
||||
},
|
||||
reason: 'Missing whitespace before doctype name',
|
||||
ruleId: 'missing-whitespace-before-doctype-name',
|
||||
source: 'hast-util-from-html',
|
||||
note: 'Unexpected `h`. Expected ASCII whitespace instead',
|
||||
url: 'https://html.spec.whatwg.org/multipage/parsing.html#parse-error-missing-whitespace-before-doctype-name'
|
||||
}
|
||||
[2:23-2:23: Unexpected duplicate attribute] {
|
||||
ancestors: undefined,
|
||||
cause: undefined,
|
||||
column: 23,
|
||||
fatal: false,
|
||||
line: 2,
|
||||
place: {
|
||||
start: { line: 2, column: 23, offset: 37 },
|
||||
end: { line: 2, column: 23, offset: 37 }
|
||||
},
|
||||
reason: 'Unexpected duplicate attribute',
|
||||
ruleId: 'duplicate-attribute',
|
||||
source: 'hast-util-from-html',
|
||||
note: 'Unexpectedly double attribute. Expected attributes to occur only once',
|
||||
url: 'https://html.spec.whatwg.org/multipage/parsing.html#parse-error-duplicate-attribute'
|
||||
}
|
||||
```
|
||||
|
||||
> 🧑🏫 **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 we 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 can continue doing work.
|
||||
|
||||
## Syntax
|
||||
|
||||
HTML is parsed according to WHATWG HTML (the living standard), which is also
|
||||
followed by browsers such as Chrome and Firefox.
|
||||
|
||||
## Types
|
||||
|
||||
This package is fully typed with [TypeScript][].
|
||||
It exports the additional types
|
||||
[`ErrorCode`][api-error-code], [`ErrorSeverity`][api-error-severity],
|
||||
[`OnError`][api-on-error], and [`Options`][api-options].
|
||||
|
||||
## Compatibility
|
||||
|
||||
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, `hast-util-from-html@^2`,
|
||||
compatible with Node.js 16.
|
||||
|
||||
## Security
|
||||
|
||||
Parsing HTML is safe but using user-provided content can open you up to a
|
||||
[cross-site scripting (XSS)][xss] attack.
|
||||
Use [`hast-util-santize`][hast-util-sanitize] to make the hast tree safe.
|
||||
|
||||
## Related
|
||||
|
||||
* [`hast-util-to-html`](https://github.com/syntax-tree/hast-util-to-html)
|
||||
— serialize hast
|
||||
* [`hast-util-sanitize`](https://github.com/syntax-tree/hast-util-sanitize)
|
||||
— sanitize hast
|
||||
* [`xast-util-from-xml`][xast-util-from-xml]
|
||||
— parse XML
|
||||
|
||||
## Contribute
|
||||
|
||||
See [`contributing.md`][contributing] in [`syntax-tree/.github`][health] for
|
||||
ways to get started.
|
||||
See [`support.md`][support] for ways to get help.
|
||||
|
||||
This project has a [code of conduct][coc].
|
||||
By interacting with this repository, organization, or community you agree to
|
||||
abide by its terms.
|
||||
|
||||
## License
|
||||
|
||||
[MIT][license] © [Titus Wormer][author]
|
||||
|
||||
<!-- Definitions -->
|
||||
|
||||
[build-badge]: https://github.com/syntax-tree/hast-util-from-html/workflows/main/badge.svg
|
||||
|
||||
[build]: https://github.com/syntax-tree/hast-util-from-html/actions
|
||||
|
||||
[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/hast-util-from-html.svg
|
||||
|
||||
[coverage]: https://codecov.io/github/syntax-tree/hast-util-from-html
|
||||
|
||||
[downloads-badge]: https://img.shields.io/npm/dm/hast-util-from-html.svg
|
||||
|
||||
[downloads]: https://www.npmjs.com/package/hast-util-from-html
|
||||
|
||||
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=hast-util-from-html
|
||||
|
||||
[size]: https://bundlejs.com/?q=hast-util-from-html
|
||||
|
||||
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
|
||||
|
||||
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
|
||||
|
||||
[collective]: https://opencollective.com/unified
|
||||
|
||||
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
|
||||
|
||||
[chat]: https://github.com/syntax-tree/unist/discussions
|
||||
|
||||
[npm]: https://docs.npmjs.com/cli/install
|
||||
|
||||
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
|
||||
|
||||
[esmsh]: https://esm.sh
|
||||
|
||||
[typescript]: https://www.typescriptlang.org
|
||||
|
||||
[license]: license
|
||||
|
||||
[author]: https://wooorm.com
|
||||
|
||||
[health]: https://github.com/syntax-tree/.github
|
||||
|
||||
[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md
|
||||
|
||||
[support]: https://github.com/syntax-tree/.github/blob/main/support.md
|
||||
|
||||
[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md
|
||||
|
||||
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
|
||||
|
||||
[hast]: https://github.com/syntax-tree/hast
|
||||
|
||||
[root]: https://github.com/syntax-tree/hast#root
|
||||
|
||||
[hast-util-sanitize]: https://github.com/syntax-tree/hast-util-sanitize
|
||||
|
||||
[hast-util-from-parse5]: https://github.com/syntax-tree/hast-util-from-parse5
|
||||
|
||||
[hast-util-to-html]: https://github.com/syntax-tree/hast-util-to-html
|
||||
|
||||
[xast-util-from-xml]: https://github.com/syntax-tree/xast-util-from-xml
|
||||
|
||||
[rehype-parse]: https://github.com/rehypejs/rehype/tree/main/packages/rehype-parse#readme
|
||||
|
||||
[rehype-format]: https://github.com/rehypejs/rehype-format
|
||||
|
||||
[parse5]: https://github.com/inikulin/parse5
|
||||
|
||||
[parse-errors]: https://html.spec.whatwg.org/multipage/parsing.html#parse-errors
|
||||
|
||||
[vfile-message]: https://github.com/vfile/vfile-message#vfilemessagereason-place-origin
|
||||
|
||||
[hast-util-from-html-isomorphic]: https://github.com/syntax-tree/hast-util-from-html-isomorphic
|
||||
|
||||
[compatible]: https://github.com/vfile/vfile#compatible
|
||||
|
||||
[api-from-html]: #fromhtmlvalue-options
|
||||
|
||||
[api-error-code]: #errorcode
|
||||
|
||||
[api-error-severity]: #errorseverity
|
||||
|
||||
[api-on-error]: #onerror
|
||||
|
||||
[api-options]: #options
|
Reference in New Issue
Block a user