@html-eslint/eslint-plugin 0.16.0 → 0.17.0

package/lib/rules/index.js

@@ -29,6 +29,7 @@ const noMultipleEmptyLines = require("./no-multiple-empty-lines");
 const noAccesskeyAttrs = require("./no-accesskey-attrs");
 const noRestrictedAttrs = require("./no-restricted-attrs");
 const noTrailingSpaces = require("./no-trailing-spaces");
+const requireAttrs = require("./require-attrs");
 
 module.exports = {
   "require-lang": requireLang,
@@ -46,6 +47,7 @@ module.exports = {
   quotes: quotes,
   "id-naming-convention": idNamingConvention,
   "no-obsolete-tags": noObsoleteTags,
+  "require-attrs": requireAttrs,
   "require-closing-tags": requireClosingTags,
   "require-meta-description": requireMetaDescription,
   "require-frame-title": requireFrameTitle,

package/lib/rules/require-attrs.js

@@ -0,0 +1,110 @@
+/**
+ * @typedef {import("../types").Rule} Rule
+ */
+
+const { RULE_CATEGORY } = require("../constants");
+
+const MESSAGE_IDS = {
+  MISSING: "missing",
+  UNEXPECTED: "unexpected",
+};
+
+/**
+ * @type {Rule}
+ */
+module.exports = {
+  meta: {
+    type: "code",
+
+    docs: {
+      description: "Require specified attributes",
+      category: RULE_CATEGORY.BEST_PRACTICE,
+      recommended: false,
+    },
+    fixable: null,
+    schema: {
+      type: "array",
+      items: {
+        type: "object",
+        properties: {
+          tag: { type: "string" },
+          attr: { type: "string" },
+          value: { type: "string" },
+        },
+        required: ["tag", "attr"],
+        additionalProperties: false,
+      },
+    },
+    messages: {
+      [MESSAGE_IDS.MISSING]: "Missing '{{attr}}' attributes for '{{tag}}' tag",
+      [MESSAGE_IDS.UNEXPECTED]:
+        "Unexpected '{{attr}}' attributes value. '{{expected}}' is expected",
+    },
+  },
+
+  create(context) {
+    const options = context.options || [];
+    const tagOptionsMap = new Map();
+
+    options.forEach((option) => {
+      const tagName = option.tag.toLowerCase();
+      if (tagOptionsMap.has(tagName)) {
+        tagOptionsMap.set(tagName, [...tagOptionsMap.get(tagName), option]);
+      } else {
+        tagOptionsMap.set(tagName, [option]);
+      }
+    });
+
+    function check(node, tagName) {
+      const tagOptions = tagOptionsMap.get(tagName);
+      const attributes = node.attributes || [];
+
+      tagOptions.forEach((option) => {
+        const attrName = option.attr;
+        const attr = attributes.find(
+          (attr) => attr.key && attr.key.value === attrName
+        );
+        if (!attr) {
+          context.report({
+            messageId: MESSAGE_IDS.MISSING,
+            node,
+            data: {
+              attr: attrName,
+              tag: tagName,
+            },
+          });
+        } else if (
+          attr.value &&
+          typeof option.value === "string" &&
+          attr.value.value !== option.value
+        ) {
+          context.report({
+            messageId: MESSAGE_IDS.UNEXPECTED,
+            node: attr,
+            data: {
+              attr: attrName,
+              expected: option.value,
+            },
+          });
+        }
+      });
+    }
+
+    return {
+      [["StyleTag", "ScriptTag"].join(",")](node) {
+        const tagName = node.type === "StyleTag" ? "style" : "script";
+        if (!tagOptionsMap.has(tagName)) {
+          return;
+        }
+        check(node, tagName);
+      },
+      Tag(node) {
+        const tagName = node.name.toLowerCase();
+        if (!tagOptionsMap.has(tagName)) {
+          return;
+        }
+        check(node, tagName);
+      },
+    };
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@html-eslint/eslint-plugin",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "description": "ESLint plugin for html",
   "author": "yeonjuan",
   "homepage": "https://github.com/yeonjuan/html-eslint#readme",
@@ -40,11 +40,11 @@
     "accessibility"
   ],
   "devDependencies": {
-    "@html-eslint/parser": "^0.16.0",
+    "@html-eslint/parser": "^0.17.0",
     "@types/eslint": "^7.2.10",
     "@types/estree": "^0.0.47",
     "es-html-parser": "^0.0.8",
     "typescript": "^4.4.4"
   },
-  "gitHead": "a866203b2c65d63b3f101b16c8d7d1a3bde32c75"
+  "gitHead": "4ff87ae244278c889699622cba70400595ea069d"
 }