html-validate 7.0.0 → 7.1.0

package/dist/es/core.d.ts

@@ -333,12 +333,13 @@ declare abstract class Rule<ContextType = void, OptionsType = void> {
      * not `"foo"`.
      *
      * @param keyword - Keyword to match against `include` and `exclude` options.
+     * @param matcher - Optional function to compare items with.
      * @returns `true` if keyword is not present in `include` or is present in
      * `exclude`.
      */
     isKeywordIgnored<T extends IncludeExcludeOptions>(this: {
         options: T;
-    }, keyword: string): boolean;
+    }, keyword: string, matcher?: (list: string[], it: string) => boolean): boolean;
     /**
      * Find all tags which has enabled given property.
      */

package/dist/es/core.js

@@ -2071,6 +2071,7 @@ class HtmlElement extends DOMNode {
         }
         const parts = [];
         let root;
+        /* eslint-disable-next-line @typescript-eslint/no-this-alias */
         for (root = this; root.parent; root = root.parent) {
             /* .. */
         }
@@ -3082,7 +3083,7 @@ var TRANSFORMER_API;
 /** @public */
 const name = "html-validate";
 /** @public */
-const version = "7.0.0";
+const version = "7.1.0";
 /** @public */
 const homepage = "https://html-validate.org";
 /** @public */
@@ -3245,17 +3246,18 @@ class Rule {
      * not `"foo"`.
      *
      * @param keyword - Keyword to match against `include` and `exclude` options.
+     * @param matcher - Optional function to compare items with.
      * @returns `true` if keyword is not present in `include` or is present in
      * `exclude`.
      */
-    isKeywordIgnored(keyword) {
+    isKeywordIgnored(keyword, matcher = (list, it) => list.includes(it)) {
         const { include, exclude } = this.options;
         /* ignore keyword if not present in "include" */
-        if (include && !include.includes(keyword)) {
+        if (include && !matcher(include, keyword)) {
             return true;
         }
         /* ignore keyword if present in "excludes" */
-        if (exclude && exclude.includes(keyword)) {
+        if (exclude && matcher(exclude, keyword)) {
             return true;
         }
         return false;
@@ -3403,7 +3405,7 @@ function ruleDocumentationUrl(filename) {
     return `${homepage}/rules/${normalized}.html`;
 }
 
-const defaults$r = {
+const defaults$s = {
     allowExternal: true,
     allowRelative: true,
     allowAbsolute: true,
@@ -3447,7 +3449,7 @@ function matchList(value, list) {
 }
 class AllowedLinks extends Rule {
     constructor(options) {
-        super({ ...defaults$r, ...options });
+        super({ ...defaults$s, ...options });
         this.allowExternal = parseAllow(this.options.allowExternal);
         this.allowRelative = parseAllow(this.options.allowRelative);
         this.allowAbsolute = parseAllow(this.options.allowAbsolute);
@@ -3748,13 +3750,13 @@ class CaseStyle {
     }
 }
 
-const defaults$q = {
+const defaults$r = {
     style: "lowercase",
     ignoreForeign: true,
 };
 class AttrCase extends Rule {
     constructor(options) {
-        super({ ...defaults$q, ...options });
+        super({ ...defaults$r, ...options });
         this.style = new CaseStyle(this.options.style, "attr-case");
     }
     static schema() {
@@ -4094,7 +4096,7 @@ class AttrDelimiter extends Rule {
 }
 
 const DEFAULT_PATTERN = "[a-z0-9-:]+";
-const defaults$p = {
+const defaults$q = {
     pattern: DEFAULT_PATTERN,
     ignoreForeign: true,
 };
@@ -4131,7 +4133,7 @@ function generateDescription(name, pattern) {
 }
 class AttrPattern extends Rule {
     constructor(options) {
-        super({ ...defaults$p, ...options });
+        super({ ...defaults$q, ...options });
         this.pattern = generateRegexp(this.options.pattern);
     }
     static schema() {
@@ -4190,20 +4192,56 @@ var QuoteStyle;
     QuoteStyle["SINGLE_QUOTE"] = "'";
     QuoteStyle["DOUBLE_QUOTE"] = "\"";
     QuoteStyle["AUTO_QUOTE"] = "auto";
+    QuoteStyle["ANY_QUOTE"] = "any";
 })(QuoteStyle || (QuoteStyle = {}));
-const defaults$o = {
+const defaults$p = {
     style: "auto",
     unquoted: false,
 };
+function describeError(context) {
+    if (context) {
+        switch (context.error) {
+            case "style":
+                return `Attribute \`${context.attr}\` must use \`${context.expected}\` instead of \`${context.actual}\`.`;
+            case "unquoted":
+                return `Attribute \`${context.attr}\` must not be unquoted.`;
+        }
+    }
+    else {
+        return "This attribute is not quoted properly.";
+    }
+}
+function describeStyle(style, unquoted) {
+    const description = [];
+    switch (style) {
+        case QuoteStyle.AUTO_QUOTE:
+            description.push("- quoted with double quotes `\"` unless the value contains double quotes in which case single quotes `'` should be used instead");
+            break;
+        case QuoteStyle.ANY_QUOTE:
+            description.push("- quoted with single quotes `'`");
+            description.push('- quoted with double quotes `"`');
+            break;
+        case QuoteStyle.SINGLE_QUOTE:
+        case QuoteStyle.DOUBLE_QUOTE: {
+            const name = style === QuoteStyle.SINGLE_QUOTE ? "single" : "double";
+            description.push(`- quoted with ${name} quotes \`${style}\``);
+            break;
+        }
+    }
+    if (unquoted) {
+        description.push("- unquoted (if applicable)");
+    }
+    return `${description.join(" or\n")}\n`;
+}
 class AttrQuotes extends Rule {
     constructor(options) {
-        super({ ...defaults$o, ...options });
+        super({ ...defaults$p, ...options });
         this.style = parseStyle$4(this.options.style);
     }
     static schema() {
         return {
             style: {
-                enum: ["auto", "double", "single"],
+                enum: ["auto", "double", "single", "any"],
                 type: "string",
             },
             unquoted: {
@@ -4211,19 +4249,20 @@ class AttrQuotes extends Rule {
             },
         };
     }
-    documentation() {
-        if (this.options.style === "auto") {
-            return {
-                description: `Attribute values are required to be quoted with doublequotes unless the attribute value itself contains doublequotes in which case singlequotes should be used.`,
-                url: ruleDocumentationUrl("@/rules/attr-quotes.ts"),
-            };
-        }
-        else {
-            return {
-                description: `Attribute values are required to be quoted with ${this.options.style}quotes.`,
-                url: ruleDocumentationUrl("@/rules/attr-quotes.ts"),
-            };
-        }
+    documentation(context) {
+        const { style } = this;
+        const { unquoted } = this.options;
+        const description = [
+            describeError(context),
+            "",
+            "Under the current configuration attributes must be:",
+            "",
+            describeStyle(style, unquoted),
+        ];
+        return {
+            description: description.join("\n"),
+            url: ruleDocumentationUrl("@/rules/attr-quotes.ts"),
+        };
     }
     setup() {
         this.on("attr", (event) => {
@@ -4233,13 +4272,31 @@ class AttrQuotes extends Rule {
             }
             if (!event.quote) {
                 if (this.options.unquoted === false) {
-                    this.report(event.target, `Attribute "${event.key}" using unquoted value`);
+                    const message = `Attribute "${event.key}" using unquoted value`;
+                    const context = {
+                        error: "unquoted",
+                        attr: event.key,
+                    };
+                    this.report(event.target, message, null, context);
                 }
                 return;
             }
+            /* if the style is set to any we skip the rest of the rule as the only
+             * thing that matters is if the "unquoted" options triggers an error or
+             * not */
+            if (this.style === QuoteStyle.ANY_QUOTE) {
+                return;
+            }
             const expected = this.resolveQuotemark(event.value.toString(), this.style);
             if (event.quote !== expected) {
-                this.report(event.target, `Attribute "${event.key}" used ${event.quote} instead of expected ${expected}`);
+                const message = `Attribute "${event.key}" used ${event.quote} instead of expected ${expected}`;
+                const context = {
+                    error: "style",
+                    attr: event.key,
+                    actual: event.quote,
+                    expected,
+                };
+                this.report(event.target, message, null, context);
             }
         });
     }
@@ -4260,6 +4317,8 @@ function parseStyle$4(style) {
             return QuoteStyle.DOUBLE_QUOTE;
         case "single":
             return QuoteStyle.SINGLE_QUOTE;
+        case "any":
+            return QuoteStyle.ANY_QUOTE;
         /* istanbul ignore next: covered by schema validation */
         default:
             throw new ConfigError(`Invalid style "${style}" for "attr-quotes" rule`);
@@ -4362,12 +4421,12 @@ class AttributeAllowedValues extends Rule {
     }
 }
 
-const defaults$n = {
+const defaults$o = {
     style: "omit",
 };
 class AttributeBooleanStyle extends Rule {
     constructor(options) {
-        super({ ...defaults$n, ...options });
+        super({ ...defaults$o, ...options });
         this.hasInvalidStyle = parseStyle$3(this.options.style);
     }
     static schema() {
@@ -4443,12 +4502,12 @@ function reportMessage$1(attr, style) {
     return "";
 }
 
-const defaults$m = {
+const defaults$n = {
     style: "omit",
 };
 class AttributeEmptyStyle extends Rule {
     constructor(options) {
-        super({ ...defaults$m, ...options });
+        super({ ...defaults$n, ...options });
         this.hasInvalidStyle = parseStyle$2(this.options.style);
     }
     static schema() {
@@ -4556,12 +4615,12 @@ function describePattern(pattern) {
     }
 }
 
-const defaults$l = {
+const defaults$m = {
     pattern: "kebabcase",
 };
 class ClassPattern extends Rule {
     constructor(options) {
-        super({ ...defaults$l, ...options });
+        super({ ...defaults$m, ...options });
         this.pattern = parsePattern(this.options.pattern);
     }
     static schema() {
@@ -4670,13 +4729,13 @@ class CloseOrder extends Rule {
     }
 }
 
-const defaults$k = {
+const defaults$l = {
     include: null,
     exclude: null,
 };
 class Deprecated extends Rule {
     constructor(options) {
-        super({ ...defaults$k, ...options });
+        super({ ...defaults$l, ...options });
     }
     static schema() {
         return {
@@ -4839,12 +4898,12 @@ class NoStyleTag$1 extends Rule {
     }
 }
 
-const defaults$j = {
+const defaults$k = {
     style: "uppercase",
 };
 class DoctypeStyle extends Rule {
     constructor(options) {
-        super({ ...defaults$j, ...options });
+        super({ ...defaults$k, ...options });
     }
     static schema() {
         return {
@@ -4876,12 +4935,12 @@ class DoctypeStyle extends Rule {
     }
 }
 
-const defaults$i = {
+const defaults$j = {
     style: "lowercase",
 };
 class ElementCase extends Rule {
     constructor(options) {
-        super({ ...defaults$i, ...options });
+        super({ ...defaults$j, ...options });
         this.style = new CaseStyle(this.options.style, "element-case");
     }
     static schema() {
@@ -4947,14 +5006,14 @@ class ElementCase extends Rule {
     }
 }
 
-const defaults$h = {
+const defaults$i = {
     pattern: "^[a-z][a-z0-9\\-._]*-[a-z0-9\\-._]*$",
     whitelist: [],
     blacklist: [],
 };
 class ElementName extends Rule {
     constructor(options) {
-        super({ ...defaults$h, ...options });
+        super({ ...defaults$i, ...options });
         // eslint-disable-next-line security/detect-non-literal-regexp
         this.pattern = new RegExp(this.options.pattern);
     }
@@ -4995,7 +5054,7 @@ class ElementName extends Rule {
                 ...context.blacklist.map((cur) => `- ${cur}`),
             ];
         }
-        if (context.pattern !== defaults$h.pattern) {
+        if (context.pattern !== defaults$i.pattern) {
             return [
                 `<${context.tagName}> is not a valid element name. This project is configured to only allow names matching the following regular expression:`,
                 "",
@@ -5397,7 +5456,7 @@ class EmptyTitle extends Rule {
     }
 }
 
-const defaults$g = {
+const defaults$h = {
     allowMultipleH1: false,
     minInitialRank: "h1",
     sectioningRoots: ["dialog", '[role="dialog"]'],
@@ -5428,7 +5487,7 @@ function parseMaxInitial(value) {
 }
 class HeadingLevel extends Rule {
     constructor(options) {
-        super({ ...defaults$g, ...options });
+        super({ ...defaults$h, ...options });
         this.stack = [];
         this.minInitialRank = parseMaxInitial(this.options.minInitialRank);
         this.sectionRoots = this.options.sectioningRoots.map((it) => new Pattern(it));
@@ -5586,12 +5645,12 @@ class HeadingLevel extends Rule {
     }
 }
 
-const defaults$f = {
+const defaults$g = {
     pattern: "kebabcase",
 };
 class IdPattern extends Rule {
     constructor(options) {
-        super({ ...defaults$f, ...options });
+        super({ ...defaults$g, ...options });
         this.pattern = parsePattern(this.options.pattern);
     }
     static schema() {
@@ -5942,12 +6001,12 @@ function findLabelByParent(el) {
     return [];
 }
 
-const defaults$e = {
+const defaults$f = {
     maxlength: 70,
 };
 class LongTitle extends Rule {
     constructor(options) {
-        super({ ...defaults$e, ...options });
+        super({ ...defaults$f, ...options });
         this.maxlength = this.options.maxlength;
     }
     static schema() {
@@ -6094,13 +6153,13 @@ class MultipleLabeledControls extends Rule {
     }
 }
 
-const defaults$d = {
+const defaults$e = {
     include: null,
     exclude: null,
 };
 class NoAutoplay extends Rule {
     constructor(options) {
-        super({ ...defaults$d, ...options });
+        super({ ...defaults$e, ...options });
     }
     documentation(context) {
         const tagName = context ? ` on <${context.tagName}>` : "";
@@ -6341,14 +6400,14 @@ Omitted end tags can be ambigious for humans to read and many editors have troub
     }
 }
 
-const defaults$c = {
+const defaults$d = {
     include: null,
     exclude: null,
     allowedProperties: ["display"],
 };
 class NoInlineStyle extends Rule {
     constructor(options) {
-        super({ ...defaults$c, ...options });
+        super({ ...defaults$d, ...options });
     }
     static schema() {
         return {
@@ -6550,7 +6609,7 @@ class NoMultipleMain extends Rule {
     }
 }
 
-const defaults$b = {
+const defaults$c = {
     relaxed: false,
 };
 const textRegexp = /([<>]|&(?![a-zA-Z0-9#]+;))/g;
@@ -6567,7 +6626,7 @@ const replacementTable = {
 };
 class NoRawCharacters extends Rule {
     constructor(options) {
-        super({ ...defaults$b, ...options });
+        super({ ...defaults$c, ...options });
         this.relaxed = this.options.relaxed;
     }
     static schema() {
@@ -6745,13 +6804,13 @@ class NoRedundantRole extends Rule {
 }
 
 const xmlns = /^(.+):.+$/;
-const defaults$a = {
+const defaults$b = {
     ignoreForeign: true,
     ignoreXML: true,
 };
 class NoSelfClosing extends Rule {
     constructor(options) {
-        super({ ...defaults$a, ...options });
+        super({ ...defaults$b, ...options });
     }
     static schema() {
         return {
@@ -6884,13 +6943,13 @@ const replacement = {
     reset: '<button type="reset">',
     image: '<button type="button">',
 };
-const defaults$9 = {
+const defaults$a = {
     include: null,
     exclude: null,
 };
 class PreferButton extends Rule {
     constructor(options) {
-        super({ ...defaults$9, ...options });
+        super({ ...defaults$a, ...options });
     }
     static schema() {
         return {
@@ -6965,7 +7024,7 @@ class PreferButton extends Rule {
     }
 }
 
-const defaults$8 = {
+const defaults$9 = {
     mapping: {
         article: "article",
         banner: "header",
@@ -6995,7 +7054,7 @@ const defaults$8 = {
 };
 class PreferNativeElement extends Rule {
     constructor(options) {
-        super({ ...defaults$8, ...options });
+        super({ ...defaults$9, ...options });
     }
     static schema() {
         return {
@@ -7115,8 +7174,66 @@ class PreferTbody extends Rule {
     }
 }
 
+const defaults$8 = {
+    tags: ["script", "style"],
+};
+class RequireCSPNonce extends Rule {
+    constructor(options) {
+        super({ ...defaults$8, ...options });
+    }
+    static schema() {
+        return {
+            tags: {
+                type: "array",
+                items: {
+                    enum: ["script", "style"],
+                    type: "string",
+                },
+            },
+        };
+    }
+    documentation() {
+        return {
+            description: [
+                "Required Content-Security-Policy (CSP) nonce is missing or empty.",
+                "",
+                "This is set by the `nonce` attribute and must match the `Content-Security-Policy` header.",
+                "For instance, if the header contains `script-src 'nonce-r4nd0m'` the `nonce` attribute must be set to `nonce=\"r4nd0m\">`",
+                "",
+                "The nonce should be unique per each request and set to a cryptography secure random token.",
+                "It is used to prevent cross site scripting (XSS) by preventing malicious actors from injecting scripts onto the page.",
+            ].join("\n"),
+            url: ruleDocumentationUrl("@/rules/require-csp-nonce.ts"),
+        };
+    }
+    setup() {
+        this.on("tag:end", (event) => {
+            var _a;
+            const { tags } = this.options;
+            const node = event.previous;
+            /* ignore other tags */
+            if (!node || !tags.includes(node.tagName)) {
+                return;
+            }
+            /* ignore if nonce is set to non-empty value (or dynamic) */
+            const nonce = (_a = node.getAttribute("nonce")) === null || _a === void 0 ? void 0 : _a.value;
+            if (nonce && nonce !== "") {
+                return;
+            }
+            /* ignore <script src> */
+            if (node.is("script") && node.hasAttribute("src")) {
+                return;
+            }
+            const message = `required CSP nonce is missing`;
+            this.report(node, message, node.location);
+        });
+    }
+}
+
 const defaults$7 = {
     target: "all",
+    include: null,
+    exclude: null,
 };
 const crossorigin = new RegExp("^(\\w+://|//)"); /* e.g. https:// or // */
 const supportSri = {
@@ -7134,6 +7251,32 @@ class RequireSri extends Rule {
                 enum: ["all", "crossorigin"],
                 type: "string",
             },
+            include: {
+                anyOf: [
+                    {
+                        items: {
+                            type: "string",
+                        },
+                        type: "array",
+                    },
+                    {
+                        type: "null",
+                    },
+                ],
+            },
+            exclude: {
+                anyOf: [
+                    {
+                        items: {
+                            type: "string",
+                        },
+                        type: "array",
+                    },
+                    {
+                        type: "null",
+                    },
+                ],
+            },
         };
     }
     documentation() {
@@ -7146,11 +7289,13 @@ class RequireSri extends Rule {
         this.on("tag:end", (event) => {
             /* only handle thats supporting and requires sri */
             const node = event.previous;
-            if (!(this.supportSri(node) && this.needSri(node)))
+            if (!(this.supportSri(node) && this.needSri(node))) {
                 return;
+            }
             /* check if sri attribute is present */
-            if (node.hasAttribute("integrity"))
+            if (node.hasAttribute("integrity")) {
                 return;
+            }
             this.report(node, `SRI "integrity" attribute is required on <${node.tagName}> element`, node.location);
         });
     }
@@ -7158,19 +7303,25 @@ class RequireSri extends Rule {
         return Object.keys(supportSri).includes(node.tagName);
     }
     needSri(node) {
-        if (this.target === "all")
-            return true;
         const attr = this.elementSourceAttr(node);
-        if (!attr || attr.value === null || attr.isDynamic) {
+        if (!attr || attr.value === null || attr.value === "" || attr.isDynamic) {
             return false;
         }
         const url = attr.value.toString();
-        return crossorigin.test(url);
+        if (this.target === "all" || crossorigin.test(url)) {
+            return !this.isIgnored(url);
+        }
+        return false;
     }
     elementSourceAttr(node) {
         const key = supportSri[node.tagName];
         return node.getAttribute(key);
     }
+    isIgnored(url) {
+        return this.isKeywordIgnored(url, (list, it) => {
+            return list.some((pattern) => it.includes(pattern));
+        });
+    }
 }
 
 class ScriptElement extends Rule {
@@ -9968,6 +10119,7 @@ const bundledRules = {
     "prefer-button": PreferButton,
     "prefer-native-element": PreferNativeElement,
     "prefer-tbody": PreferTbody,
+    "require-csp-nonce": RequireCSPNonce,
     "require-sri": RequireSri,
     "script-element": ScriptElement,
     "script-type": ScriptType,