@html-eslint/eslint-plugin 0.19.1 → 0.20.0

package/lib/rules/index.js

@@ -30,6 +30,7 @@ const noAccesskeyAttrs = require("./no-accesskey-attrs");
 const noRestrictedAttrs = require("./no-restricted-attrs");
 const noTrailingSpaces = require("./no-trailing-spaces");
 const requireAttrs = require("./require-attrs");
+const noRestrictedAttrValues = require("./no-restricted-attr-values");
 
 module.exports = {
   "require-lang": requireLang,
@@ -64,4 +65,5 @@ module.exports = {
   "no-accesskey-attrs": noAccesskeyAttrs,
   "no-restricted-attrs": noRestrictedAttrs,
   "no-trailing-spaces": noTrailingSpaces,
+  "no-restricted-attr-values": noRestrictedAttrValues,
 };

package/lib/rules/no-restricted-attr-values.js

@@ -0,0 +1,141 @@
+/**
+ * @typedef {import("../types").Rule} Rule
+ * @typedef {{attrPatterns: string[], attrValuePatterns: string[], message?: string}[]} Options
+ */
+
+const { RULE_CATEGORY } = require("../constants");
+
+const MESSAGE_IDS = {
+  RESTRICTED: "restricted",
+};
+
+/**
+ * @type {Rule}
+ */
+module.exports = {
+  meta: {
+    type: "code",
+
+    docs: {
+      description: "Disallow specified attributes",
+      category: RULE_CATEGORY.BEST_PRACTICE,
+      recommended: false,
+    },
+
+    fixable: null,
+    schema: {
+      type: "array",
+
+      items: {
+        type: "object",
+        required: ["attrPatterns", "attrValuePatterns"],
+        properties: {
+          attrPatterns: {
+            type: "array",
+            items: {
+              type: "string",
+            },
+          },
+          attrValuePatterns: {
+            type: "array",
+            items: {
+              type: "string",
+            },
+          },
+          message: {
+            type: "string",
+          },
+        },
+      },
+    },
+    messages: {
+      [MESSAGE_IDS.RESTRICTED]:
+        "'{{attrValuePatterns}}' is restricted from being used.",
+    },
+  },
+
+  create(context) {
+    /**
+     * @type {Options}
+     */
+    const options = context.options;
+    const checkers = options.map((option) => new PatternChecker(option));
+
+    return {
+      [["Tag", "StyleTag", "ScriptTag"].join(",")](node) {
+        node.attributes.forEach((attr) => {
+          if (
+            !attr.key ||
+            !attr.key.value ||
+            !attr.value ||
+            typeof attr.value.value !== "string"
+          ) {
+            return;
+          }
+
+          const matched = checkers.find((checker) =>
+            checker.test(attr.key.value, attr.value.value)
+          );
+
+          if (!matched) {
+            return;
+          }
+
+          const result = {
+            node: attr,
+            message: "",
+          };
+
+          const customMessage = matched.getMessage();
+
+          if (customMessage) {
+            result.message = customMessage;
+          } else {
+            result.messageId = MESSAGE_IDS.RESTRICTED;
+          }
+
+          context.report({
+            ...result,
+            data: { attrValuePatterns: attr.value.value },
+          });
+        });
+      },
+    };
+  },
+};
+
+class PatternChecker {
+  /**
+   * @param {Options[number]} option
+   */
+  constructor(option) {
+    this.option = option;
+    this.attrRegExps = option.attrPatterns.map(
+      (pattern) => new RegExp(pattern, "u")
+    );
+
+    this.valueRegExps = option.attrValuePatterns.map(
+      (pattern) => new RegExp(pattern, "u")
+    );
+    this.message = option.message;
+  }
+
+  /**
+   * @param {string} attrName
+   * @param {string} attrValue
+   * @returns {boolean}
+   */
+  test(attrName, attrValue) {
+    const result =
+      this.attrRegExps.some((exp) => exp.test(attrName)) &&
+      this.valueRegExps.some((exp) => exp.test(attrValue));
+    return result;
+  }
+
+  /**
+   * @returns {string}
+   */
+  getMessage() {
+    return this.message || "";
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@html-eslint/eslint-plugin",
-  "version": "0.19.1",
+  "version": "0.20.0",
   "description": "ESLint plugin for html",
   "author": "yeonjuan",
   "homepage": "https://github.com/yeonjuan/html-eslint#readme",
@@ -22,13 +22,14 @@
   },
   "scripts": {
     "test": "jest --coverage",
-    "check:ts": "tsc"
+    "check:ts": "tsc",
+    "lint": "eslint . --ext .js"
   },
   "bugs": {
     "url": "https://github.com/yeonjuan/html-eslint/issues"
   },
   "engines": {
-    "node": ">=8.10.0"
+    "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
   },
   "keywords": [
     "eslint",
@@ -40,11 +41,11 @@
     "accessibility"
   ],
   "devDependencies": {
-    "@html-eslint/parser": "^0.19.1",
+    "@html-eslint/parser": "^0.20.0",
     "@types/eslint": "^7.2.10",
     "@types/estree": "^0.0.47",
     "es-html-parser": "^0.0.8",
     "typescript": "^4.4.4"
   },
-  "gitHead": "f016ce5084fa1e348a199cd9cc27079a587e60d4"
+  "gitHead": "ac1a79f12abdce059a1b0e046cf87ea8e5c34291"
 }