@html-eslint/eslint-plugin 0.20.0 → 0.22.0

package/lib/constants/index.js

@@ -1,10 +1,8 @@
-const NODE_TYPES = require("./node-types");
 const RULE_CATEGORY = require("./rule-category");
 const OBSOLETE_TAGS = require("./obsolete-tags");
 const VOID_ELEMENTS = require("./void-elements");
 
 module.exports = {
-  NODE_TYPES,
   RULE_CATEGORY,
   OBSOLETE_TAGS,
   VOID_ELEMENTS,

package/lib/rules/element-newline.js

@@ -5,6 +5,9 @@ const MESSAGE_IDS = {
   EXPECT_NEW_LINE_BEFORE: "expectBefore",
 };
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",
@@ -40,9 +43,10 @@ module.exports = {
   create(context) {
     const option = context.options[0] || { skip: [] };
     const skipTags = option.skip;
-
-    let isInSkipTags = false;
-
+    let skipTagCount = 0;
+    /**
+     * @param {ChildType<TagNode | ProgramNode>[]} siblings
+     */
     function checkSiblings(siblings) {
       siblings
         .filter((node) => node.type !== "Text")
@@ -53,6 +57,7 @@ module.exports = {
               context.report({
                 node: current,
                 messageId: MESSAGE_IDS.EXPECT_NEW_LINE_AFTER,
+                // @ts-ignore
                 data: { tag: `<${current.name}>` },
                 fix(fixer) {
                   return fixer.insertTextAfter(current, "\n");
@@ -63,6 +68,10 @@ module.exports = {
         });
     }
 
+    /**
+     * @param {TagNode} node
+     * @param {ChildType<TagNode>[]} children
+     */
     function checkChild(node, children) {
       const targetChildren = children.filter((n) => n.type !== "Text");
       const first = targetChildren[0];
@@ -94,22 +103,27 @@ module.exports = {
       }
     }
     return {
-      [["Tag", "Program"].join(",")](node) {
-        if (isInSkipTags) {
+      Program(node) {
+        checkSiblings(node.body);
+      },
+      Tag(node) {
+        if (skipTagCount > 0) {
           return;
         }
-
-        const children = node.type === "Program" ? node.body : node.children;
-        checkSiblings(children);
         if (skipTags.includes(node.name)) {
-          isInSkipTags = true;
+          skipTagCount++;
           return;
         }
-        checkChild(node, children);
+        checkSiblings(node.children);
+        checkChild(node, node.children);
       },
+      /**
+       * @param {TagNode} node
+       * @returns
+       */
       "Tag:exit"(node) {
         if (skipTags.includes(node.name)) {
-          isInSkipTags = false;
+          skipTagCount--;
           return;
         }
       },
@@ -117,6 +131,11 @@ module.exports = {
   },
 };
 
+/**
+ * @param {BaseNode} nodeBefore
+ * @param {BaseNode} nodeAfter
+ * @returns
+ */
 function isOnTheSameLine(nodeBefore, nodeAfter) {
   if (nodeBefore && nodeAfter) {
     return nodeBefore.loc.end.line === nodeAfter.loc.start.line;

package/lib/rules/id-naming-convention.js

@@ -1,9 +1,11 @@
-/**
- * @typedef {import("../types").Rule} Rule
- */
-
 const { RULE_CATEGORY } = require("../constants");
-const { NamingUtils, NodeUtils } = require("./utils");
+const {
+  isCamelCase,
+  isSnakeCase,
+  isPascalCase,
+  isKebabCase,
+} = require("./utils/naming");
+const { findAttr } = require("./utils/node");
 
 const MESSAGE_IDS = {
   WRONG: "wrong",
@@ -14,13 +16,14 @@ const CONVENTIONS = {
   SNAKE_CASE: "snake_case",
   PASCAL_CASE: "PascalCase",
   KEBAB_CASE: "kebab-case",
+  REGEX: "regex",
 };
 
 const CONVENTION_CHECKERS = {
-  [CONVENTIONS.CAMEL_CASE]: NamingUtils.isCamelCase,
-  [CONVENTIONS.SNAKE_CASE]: NamingUtils.isSnakeCase,
-  [CONVENTIONS.PASCAL_CASE]: NamingUtils.isPascalCase,
-  [CONVENTIONS.KEBAB_CASE]: NamingUtils.isKebabCase,
+  [CONVENTIONS.CAMEL_CASE]: isCamelCase,
+  [CONVENTIONS.SNAKE_CASE]: isSnakeCase,
+  [CONVENTIONS.PASCAL_CASE]: isPascalCase,
+  [CONVENTIONS.KEBAB_CASE]: isKebabCase,
 };
 
 /**
@@ -41,6 +44,13 @@ module.exports = {
       {
         enum: Object.values(CONVENTIONS),
       },
+      {
+        type: "object",
+        properties: {
+          pattern: { type: "string" },
+        },
+        additionalProperties: false,
+      },
     ],
     messages: {
       [MESSAGE_IDS.WRONG]:
@@ -54,14 +64,22 @@ module.exports = {
         ? context.options[0]
         : CONVENTIONS.SNAKE_CASE;
 
-    const checkNaming = CONVENTION_CHECKERS[convention];
+    const checkNaming =
+      convention === CONVENTIONS.REGEX
+        ? (/** @type string */ name) =>
+            new RegExp(context.options[1].pattern).test(name)
+        : CONVENTION_CHECKERS[convention];
 
     return {
-      "*"(node) {
+      /**
+       * @param {TagNode | ScriptTagNode | StyleTagNode} node
+       * @returns
+       */
+      [["Tag", "ScriptTag", "StyleTag"].join(",")](node) {
         if (!node.attributes || node.attributes.length <= 0) {
           return;
         }
-        const idAttr = NodeUtils.findAttr(node, "id");
+        const idAttr = findAttr(node, "id");
         if (idAttr && idAttr.value && !checkNaming(idAttr.value.value)) {
           context.report({
             node: idAttr,

package/lib/rules/indent.js

@@ -1,11 +1,4 @@
 /**
- * @typedef {import("../types").Rule} Rule
- * @typedef {import("../types").TagNode} TagNode
- * @typedef {import("../types").BaseNode} BaseNode
- * @typedef {import("../types").OpenTagStartNode} OpenTagStartNode
- * @typedef {import("../types").CloseTagNode} CloseTagNode
- * @typedef {import("../types").LineNode} LineNode
- *@typedef {import("../types").AnyNode} AnyNode
  * @typedef {Object} IndentType
  * @property {"tab"} TAB
  * @property {"space"} SPACE
@@ -13,8 +6,9 @@
  * @typedef {Object} MessageId
  * @property {"wrongIndent"} WRONG_INDENT
  */
+
 const { RULE_CATEGORY } = require("../constants");
-const { NodeUtils } = require("./utils");
+const { splitToLineNodes } = require("./utils/node");
 
 /** @type {MessageId} */
 const MESSAGE_ID = {
@@ -234,6 +228,9 @@ module.exports = {
       OpenTagStart: checkIndent,
       OpenTagEnd: checkIndent,
       CloseTag: checkIndent,
+      /**
+       * @param {TagNode} node
+       */
       "Tag:exit"(node) {
         if (IGNORING_NODES.includes(node.name)) {
           parentIgnoringChildCount--;
@@ -250,7 +247,7 @@ module.exports = {
       // Text
       Text(node) {
         indent();
-        const lineNodes = NodeUtils.splitToLineNodes(node);
+        const lineNodes = splitToLineNodes(node);
         lineNodes.forEach((lineNode) => {
           if (lineNode.value.trim().length) {
             checkIndent(lineNode);
@@ -264,7 +261,7 @@ module.exports = {
       CommentOpen: checkIndent,
       CommentContent(node) {
         indent();
-        const lineNodes = NodeUtils.splitToLineNodes(node);
+        const lineNodes = splitToLineNodes(node);
         lineNodes.forEach((lineNode) => {
           if (lineNode.value.trim().length) {
             checkIndent(lineNode);

package/lib/rules/index.js

@@ -31,6 +31,10 @@ const noRestrictedAttrs = require("./no-restricted-attrs");
 const noTrailingSpaces = require("./no-trailing-spaces");
 const requireAttrs = require("./require-attrs");
 const noRestrictedAttrValues = require("./no-restricted-attr-values");
+const noScriptStyleType = require("./no-script-style-type");
+const lowercase = require("./lowercase");
+const requireOpenGraphProtocol = require("./require-open-graph-protocol");
+const sortAttrs = require("./sort-attrs");
 
 module.exports = {
   "require-lang": requireLang,
@@ -66,4 +70,8 @@ module.exports = {
   "no-restricted-attrs": noRestrictedAttrs,
   "no-trailing-spaces": noTrailingSpaces,
   "no-restricted-attr-values": noRestrictedAttrValues,
+  "no-script-style-type": noScriptStyleType,
+  lowercase: lowercase,
+  "require-open-graph-protocol": requireOpenGraphProtocol,
+  "sort-attrs": sortAttrs,
 };

package/lib/rules/lowercase.js

@@ -0,0 +1,93 @@
+const { NODE_TYPES } = require("@html-eslint/parser");
+const { RULE_CATEGORY } = require("../constants");
+
+const MESSAGE_IDS = {
+  UNEXPECTED: "unexpected",
+};
+
+/**
+ * @type {Rule}
+ */
+module.exports = {
+  meta: {
+    type: "suggestion",
+
+    docs: {
+      description: "Enforce to use lowercase for tag and attribute names.",
+      category: RULE_CATEGORY.STYLE,
+      recommended: false,
+    },
+
+    fixable: "code",
+    schema: [],
+    messages: {
+      [MESSAGE_IDS.UNEXPECTED]: "'{{name}}' is not in lowercase.",
+    },
+  },
+
+  create(context) {
+    /**
+     * @param {TagNode | StyleTagNode | ScriptTagNode} node
+     */
+    function nameOf(node) {
+      if (node.type === NODE_TYPES.ScriptTag) return "script";
+      if (node.type === NODE_TYPES.StyleTag) return "style";
+      return node.name;
+    }
+
+    /**
+     * @param {TagNode | StyleTagNode | ScriptTagNode} node
+     */
+    function check(node) {
+      const raw = node.openStart.value.slice(1);
+      if (nameOf(node) !== raw) {
+        context.report({
+          node: node.openStart,
+          messageId: MESSAGE_IDS.UNEXPECTED,
+          data: {
+            name: raw,
+          },
+          fix(fixer) {
+            const name = nameOf(node);
+            const fixes = [
+              fixer.replaceTextRange(node.openStart.range, `<${name}`),
+            ];
+
+            if (node.close) {
+              fixes.push(
+                fixer.replaceTextRange(node.close.range, `</${name}>`)
+              );
+            }
+
+            return fixes;
+          },
+        });
+      }
+      if (node.attributes && node.attributes.length) {
+        node.attributes.forEach((attribute) => {
+          if (attribute.key.value !== attribute.key.value.toLowerCase()) {
+            context.report({
+              node: attribute.key,
+              messageId: MESSAGE_IDS.UNEXPECTED,
+              data: {
+                name: attribute.key.value,
+              },
+              fix(fixer) {
+                return fixer.replaceText(
+                  attribute.key,
+                  attribute.key.value.toLowerCase()
+                );
+              },
+            });
+          }
+        });
+      }
+    }
+
+    return {
+      Tag: check,
+      StyleTag: check,
+      ScriptTag: check,
+    };
+  },
+};

package/lib/rules/no-abstract-roles.js

@@ -1,9 +1,5 @@
-/**
- * @typedef {import("../types").Rule} Rule
- */
-
 const { RULE_CATEGORY } = require("../constants");
-const { NodeUtils } = require("./utils");
+const { findAttr } = require("./utils/node");
 
 const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
@@ -46,15 +42,21 @@ module.exports = {
 
   create(context) {
     return {
+      /**
+       *
+       * @param {TagNode | ScriptTagNode | StyleTagNode} node
+       */
       [["Tag", "ScriptTag", "StyleTag"].join(",")](node) {
-        const roleAttr = NodeUtils.findAttr(node, "role");
-        if (roleAttr) {
-          if (roleAttr.value && ABSTRACT_ROLE_SET.has(roleAttr.value.value)) {
-            context.report({
-              messageId: MESSAGE_IDS.UNEXPECTED,
-              node: roleAttr,
-            });
-          }
+        const roleAttr = findAttr(node, "role");
+        if (
+          roleAttr &&
+          roleAttr.value &&
+          ABSTRACT_ROLE_SET.has(roleAttr.value.value)
+        ) {
+          context.report({
+            messageId: MESSAGE_IDS.UNEXPECTED,
+            node: roleAttr,
+          });
         }
       },
     };

package/lib/rules/no-accesskey-attrs.js

@@ -1,9 +1,5 @@
-/**
- * @typedef {import("../types").Rule} Rule
- */
-
 const { RULE_CATEGORY } = require("../constants");
-const { NodeUtils } = require("./utils");
+const { findAttr } = require("./utils/node");
 
 const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
@@ -31,8 +27,11 @@ module.exports = {
 
   create(context) {
     return {
+      /**
+       * @param {TagNode | ScriptTagNode | StyleTagNode} node
+       */
       [["Tag", "ScriptTag", "StyleTag"].join(",")](node) {
-        const accessKeyAttr = NodeUtils.findAttr(node, "accesskey");
+        const accessKeyAttr = findAttr(node, "accesskey");
         if (accessKeyAttr) {
           context.report({
             node: accessKeyAttr,

package/lib/rules/no-aria-hidden-body.js

@@ -1,9 +1,5 @@
-/**
- * @typedef {import("../types").Rule} Rule
- */
-
 const { RULE_CATEGORY } = require("../constants");
-const { NodeUtils } = require("./utils");
+const { findAttr } = require("./utils/node");
 
 const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
@@ -36,7 +32,7 @@ module.exports = {
         if (node.name !== "body") {
           return;
         }
-        const ariaHiddenAttr = NodeUtils.findAttr(node, "aria-hidden");
+        const ariaHiddenAttr = findAttr(node, "aria-hidden");
         if (ariaHiddenAttr) {
           if (
             (ariaHiddenAttr.value && ariaHiddenAttr.value.value !== "false") ||

package/lib/rules/no-duplicate-attrs.js

@@ -1,7 +1,3 @@
-/**
- * @typedef {import("../types").Rule} Rule
- */
-
 const { RULE_CATEGORY } = require("../constants");
 
 const MESSAGE_IDS = {
@@ -31,6 +27,9 @@ module.exports = {
 
   create(context) {
     return {
+      /**
+       * @param {TagNode | StyleTagNode | ScriptTagNode} node
+       */
       [["Tag", "StyleTag", "ScriptTag"].join(",")](node) {
         if (Array.isArray(node.attributes)) {
           const attrsSet = new Set();

package/lib/rules/no-duplicate-id.js

@@ -1,9 +1,5 @@
-/**
- * @typedef {import("../types").Rule} Rule
- */
-
 const { RULE_CATEGORY } = require("../constants");
-const { NodeUtils } = require("./utils");
+const { findAttr } = require("./utils/node");
 
 const MESSAGE_IDS = {
   DUPLICATE_ID: "duplicateId",
@@ -32,11 +28,15 @@ module.exports = {
   create(context) {
     const IdAttrsMap = new Map();
     return {
-      "*"(node) {
+      /**
+       * @param {TagNode | ScriptTagNode | StyleTagNode} node
+       * @returns
+       */
+      Tag(node) {
         if (!node.attributes || node.attributes.length <= 0) {
           return;
         }
-        const idAttr = NodeUtils.findAttr(node, "id");
+        const idAttr = findAttr(node, "id");
         if (idAttr && idAttr.value) {
           if (!IdAttrsMap.has(idAttr.value.value)) {
             IdAttrsMap.set(idAttr.value.value, []);

package/lib/rules/no-extra-spacing-attrs.js

@@ -1,8 +1,5 @@
-/**
- * @typedef {import("../types").Rule} Rule
- */
 const { RULE_CATEGORY } = require("../constants");
-const { NodeUtils } = require("./utils");
+const { getLocBetween } = require("./utils/node");
 
 const MESSAGE_IDS = {
   EXTRA_BETWEEN: "unexpectedBetween",
@@ -56,6 +53,9 @@ module.exports = {
       .enforceBeforeSelfClose;
     const disallowMissing = !!(context.options[0] || {}).disallowMissing;
 
+    /**
+     * @param {AttributeNode[]} attrs
+     */
     function checkExtraSpacesBetweenAttrs(attrs) {
       attrs.forEach((current, index, attrs) => {
         if (index >= attrs.length - 1) {
@@ -69,7 +69,7 @@ module.exports = {
         const spacesBetween = after.loc.start.column - current.loc.end.column;
         if (spacesBetween > 1) {
           context.report({
-            loc: NodeUtils.getLocBetween(current, after),
+            loc: getLocBetween(current, after),
             messageId: MESSAGE_IDS.EXTRA_BETWEEN,
             fix(fixer) {
               return fixer.removeRange([current.range[1] + 1, after.range[0]]);
@@ -87,6 +87,12 @@ module.exports = {
       });
     }
 
+    /**
+     * @param {OpenTagEndNode | OpenScriptTagEndNode | OpenStyleTagEndNode} openEnd
+     * @param {AttributeNode} lastAttr
+     * @param {boolean} isSelfClosed
+     * @returns {void}
+     */
     function checkExtraSpaceAfter(openEnd, lastAttr, isSelfClosed) {
       if (openEnd.loc.end.line !== lastAttr.loc.end.line) {
         // skip the attribute on the different line with the start tag
@@ -97,7 +103,7 @@ module.exports = {
 
       if (spacesBetween > limit) {
         context.report({
-          loc: NodeUtils.getLocBetween(lastAttr, openEnd),
+          loc: getLocBetween(lastAttr, openEnd),
           messageId: MESSAGE_IDS.EXTRA_AFTER,
           fix(fixer) {
             return fixer.removeRange([
@@ -110,7 +116,7 @@ module.exports = {
 
       if (isSelfClosed && enforceBeforeSelfClose && spacesBetween < 1) {
         context.report({
-          loc: NodeUtils.getLocBetween(lastAttr, openEnd),
+          loc: getLocBetween(lastAttr, openEnd),
           messageId: MESSAGE_IDS.MISSING_BEFORE_SELF_CLOSE,
           fix(fixer) {
             return fixer.insertTextAfter(lastAttr, " ");
@@ -119,6 +125,11 @@ module.exports = {
       }
     }
 
+    /**
+     * @param {OpenScriptTagStartNode | OpenTagStartNode | OpenStyleTagStartNode} node
+     * @param {AttributeNode} firstAttr
+     * @returns
+     */
     function checkExtraSpaceBefore(node, firstAttr) {
       if (node.loc.start.line !== firstAttr.loc.start.line) {
         // skip the attribute on the different line with the start tag
@@ -128,7 +139,7 @@ module.exports = {
       const spacesBetween = firstAttr.loc.start.column - node.loc.end.column;
       if (spacesBetween >= 2) {
         context.report({
-          loc: NodeUtils.getLocBetween(node, firstAttr),
+          loc: getLocBetween(node, firstAttr),
 
           messageId: MESSAGE_IDS.EXTRA_BEFORE,
           fix(fixer) {
@@ -141,6 +152,11 @@ module.exports = {
       }
     }
 
+    /**
+     * @param {AnyNode} beforeSelfClosing
+     * @param {OpenTagEndNode | OpenScriptTagEndNode | OpenStyleTagEndNode} openEnd
+     * @returns
+     */
     function checkSpaceBeforeSelfClosing(beforeSelfClosing, openEnd) {
       if (beforeSelfClosing.loc.start.line !== openEnd.loc.start.line) {
         // skip the attribute on the different line with the start tag
@@ -148,7 +164,7 @@ module.exports = {
       }
       const spacesBetween =
         openEnd.loc.start.column - beforeSelfClosing.loc.end.column;
-      const locBetween = NodeUtils.getLocBetween(beforeSelfClosing, openEnd);
+      const locBetween = getLocBetween(beforeSelfClosing, openEnd);
 
       if (spacesBetween > 1) {
         context.report({
@@ -173,6 +189,10 @@ module.exports = {
     }
 
     return {
+      /**
+       * @param {TagNode | StyleTagNode | ScriptTagNode} node
+       * @returns
+       */
       [["Tag", "StyleTag", "ScriptTag"].join(",")](node) {
         if (!node.attributes) {
           return;

package/lib/rules/no-inline-styles.js

@@ -1,10 +1,13 @@
 const { RULE_CATEGORY } = require("../constants");
-const { NodeUtils } = require("./utils");
+const { findAttr } = require("./utils/node");
 
 const MESSAGE_IDS = {
   INLINE_STYLE: "unexpectedInlineStyle",
 };
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",
@@ -25,7 +28,7 @@ module.exports = {
   create(context) {
     return {
       Tag(node) {
-        const styleAttr = NodeUtils.findAttr(node, "style");
+        const styleAttr = findAttr(node, "style");
         if (styleAttr) {
           context.report({
             node: styleAttr,

package/lib/rules/no-multiple-empty-lines.js

@@ -1,7 +1,3 @@
-/**
- * @typedef {import("../types").Rule} Rule
- */
-
 const { RULE_CATEGORY } = require("../constants");
 
 const MESSAGE_IDS = {
@@ -45,6 +41,9 @@ module.exports = {
     const lines = sourceCode.lines;
     const max = context.options.length ? context.options[0].max : 2;
     return {
+      /**
+       * @param {ProgramNode} node
+       */
       "Program:exit"(node) {
         /** @type {number[]} */
         const nonEmptyLineNumbers = [];

package/lib/rules/no-multiple-h1.js

@@ -1,7 +1,3 @@
-/**
- * @typedef {import("../types").Rule} Rule
- */
-
 const { RULE_CATEGORY } = require("../constants");
 
 const MESSAGE_IDS = {
@@ -29,6 +25,9 @@ module.exports = {
   },
 
   create(context) {
+    /**
+     * @type {TagNode[]}
+     */
     const h1s = [];
 
     return {

package/lib/rules/no-non-scalable-viewport.js

@@ -1,9 +1,5 @@
-/**
- * @typedef {import("../types").Rule} Rule
- */
-
 const { RULE_CATEGORY } = require("../constants");
-const { NodeUtils } = require("./utils");
+const { findAttr } = require("./utils/node");
 
 const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
@@ -36,8 +32,8 @@ module.exports = {
         if (node.name !== "meta") {
           return;
         }
-        const nameAttr = NodeUtils.findAttr(node, "name");
-        const contentAttr = NodeUtils.findAttr(node, "content");
+        const nameAttr = findAttr(node, "name");
+        const contentAttr = findAttr(node, "content");
         if (
           nameAttr &&
           nameAttr.value &&

package/lib/rules/no-obsolete-tags.js

@@ -1,5 +1,4 @@
-const { RULE_CATEGORY } = require("../constants");
-const { OBSOLETE_TAGS } = require("../constants");
+const { RULE_CATEGORY, OBSOLETE_TAGS } = require("../constants");
 
 const OBSOLETE_TAGS_SET = new Set(OBSOLETE_TAGS);
 
@@ -7,6 +6,9 @@ const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
 };
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",