html-validate 6.3.1 → 6.5.0

package/dist/cjs/core.d.ts

@@ -40,28 +40,95 @@ declare class EventHandler {
 declare enum TokenType {
     UNICODE_BOM = 1,
     WHITESPACE = 2,
-    NEWLINE = 3,
-    DOCTYPE_OPEN = 4,
-    DOCTYPE_VALUE = 5,
-    DOCTYPE_CLOSE = 6,
-    TAG_OPEN = 7,
-    TAG_CLOSE = 8,
-    ATTR_NAME = 9,
-    ATTR_VALUE = 10,
-    TEXT = 11,
-    TEMPLATING = 12,
-    SCRIPT = 13,
-    STYLE = 14,
-    COMMENT = 15,
-    CONDITIONAL = 16,
-    DIRECTIVE = 17,
-    EOF = 18
-}
-interface Token {
+    DOCTYPE_OPEN = 3,
+    DOCTYPE_VALUE = 4,
+    DOCTYPE_CLOSE = 5,
+    TAG_OPEN = 6,
+    TAG_CLOSE = 7,
+    ATTR_NAME = 8,
+    ATTR_VALUE = 9,
+    TEXT = 10,
+    TEMPLATING = 11,
+    SCRIPT = 12,
+    STYLE = 13,
+    COMMENT = 14,
+    CONDITIONAL = 15,
+    DIRECTIVE = 16,
+    EOF = 17
+}
+interface BaseToken {
     type: TokenType;
     location: Location;
-    data?: any;
 }
+interface UnicodeBOMToken extends BaseToken {
+    type: TokenType.UNICODE_BOM;
+    data: [bom: string];
+}
+interface WhitespaceToken extends BaseToken {
+    type: TokenType.WHITESPACE;
+    data: [text: string];
+}
+interface DoctypeOpenToken extends BaseToken {
+    type: TokenType.DOCTYPE_OPEN;
+    data: [text: string, tag: string];
+}
+interface DoctypeValueToken extends BaseToken {
+    type: TokenType.DOCTYPE_VALUE;
+    data: [text: string];
+}
+interface DoctypeCloseToken extends BaseToken {
+    type: TokenType.DOCTYPE_CLOSE;
+    data: [text: ">"];
+}
+interface TagOpenToken extends BaseToken {
+    type: TokenType.TAG_OPEN;
+    data: [text: string, close: "/" | "", tag: string];
+}
+interface TagCloseToken extends BaseToken {
+    type: TokenType.TAG_CLOSE;
+    data: [text: ">" | "/>"];
+}
+interface AttrNameToken extends BaseToken {
+    type: TokenType.ATTR_NAME;
+    data: [text: string, name: string];
+}
+interface AttrValueToken extends BaseToken {
+    type: TokenType.ATTR_VALUE;
+    data: [text: string, delimiter: string, value: string, quote?: '"' | "'"];
+}
+interface TextToken extends BaseToken {
+    type: TokenType.TEXT;
+    data: [text: string];
+}
+interface TemplatingToken extends BaseToken {
+    type: TokenType.TEMPLATING;
+    data: [text: string];
+}
+interface ScriptToken extends BaseToken {
+    type: TokenType.SCRIPT;
+    data: [text: string];
+}
+interface StyleToken extends BaseToken {
+    type: TokenType.STYLE;
+    data: [text: string];
+}
+interface CommentToken extends BaseToken {
+    type: TokenType.COMMENT;
+    data: [text: string, comment: string];
+}
+interface ConditionalToken extends BaseToken {
+    type: TokenType.CONDITIONAL;
+    data: [text: string, condition: string];
+}
+interface DirectiveToken extends BaseToken {
+    type: TokenType.DIRECTIVE;
+    data: [text: string, begin: "[", action: string, rest: string, end: "]" | ""];
+}
+interface EOFToken extends BaseToken {
+    type: TokenType.EOF;
+    data: [];
+}
+declare type Token = UnicodeBOMToken | WhitespaceToken | DoctypeOpenToken | DoctypeValueToken | DoctypeCloseToken | TagOpenToken | TagCloseToken | AttrNameToken | AttrValueToken | TextToken | TemplatingToken | ScriptToken | StyleToken | CommentToken | ConditionalToken | DirectiveToken | EOFToken;
 
 declare type TokenStream = IterableIterator<Token>;
 
@@ -502,6 +569,8 @@ interface ConditionalEvent extends Event {
     location: Location;
     /** Condition including markers. */
     condition: string;
+    /** The element containing the conditional, if any. */
+    parent: HtmlElement | null;
 }
 /**
  * Event emitted when html-validate directives `<!-- [html-validate-...] -->`
@@ -625,14 +694,14 @@ declare class Parser {
      * stack when is allowed to omit.
      */
     private closeOptional;
-    protected consumeTag(source: Source, startToken: Token, tokenStream: TokenStream): void;
+    protected consumeTag(source: Source, startToken: TagOpenToken, tokenStream: TokenStream): void;
     protected closeElement(source: Source, node: HtmlElement | null, active: HtmlElement, location: Location): void;
     private processElement;
     /**
      * Discard tokens until the end tag for the foreign element is found.
      */
     protected discardForeignBody(source: Source, foreignTagName: string, tokenStream: TokenStream, errorLocation: Location): void;
-    protected consumeAttribute(source: Source, node: HtmlElement, token: Token, next?: Token): void;
+    protected consumeAttribute(source: Source, node: HtmlElement, token: AttrNameToken, next?: Token): void;
     /**
      * Takes attribute key token an returns location.
      */
@@ -650,17 +719,24 @@ declare class Parser {
      * an aggregate location covering key, quotes if present and value.
      */
     private getAttributeLocation;
-    protected consumeDirective(token: Token): void;
+    protected consumeDirective(token: DirectiveToken): void;
+    /**
+     * Consumes conditional comment in tag form.
+     *
+     * See also the related [[consumeCommend]] method.
+     */
+    protected consumeConditional(token: ConditionalToken): void;
     /**
      * Consumes comment token.
      *
-     * Tries to find IE conditional comments and emits conditional token if found.
+     * Tries to find IE conditional comments and emits conditional token if
+     * found. See also the related [[consumeConditional]] method.
      */
-    protected consumeComment(token: Token): void;
+    protected consumeComment(token: CommentToken): void;
     /**
      * Consumes doctype tokens. Emits doctype event.
      */
-    protected consumeDoctype(startToken: Token, tokenStream: TokenStream): void;
+    protected consumeDoctype(startToken: DoctypeOpenToken, tokenStream: TokenStream): void;
     /**
      * Return a list of tokens found until the expected token was found.
      *
@@ -1145,7 +1221,7 @@ declare class HtmlElement extends DOMNode {
     /**
      * @internal
      */
-    static fromTokens(startToken: Token, endToken: Token, parent: HtmlElement | null, metaTable: MetaTable | null): HtmlElement;
+    static fromTokens(startToken: TagOpenToken, endToken: TagCloseToken, parent: HtmlElement | null, metaTable: MetaTable | null): HtmlElement;
     /**
      * Returns annotated name if set or defaults to `<tagName>`.
      *

package/dist/cjs/core.js

@@ -1487,8 +1487,8 @@ class DOMTokenList extends Array {
     constructor(value, location) {
         if (value && typeof value === "string") {
             /* replace all whitespace with a single space for easier parsing */
-            const condensed = value.replace(/[\t\r\n ]+/g, " ");
-            const { tokens, locations } = parse(condensed, location);
+            const normalized = value.replace(/[\t\r\n]/g, " ");
+            const { tokens, locations } = parse(normalized, location);
             super(...tokens);
             this.locations = locations;
         }
@@ -2956,7 +2956,7 @@ var TRANSFORMER_API;
 /** @public */
 const name = "html-validate";
 /** @public */
-const version = "6.3.1";
+const version = "6.5.0";
 /** @public */
 const homepage = "https://html-validate.org";
 /** @public */
@@ -2995,6 +2995,42 @@ function parseSeverity(value) {
     }
 }
 
+function escape(value) {
+    return value.replace(/'/g, "\\'");
+}
+function format(value, quote = false) {
+    if (value === null) {
+        return "null";
+    }
+    if (typeof value === "number") {
+        return value.toString();
+    }
+    if (typeof value === "string") {
+        return quote ? `'${escape(value)}'` : value;
+    }
+    if (Array.isArray(value)) {
+        const content = value.map((it) => format(it, true)).join(", ");
+        return `[ ${content} ]`;
+    }
+    if (typeof value === "object") {
+        const content = Object.entries(value)
+            .map(([key, nested]) => `${key}: ${format(nested, true)}`)
+            .join(", ");
+        return `{ ${content} }`;
+    }
+    return String(value);
+}
+/**
+ * Replaces placeholder `{{ ... }}` with values from given object.
+ *
+ * @internal
+ */
+function interpolate(text, data) {
+    return text.replace(/{{\s*([^\s]+)\s*}}/g, (match, key) => {
+        return typeof data[key] !== "undefined" ? format(data[key]) : match;
+    });
+}
+
 const remapEvents = {
     "tag:open": "tag:start",
     "tag:close": "tag:end",
@@ -3129,7 +3165,8 @@ class Rule {
     report(node, message, location, context) {
         if (this.isEnabled() && (!node || node.ruleEnabled(this.name))) {
             const where = this.findLocation({ node, location, event: this.event });
-            this.reporter.add(this, message, this.severity, node, where, context);
+            const interpolated = interpolate(message, context !== null && context !== void 0 ? context : {});
+            this.reporter.add(this, interpolated, this.severity, node, where, context);
         }
     }
     findLocation(src) {
@@ -3236,7 +3273,8 @@ function ruleDocumentationUrl(filename) {
     const p = path__default["default"].parse(filename);
     const root = path__default["default"].join(distFolder, "rules");
     const rel = path__default["default"].relative(root, path__default["default"].join(p.dir, p.name));
-    return `${homepage}/rules/${rel}.html`;
+    const normalized = rel.replace(/\\/g, "/");
+    return `${homepage}/rules/${normalized}.html`;
 }
 
 const defaults$p = {
@@ -3653,22 +3691,21 @@ exports.TokenType = void 0;
 (function (TokenType) {
     TokenType[TokenType["UNICODE_BOM"] = 1] = "UNICODE_BOM";
     TokenType[TokenType["WHITESPACE"] = 2] = "WHITESPACE";
-    TokenType[TokenType["NEWLINE"] = 3] = "NEWLINE";
-    TokenType[TokenType["DOCTYPE_OPEN"] = 4] = "DOCTYPE_OPEN";
-    TokenType[TokenType["DOCTYPE_VALUE"] = 5] = "DOCTYPE_VALUE";
-    TokenType[TokenType["DOCTYPE_CLOSE"] = 6] = "DOCTYPE_CLOSE";
-    TokenType[TokenType["TAG_OPEN"] = 7] = "TAG_OPEN";
-    TokenType[TokenType["TAG_CLOSE"] = 8] = "TAG_CLOSE";
-    TokenType[TokenType["ATTR_NAME"] = 9] = "ATTR_NAME";
-    TokenType[TokenType["ATTR_VALUE"] = 10] = "ATTR_VALUE";
-    TokenType[TokenType["TEXT"] = 11] = "TEXT";
-    TokenType[TokenType["TEMPLATING"] = 12] = "TEMPLATING";
-    TokenType[TokenType["SCRIPT"] = 13] = "SCRIPT";
-    TokenType[TokenType["STYLE"] = 14] = "STYLE";
-    TokenType[TokenType["COMMENT"] = 15] = "COMMENT";
-    TokenType[TokenType["CONDITIONAL"] = 16] = "CONDITIONAL";
-    TokenType[TokenType["DIRECTIVE"] = 17] = "DIRECTIVE";
-    TokenType[TokenType["EOF"] = 18] = "EOF";
+    TokenType[TokenType["DOCTYPE_OPEN"] = 3] = "DOCTYPE_OPEN";
+    TokenType[TokenType["DOCTYPE_VALUE"] = 4] = "DOCTYPE_VALUE";
+    TokenType[TokenType["DOCTYPE_CLOSE"] = 5] = "DOCTYPE_CLOSE";
+    TokenType[TokenType["TAG_OPEN"] = 6] = "TAG_OPEN";
+    TokenType[TokenType["TAG_CLOSE"] = 7] = "TAG_CLOSE";
+    TokenType[TokenType["ATTR_NAME"] = 8] = "ATTR_NAME";
+    TokenType[TokenType["ATTR_VALUE"] = 9] = "ATTR_VALUE";
+    TokenType[TokenType["TEXT"] = 10] = "TEXT";
+    TokenType[TokenType["TEMPLATING"] = 11] = "TEMPLATING";
+    TokenType[TokenType["SCRIPT"] = 12] = "SCRIPT";
+    TokenType[TokenType["STYLE"] = 13] = "STYLE";
+    TokenType[TokenType["COMMENT"] = 14] = "COMMENT";
+    TokenType[TokenType["CONDITIONAL"] = 15] = "CONDITIONAL";
+    TokenType[TokenType["DIRECTIVE"] = 16] = "DIRECTIVE";
+    TokenType[TokenType["EOF"] = 17] = "EOF";
 })(exports.TokenType || (exports.TokenType = {}));
 
 /* eslint-disable no-useless-escape */
@@ -3693,7 +3730,7 @@ const MATCH_SCRIPT_DATA = /^[^]*?(?=<\/script)/;
 const MATCH_SCRIPT_END = /^<(\/)(script)/;
 const MATCH_STYLE_DATA = /^[^]*?(?=<\/style)/;
 const MATCH_STYLE_END = /^<(\/)(style)/;
-const MATCH_DIRECTIVE = /^<!--\s*\[html-validate-(.*?)]\s*-->/;
+const MATCH_DIRECTIVE = /^<!--\s*(\[)html-validate-([a-z0-9-]+)\s*(.*?)(]?)\s*-->/;
 const MATCH_COMMENT = /^<!--([^]*?)-->/;
 const MATCH_CONDITIONAL = /^<!\[([^\]]*?)\]>/;
 class InvalidTokenError extends Error {
@@ -3748,15 +3785,15 @@ class Lexer {
             previousState = context.state;
             previousLength = context.string.length;
         }
-        yield this.token(context, exports.TokenType.EOF);
+        yield this.token(context, exports.TokenType.EOF, []);
     }
     token(context, type, data) {
-        const size = data ? data[0].length : 0;
+        const size = data.length > 0 ? data[0].length : 0;
         const location = context.getLocation(size);
         return {
             type,
             location,
-            data: data ? Array.from(data) : null,
+            data: Array.from(data),
         };
     }
     /* istanbul ignore next: used to provide a better error when an unhandled state happens */
@@ -3781,17 +3818,18 @@ class Lexer {
         }
     }
     *match(context, tests, error) {
-        let match = null;
         const n = tests.length;
         for (let i = 0; i < n; i++) {
             const [regex, nextState, tokenType] = tests[i];
-            if (regex === false || (match = context.string.match(regex))) {
+            const match = regex ? context.string.match(regex) : [""];
+            if (match) {
                 let token = null;
                 if (tokenType !== false) {
-                    yield (token = this.token(context, tokenType, match));
+                    token = this.token(context, tokenType, match);
+                    yield token;
                 }
                 const state = this.evalNextState(nextState, token);
-                context.consume(match || 0, state);
+                context.consume(match, state);
                 this.enter(context, state, match);
                 return;
             }
@@ -3838,18 +3876,19 @@ class Lexer {
     *tokenizeTag(context) {
         /* eslint-disable-next-line consistent-return -- exhaustive switch handled by typescript */
         function nextState(token) {
+            const tagCloseToken = token;
             switch (context.contentModel) {
                 case ContentModel.TEXT:
                     return State.TEXT;
                 case ContentModel.SCRIPT:
-                    if (token && token.data[0][0] !== "/") {
+                    if (tagCloseToken && tagCloseToken.data[0][0] !== "/") {
                         return State.SCRIPT;
                     }
                     else {
                         return State.TEXT; /* <script/> (not legal but handle it anyway so the lexer doesn't choke on it) */
                     }
                 case ContentModel.STYLE:
-                    if (token && token.data[0][0] !== "/") {
+                    if (tagCloseToken && tagCloseToken.data[0][0] !== "/") {
                         return State.STYLE;
                     }
                     else {
@@ -5997,7 +6036,7 @@ class NoConditionalComment extends Rule {
     }
     setup() {
         this.on("conditional", (event) => {
-            this.report(null, "Use of conditional comments are deprecated", event.location);
+            this.report(event.parent, "Use of conditional comments are deprecated", event.location);
         });
     }
 }
@@ -9770,7 +9809,9 @@ class ResolvedConfig {
      * @returns A list of transformed sources ready for validation.
      */
     transformFilename(filename) {
-        const data = fs__default["default"].readFileSync(filename, { encoding: "utf8" });
+        const stdin = 0;
+        const src = filename !== "/dev/stdin" ? filename : stdin;
+        const data = fs__default["default"].readFileSync(src, { encoding: "utf8" });
         const source = {
             data,
             filename,
@@ -10421,6 +10462,9 @@ class ParserError extends Error {
     }
 }
 
+function isAttrValueToken(token) {
+    return Boolean(token && token.type === exports.TokenType.ATTR_VALUE);
+}
 /**
  * Parse HTML document into a DOM tree.
  *
@@ -10492,10 +10536,7 @@ class Parser {
                     this.consumeDirective(token);
                     break;
                 case exports.TokenType.CONDITIONAL:
-                    this.trigger("conditional", {
-                        condition: token.data[1],
-                        location: token.location,
-                    });
+                    this.consumeConditional(token);
                     break;
                 case exports.TokenType.COMMENT:
                     this.consumeComment(token);
@@ -10505,7 +10546,7 @@ class Parser {
                     break;
                 case exports.TokenType.TEXT:
                 case exports.TokenType.TEMPLATING:
-                    this.appendText(token.data, token.location);
+                    this.appendText(token.data[0], token.location);
                     break;
                 case exports.TokenType.EOF:
                     this.closeTree(source, token.location);
@@ -10700,15 +10741,15 @@ class Parser {
         const keyLocation = this.getAttributeKeyLocation(token);
         const valueLocation = this.getAttributeValueLocation(next);
         const location = this.getAttributeLocation(token, next);
-        const haveValue = next && next.type === exports.TokenType.ATTR_VALUE;
+        const haveValue = isAttrValueToken(next);
         const attrData = {
             key: token.data[1],
             value: null,
             quote: null,
         };
-        if (next && haveValue) {
+        if (haveValue) {
             const [, , value, quote] = next.data;
-            attrData.value = value !== null && value !== void 0 ? value : null;
+            attrData.value = value;
             attrData.quote = quote !== null && quote !== void 0 ? quote : null;
         }
         /* get callback to process attributes, default is to just return attribute
@@ -10787,12 +10828,16 @@ class Parser {
         };
     }
     consumeDirective(token) {
-        const directive = token.data[1];
-        const match = directive.match(/^([a-zA-Z0-9-]+)\s*(.*?)(?:\s*:\s*(.*))?$/);
+        const [text, , action, directive, end] = token.data;
+        if (end === "") {
+            throw new Error(`Missing end bracket "]" on directive "${text}"`);
+        }
+        const match = directive.match(/^(.*?)(?:\s*(?:--|:)\s*(.*))?$/);
+        /* istanbul ignore next: should not be possible, would be emitted as comment token */
         if (!match) {
-            throw new Error(`Failed to parse directive "${directive}"`);
+            throw new Error(`Failed to parse directive "${text}"`);
         }
-        const [, action, data, comment] = match;
+        const [, data, comment] = match;
         this.trigger("directive", {
             action,
             data,
@@ -10800,17 +10845,33 @@ class Parser {
             location: token.location,
         });
     }
+    /**
+     * Consumes conditional comment in tag form.
+     *
+     * See also the related [[consumeCommend]] method.
+     */
+    consumeConditional(token) {
+        const element = this.dom.getActive();
+        this.trigger("conditional", {
+            condition: token.data[1],
+            location: token.location,
+            parent: element,
+        });
+    }
     /**
      * Consumes comment token.
      *
-     * Tries to find IE conditional comments and emits conditional token if found.
+     * Tries to find IE conditional comments and emits conditional token if
+     * found. See also the related [[consumeConditional]] method.
      */
     consumeComment(token) {
         const comment = token.data[0];
+        const element = this.dom.getActive();
         for (const conditional of parseConditionalComment(comment, token.location)) {
             this.trigger("conditional", {
                 condition: conditional.expression,
                 location: conditional.location,
+                parent: element,
             });
         }
     }
@@ -10819,7 +10880,8 @@ class Parser {
      */
     consumeDoctype(startToken, tokenStream) {
         const tokens = Array.from(this.consumeUntil(tokenStream, exports.TokenType.DOCTYPE_CLOSE, startToken.location));
-        const doctype = tokens[0]; /* first token is the doctype, second is the closing ">" */
+        /* first token is the doctype, second is the closing ">" */
+        const doctype = tokens[0];
         const value = doctype.data[0];
         this.dom.doctype = value;
         this.trigger("doctype", {
@@ -10852,7 +10914,7 @@ class Parser {
             this.trigger("token", {
                 location: token.location,
                 type: token.type,
-                data: token.data ? Array.from(token.data) : undefined,
+                data: Array.from(token.data),
             });
         }
         return it;
@@ -11112,11 +11174,12 @@ class Engine {
         return lines;
     }
     dumpTokens(source) {
+        var _a;
         const lexer = new Lexer();
         const lines = [];
         for (const src of source) {
             for (const token of lexer.tokenize(src)) {
-                const data = token.data ? token.data[0] : null;
+                const data = (_a = token.data[0]) !== null && _a !== void 0 ? _a : "";
                 lines.push({
                     token: exports.TokenType[token.type],
                     data,