html-validate 10.8.0 → 10.9.0

package/dist/cjs/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.56.3"
+      "packageVersion": "7.57.2"
     }
   ]
 }

package/dist/esm/core.js

@@ -3999,7 +3999,7 @@ class Rule {
   }
 }
 
-const defaults$A = {
+const defaults$B = {
   allowExternal: true,
   allowRelative: true,
   allowAbsolute: true,
@@ -4043,7 +4043,7 @@ class AllowedLinks extends Rule {
   allowRelative;
   allowAbsolute;
   constructor(options) {
-    super({ ...defaults$A, ...options });
+    super({ ...defaults$B, ...options });
     this.allowExternal = parseAllow(this.options.allowExternal);
     this.allowRelative = parseAllow(this.options.allowRelative);
     this.allowAbsolute = parseAllow(this.options.allowAbsolute);
@@ -4211,7 +4211,7 @@ class AllowedLinks extends Rule {
   }
 }
 
-const defaults$z = {
+const defaults$A = {
   accessible: true
 };
 function findByTarget(target, siblings) {
@@ -4241,7 +4241,7 @@ function getDescription$1(context) {
 }
 class AreaAlt extends Rule {
   constructor(options) {
-    super({ ...defaults$z, ...options });
+    super({ ...defaults$A, ...options });
   }
   static schema() {
     return {
@@ -4320,7 +4320,7 @@ class AriaHiddenBody extends Rule {
   }
 }
 
-const defaults$y = {
+const defaults$z = {
   allowAnyNamable: false,
   elements: {
     include: null,
@@ -4368,7 +4368,7 @@ function isValidUsage(target, meta) {
 }
 class AriaLabelMisuse extends Rule {
   constructor(options) {
-    super({ ...defaults$y, ...options });
+    super({ ...defaults$z, ...options });
   }
   static schema() {
     return {
@@ -4537,14 +4537,14 @@ class CaseStyle {
   }
 }
 
-const defaults$x = {
+const defaults$y = {
   style: "lowercase",
   ignoreForeign: true
 };
 class AttrCase extends Rule {
   style;
   constructor(options) {
-    super({ ...defaults$x, ...options });
+    super({ ...defaults$y, ...options });
     this.style = new CaseStyle(this.options.style, "attr-case");
   }
   static schema() {
@@ -4949,7 +4949,7 @@ class AttrDelimiter extends Rule {
 }
 
 const DEFAULT_PATTERN = "[a-z0-9-:]+";
-const defaults$w = {
+const defaults$x = {
   pattern: DEFAULT_PATTERN,
   ignoreForeign: true
 };
@@ -4982,7 +4982,7 @@ function generateDescription(name, pattern) {
 class AttrPattern extends Rule {
   pattern;
   constructor(options) {
-    super({ ...defaults$w, ...options });
+    super({ ...defaults$x, ...options });
     this.pattern = generateRegexp(this.options.pattern);
   }
   static schema() {
@@ -5029,7 +5029,7 @@ class AttrPattern extends Rule {
   }
 }
 
-const defaults$v = {
+const defaults$w = {
   style: "auto",
   unquoted: false
 };
@@ -5095,7 +5095,7 @@ class AttrQuotes extends Rule {
     };
   }
   constructor(options) {
-    super({ ...defaults$v, ...options });
+    super({ ...defaults$w, ...options });
     this.style = parseStyle$3(this.options.style);
   }
   setup() {
@@ -5251,13 +5251,13 @@ class AttributeAllowedValues extends Rule {
   }
 }
 
-const defaults$u = {
+const defaults$v = {
   style: "omit"
 };
 class AttributeBooleanStyle extends Rule {
   hasInvalidStyle;
   constructor(options) {
-    super({ ...defaults$u, ...options });
+    super({ ...defaults$v, ...options });
     this.hasInvalidStyle = parseStyle$2(this.options.style);
   }
   static schema() {
@@ -5327,13 +5327,13 @@ function reportMessage$1(attr, style) {
   return "";
 }
 
-const defaults$t = {
+const defaults$u = {
   style: "omit"
 };
 class AttributeEmptyStyle extends Rule {
   hasInvalidStyle;
   constructor(options) {
-    super({ ...defaults$t, ...options });
+    super({ ...defaults$u, ...options });
     this.hasInvalidStyle = parseStyle$1(this.options.style);
   }
   static schema() {
@@ -5450,7 +5450,7 @@ class AttributeMisuse extends Rule {
   }
 }
 
-const defaults$s = {
+const defaults$t = {
   preferred: void 0
 };
 function isPasswordInput(event) {
@@ -5467,7 +5467,7 @@ function isGroupingToken(token) {
 class AutocompletePassword extends Rule {
   preferred;
   constructor(options) {
-    super({ ...defaults$s, ...options });
+    super({ ...defaults$t, ...options });
     this.preferred = options.preferred?.toLowerCase();
   }
   static schema() {
@@ -5697,7 +5697,7 @@ class BasePatternRule extends Rule {
   }
 }
 
-const defaults$r = {
+const defaults$s = {
   pattern: "kebabcase"
 };
 class ClassPattern extends BasePatternRule {
@@ -5705,7 +5705,7 @@ class ClassPattern extends BasePatternRule {
     super({
       ruleId: "class-pattern",
       attr: "class",
-      options: { ...defaults$r, ...options },
+      options: { ...defaults$s, ...options },
       allowedPatterns: patternNames
       // allow all patterns
     });
@@ -5855,13 +5855,13 @@ class CloseOrder extends Rule {
   }
 }
 
-const defaults$q = {
+const defaults$r = {
   include: null,
   exclude: null
 };
 class Deprecated extends Rule {
   constructor(options) {
-    super({ ...defaults$q, ...options });
+    super({ ...defaults$r, ...options });
   }
   static schema() {
     return {
@@ -5969,6 +5969,137 @@ function prettySource(source) {
   }
 }
 
+function quote(value, char = '"') {
+  return `${char}${value}${char}`;
+}
+
+const defaults$q = {
+  classes: []
+};
+function isRelevant$6(event) {
+  return event.key.toLowerCase() === "class";
+}
+function normalizeEntry(entry) {
+  const { class: className, message, replacement = [], url } = entry;
+  return {
+    class: className,
+    message,
+    replacement: Array.isArray(replacement) ? replacement : [replacement],
+    url
+  };
+}
+function formatDeprecatedMessage(className, entry) {
+  let message = `class "${className}" is deprecated`;
+  if (entry.replacement.length > 0) {
+    const joined = naturalJoin(
+      entry.replacement.map((r) => quote(r)),
+      "or"
+    );
+    message += ` and replaced with ${joined}`;
+  }
+  if (entry.message) {
+    message += `: ${entry.message}`;
+  }
+  return message;
+}
+function formatDocumentationDescription(context) {
+  const text = [];
+  const className = context.class;
+  let description = `The class \`${className}\` is deprecated and should not be used`;
+  if (context.message) {
+    description += `: ${context.message}.`;
+  } else {
+    description += ".";
+  }
+  text.push(description);
+  if (context.replacement.length === 1) {
+    text.push(`Use the replacement class ${quote(context.replacement[0], "`")} instead.`);
+  } else if (context.replacement.length > 1) {
+    const listItems = context.replacement.map((r) => `- ${quote(r, "`")}`);
+    text.push(`Use one of the following replacement classes instead:
+${listItems.join("\n")}`);
+  }
+  if (context.url) {
+    text.push(`For details see: ${context.url}`);
+  }
+  return text.join("\n\n");
+}
+class DeprecatedClass extends Rule {
+  deprecatedMap;
+  constructor(options) {
+    super({ ...defaults$q, ...options });
+    const { classes } = this.options;
+    this.deprecatedMap = new Map(classes.map((entry) => [entry.class, normalizeEntry(entry)]));
+  }
+  static schema() {
+    return {
+      classes: {
+        type: "array",
+        items: {
+          type: "object",
+          properties: {
+            class: {
+              type: "string"
+            },
+            message: {
+              type: "string"
+            },
+            replacement: {
+              anyOf: [
+                {
+                  type: "string"
+                },
+                {
+                  type: "array",
+                  items: {
+                    type: "string"
+                  }
+                }
+              ]
+            },
+            url: {
+              type: "string"
+            }
+          },
+          required: ["class"],
+          additionalProperties: false
+        }
+      }
+    };
+  }
+  documentation(context) {
+    return {
+      description: formatDocumentationDescription(context),
+      url: "https://html-validate.org/rules/deprecated-class.html"
+    };
+  }
+  setup() {
+    this.on("attr", isRelevant$6, (event) => {
+      const { value, valueLocation, target } = event;
+      const classes = new DOMTokenList(value, valueLocation);
+      for (const { item, location } of classes.iterator()) {
+        const deprecatedEntry = this.deprecatedMap.get(item);
+        if (!deprecatedEntry) {
+          continue;
+        }
+        const message = formatDeprecatedMessage(item, deprecatedEntry);
+        const context = {
+          class: item,
+          message: deprecatedEntry.message ?? null,
+          replacement: deprecatedEntry.replacement,
+          url: deprecatedEntry.url ?? null
+        };
+        this.report({
+          node: target,
+          message,
+          location,
+          context
+        });
+      }
+    });
+  }
+}
+
 class DeprecatedRule extends Rule {
   documentation(context) {
     const preamble = context ? `The rule "${context}"` : "This rule";
@@ -10909,6 +11040,7 @@ const bundledRules = {
   "close-attr": CloseAttr,
   "close-order": CloseOrder,
   deprecated: Deprecated,
+  "deprecated-class": DeprecatedClass,
   "deprecated-rule": DeprecatedRule,
   "doctype-html": NoStyleTag$1,
   "doctype-style": DoctypeStyle,
@@ -12285,7 +12417,7 @@ class EventHandler {
 }
 
 const name = "html-validate";
-const version = "10.8.0";
+const version = "10.9.0";
 const bugs = "https://gitlab.com/html-validate/html-validate/issues/new";
 
 function freeze(src) {