@html-eslint/eslint-plugin 0.10.0 → 0.13.0

package/lib/constants/node-types.js

@@ -1,8 +1,3 @@
-/**
- * @typedef {import("../types").NodeTypes} NodeTypes
- */
-
-/** @type {NodeTypes} */
 module.exports = {
   PROGRAM: "Program",
   TEXT: "text",

package/lib/constants/obsolete-tags.js

@@ -1,5 +1,5 @@
 // https://html.spec.whatwg.org/#non-conforming-features
-/** @type {string[] */
+/** @type {string[]} */
 module.exports = [
   "applet",
   "acronym",

package/lib/constants/rule-category.js

@@ -1,8 +1,3 @@
-/**
- * @typedef {import("../types").RuleCategory} RuleCategory
- */
-
-/** @type {RuleCategory} */
 module.exports = {
   BEST_PRACTICE: "Best Practice",
   SEO: "SEO",

package/lib/constants/void-elements.js

@@ -1,4 +1,4 @@
-/** @type {string[] */
+/** @type {string[]} */
 module.exports = [
   "area",
   "base",

package/lib/rules/element-newline.js

@@ -1,5 +1,7 @@
 /**
- * @typedef {import("../types").HTMLNode} HTMLNode
+ * @typedef {import("../types").ElementNode} ElementNode
+ * @typedef {import("../types").AnyNode} AnyNode
+ * @typedef {import("../types").Context} Context
  */
 
 const { RULE_CATEGORY, NODE_TYPES } = require("../constants");
@@ -29,9 +31,12 @@ module.exports = {
     },
   },
 
+  /**
+   * @param {Context} context
+   */
   create(context) {
-    function checkSiblings(sibilings) {
-      sibilings
+    function checkSiblings(siblings) {
+      siblings
         .filter((node) => node.type !== NODE_TYPES.TEXT && node.range[0])
         .forEach((current, index, arr) => {
           const after = arr[index + 1];
@@ -50,6 +55,10 @@ module.exports = {
         });
     }
 
+    /**
+     *
+     * @param {ElementNode['childNodes'][number]} node
+     */
     function checkChild(node) {
       const children = (node.childNodes || []).filter(
         (n) => !!n.range[0] && n.type !== NODE_TYPES.TEXT
@@ -57,31 +66,40 @@ module.exports = {
       const first = children[0];
       const last = children[children.length - 1];
       if (first) {
-        if (isOnTheSameLine(node.startTag, first)) {
+        if (node.startTag && isOnTheSameLine(node.startTag, first)) {
           context.report({
             node: node.startTag,
             messageId: MESSAGE_IDS.EXPECT_NEW_LINE_AFTER,
             data: { tag: `<${node.tagName}>` },
             fix(fixer) {
-              return fixer.insertTextAfter(node.startTag, "\n");
+              if (node.startTag) {
+                return fixer.insertTextAfter(node.startTag, "\n");
+              }
+              return null;
             },
           });
         }
       }
       if (last) {
-        if (isOnTheSameLine(node.endTag, last)) {
+        if (node.endTag && isOnTheSameLine(node.endTag, last)) {
           context.report({
             node: node.endTag,
             messageId: MESSAGE_IDS.EXPECT_NEW_LINE_BEFORE,
             data: { tag: `</${node.tagName}>` },
             fix(fixer) {
-              return fixer.insertTextBefore(node.endTag, "\n");
+              if (node.endTag) {
+                return fixer.insertTextBefore(node.endTag, "\n");
+              }
+              return null;
             },
           });
         }
       }
     }
     return {
+      /**
+       * @param {ElementNode} node
+       */
       "*"(node) {
         if (node.type !== NODE_TYPES.TEXT) {
           checkSiblings(node.childNodes || []);
@@ -94,13 +112,15 @@ module.exports = {
 
 /**
  * Checks whether two nodes are on the same line or not.
- * @param {HTMLNode} nodeBefore A node before
- * @param {HTMLNode} nodeAfter  A node after
+ * @param {AnyNode} nodeBefore A node before
+ * @param {AnyNode} nodeAfter  A node after
  * @returns {boolean} `true` if two nodes are on the same line, otherwise `false`.
  */
 function isOnTheSameLine(nodeBefore, nodeAfter) {
   if (nodeBefore && nodeAfter) {
+    // @ts-ignore
     if (nodeBefore.endTag) {
+      // @ts-ignore
       return nodeBefore.endTag.loc.end.line === nodeAfter.loc.start.line;
     }
     return nodeBefore.loc.start.line === nodeAfter.loc.start.line;

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

@@ -1,3 +1,7 @@
+/**
+ * @typedef {import("../types").Rule} Rule
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 const { NamingUtils, NodeUtils } = require("./utils");
 
@@ -5,7 +9,7 @@ const MESSAGE_IDS = {
   WRONG: "wrong",
 };
 
-const CONEVNTIONS = {
+const CONVENTIONS = {
   CAMEL_CASE: "camelCase",
   SNAKE_CASE: "snake_case",
   PASCAL_CASE: "PascalCase",
@@ -13,12 +17,15 @@ const CONEVNTIONS = {
 };
 
 const CONVENTION_CHECKERS = {
-  [CONEVNTIONS.CAMEL_CASE]: NamingUtils.isCamelCase,
-  [CONEVNTIONS.SNAKE_CASE]: NamingUtils.isSnakeCase,
-  [CONEVNTIONS.PASCAL_CASE]: NamingUtils.isPascalCase,
-  [CONEVNTIONS.KEBAB_CASE]: NamingUtils.isKebabCase,
+  [CONVENTIONS.CAMEL_CASE]: NamingUtils.isCamelCase,
+  [CONVENTIONS.SNAKE_CASE]: NamingUtils.isSnakeCase,
+  [CONVENTIONS.PASCAL_CASE]: NamingUtils.isPascalCase,
+  [CONVENTIONS.KEBAB_CASE]: NamingUtils.isKebabCase,
 };
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",
@@ -32,7 +39,7 @@ module.exports = {
     fixable: null,
     schema: [
       {
-        enum: Object.values(CONEVNTIONS),
+        enum: Object.values(CONVENTIONS),
       },
     ],
     messages: {
@@ -45,7 +52,7 @@ module.exports = {
     const convention =
       context.options && context.options.length
         ? context.options[0]
-        : CONEVNTIONS.SNAKE_CASE;
+        : CONVENTIONS.SNAKE_CASE;
 
     const checkNaming = CONVENTION_CHECKERS[convention];
 

package/lib/rules/indent.js

@@ -1,7 +1,9 @@
-// @ts-check
 /**
- * @typedef {import("../types").HTMLNode} HTMLNode
+ * @typedef {import("../types").Rule} Rule
+ * @typedef {import("../types").ElementNode} ElementNode
  * @typedef {import("../types").AttrNode} AttrNode
+ * @typedef {import("../types").TagNode} TagNode
+ * @typedef {import("../types").AnyNode} AnyNode
  * @typedef {import("../types").BaseNode} BaseNode
  * @typedef {Object} IndentType
  * @property {"tab"} TAB
@@ -12,6 +14,7 @@
  */
 
 const { RULE_CATEGORY, NODE_TYPES } = require("../constants");
+const { NodeUtils } = require("./utils");
 
 /** @type {MessageId} */
 const MESSAGE_ID = {
@@ -31,6 +34,9 @@ const IGNORING_NODES = [
   NODE_TYPES.XMP,
 ];
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",
@@ -60,7 +66,6 @@ module.exports = {
         "Expected indentation of {{expected}} but found {{actual}}.",
     },
   },
-
   create(context) {
     const sourceCode = context.getSourceCode();
     const indentLevel = new IndentLevel();
@@ -79,7 +84,7 @@ module.exports = {
 
     /**
      * @param {BaseNode} node
-     * @param {HTMLNode} [nodeToReport]
+     * @param {BaseNode} [nodeToReport]
      */
     function checkIndent(node, nodeToReport) {
       const codeBefore = getLineCodeBefore(node);
@@ -126,14 +131,19 @@ module.exports = {
     }
 
     /**
+     * @param {AnyNode} startTag
      * @param {AttrNode[]} attrs
      */
-    function checkAttrsIndent(attrs) {
-      attrs.forEach((attr) => checkIndent(attr));
+    function checkAttrsIndent(startTag, attrs) {
+      attrs.forEach((attr) => {
+        if (attr.loc.start.line !== startTag.loc.start.line) {
+          checkIndent(attr);
+        }
+      });
     }
 
     /**
-     * @param {BaseNode} startTag
+     * @param {AnyNode} startTag
      */
     function checkEndOfStartTag(startTag) {
       const start = startTag.range[1] - 1;
@@ -141,6 +151,7 @@ module.exports = {
       const line = startTag.loc.end.line;
       const endCol = startTag.loc.end.column;
       const startCol = startTag.loc.end.column - 1;
+
       checkIndent({
         range: [start, end],
         start,
@@ -160,7 +171,7 @@ module.exports = {
     let nodesToIgnoreChildren = [];
     return {
       /**
-       * @param {HTMLNode} node
+       * @param {ElementNode} node
        */
       "*"(node) {
         if (IGNORING_NODES.includes(node.type)) {
@@ -173,8 +184,8 @@ module.exports = {
 
         indentLevel.up();
 
-        if (Array.isArray(node.attrs)) {
-          checkAttrsIndent(node.attrs);
+        if (node.startTag && Array.isArray(node.attrs)) {
+          checkAttrsIndent(node.startTag, node.attrs);
         }
 
         (node.childNodes || []).forEach((current) => {
@@ -186,7 +197,11 @@ module.exports = {
           }
         });
 
-        if (node.lineNodes && node.lineNodes.length) {
+        if (
+          (NodeUtils.isTextNode(node) || NodeUtils.isCommentNode(node)) &&
+          node.lineNodes &&
+          node.lineNodes.length
+        ) {
           if (!node.startTag) {
             indentLevel.down();
           }
@@ -219,6 +234,9 @@ module.exports = {
 };
 
 function getIndentTypeAndSize(options) {
+  /**
+   * @type {IndentType['SPACE'] | IndentType['TAB']}
+   */
   let indentType = INDENT_TYPES.SPACE;
   let indentSize = 4;
   if (options.length) {

package/lib/rules/index.js

@@ -25,6 +25,9 @@ const noDuplicateAttrs = require("./no-duplicate-attrs");
 const noAbstractRoles = require("./no-abstract-roles");
 const requireButtonType = require("./require-button-type");
 const noAriaHiddenBody = require("./no-aria-hidden-body");
+const noMultipleEmptyLines = require("./no-multiple-empty-lines");
+const noAccesskeyAttrs = require("./no-accesskey-attrs");
+const noRestrictedAttrs = require("./no-restricted-attrs");
 
 module.exports = {
   "require-lang": requireLang,
@@ -54,4 +57,7 @@ module.exports = {
   "no-abstract-roles": noAbstractRoles,
   "require-button-type": requireButtonType,
   "no-aria-hidden-body": noAriaHiddenBody,
+  "no-multiple-empty-lines": noMultipleEmptyLines,
+  "no-accesskey-attrs": noAccesskeyAttrs,
+  "no-restricted-attrs": noRestrictedAttrs,
 };

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

@@ -1,3 +1,7 @@
+/**
+ * @typedef {import("../types").Rule} Rule
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 const { NodeUtils } = require("./utils");
 
@@ -20,6 +24,9 @@ const ABSTRACT_ROLE_SET = new Set([
   "window",
 ]);
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",

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

@@ -0,0 +1,45 @@
+/**
+ * @typedef {import("../types").Rule} Rule
+ */
+
+const { RULE_CATEGORY } = require("../constants");
+const { NodeUtils } = require("./utils");
+
+const MESSAGE_IDS = {
+  UNEXPECTED: "unexpected",
+};
+
+/**
+ * @type {Rule}
+ */
+module.exports = {
+  meta: {
+    type: "code",
+
+    docs: {
+      description: "Disallow to use of accesskey attribute",
+      category: RULE_CATEGORY.ACCESSIBILITY,
+      recommended: false,
+    },
+
+    fixable: null,
+    schema: [],
+    messages: {
+      [MESSAGE_IDS.UNEXPECTED]: "Unexpected use of accesskey attribute.",
+    },
+  },
+
+  create(context) {
+    return {
+      "*"(node) {
+        const accessKeyAttr = NodeUtils.findAttr(node, "accesskey");
+        if (accessKeyAttr) {
+          context.report({
+            node: accessKeyAttr,
+            messageId: MESSAGE_IDS.UNEXPECTED,
+          });
+        }
+      },
+    };
+  },
+};

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

@@ -1,3 +1,7 @@
+/**
+ * @typedef {import("../types").Rule} Rule
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 const { NodeUtils } = require("./utils");
 
@@ -5,6 +9,9 @@ const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
 };
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",

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

@@ -1,9 +1,16 @@
+/**
+ * @typedef {import("../types").Rule} Rule
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 
 const MESSAGE_IDS = {
   DUPLICATE_ATTRS: "duplicateAttrs",
 };
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",

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

@@ -1,3 +1,7 @@
+/**
+ * @typedef {import("../types").Rule} Rule
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 const { NodeUtils } = require("./utils");
 
@@ -5,6 +9,9 @@ const MESSAGE_IDS = {
   DUPLICATE_ID: "duplicateId",
 };
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",

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

@@ -1,3 +1,10 @@
+/**
+ * @typedef {import("../types").Rule} Rule
+ * @typedef {import("../types").AttrNode} AttrNode
+ * @typedef {import("../types").TagNode} TagNode
+ * @typedef {import("../types").ElementNode} ElementNode
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 
 const MESSAGE_IDS = {
@@ -6,6 +13,9 @@ const MESSAGE_IDS = {
   EXTRA_BEFORE: "unexpectedBefore",
 };
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",
@@ -25,6 +35,9 @@ module.exports = {
     },
   },
   create(context) {
+    /**
+     * @param {AttrNode[]} attrs
+     */
     function checkExtraSpacesBetweenAttrs(attrs) {
       attrs.forEach((current, index, attrs) => {
         if (index >= attrs.length - 1) {
@@ -50,12 +63,21 @@ module.exports = {
         }
       });
     }
-    function checkExtraSpaceAfter(startTag, lastAttr) {
+    /**
+     * @param {TagNode} startTag
+     * @param {AttrNode} lastAttr
+     * @param {boolean} isSelfClosed
+     */
+    function checkExtraSpaceAfter(startTag, lastAttr, isSelfClosed) {
       if (startTag.loc.end.line !== lastAttr.loc.end.line) {
-        // skip the attribute on the diffrent line with the start tag
+        // skip the attribute on the different line with the start tag
         return;
       }
-      const spacesBetween = startTag.loc.end.column - lastAttr.loc.end.column;
+      let spacesBetween = startTag.loc.end.column - lastAttr.loc.end.column;
+      if (isSelfClosed) {
+        spacesBetween--;
+      }
+
       if (spacesBetween > 1) {
         context.report({
           loc: {
@@ -66,15 +88,20 @@ module.exports = {
           fix(fixer) {
             return fixer.removeRange([
               lastAttr.range[1],
-              startTag.range[1] - 1,
+              lastAttr.range[1] + spacesBetween - 1,
             ]);
           },
         });
       }
     }
+
+    /**
+     * @param {ElementNode} node
+     * @param {AttrNode} firstAttr
+     */
     function checkExtraSpaceBefore(node, firstAttr) {
       if (node.loc.start.line !== firstAttr.loc.start.line) {
-        // skip the attribute on the diffrent line with the start tag
+        // skip the attribute on the different line with the start tag
         return;
       }
       const nodeLength = node.tagName.length;
@@ -103,9 +130,11 @@ module.exports = {
           checkExtraSpaceBefore(node, node.attrs[0]);
         }
         if (node.startTag && node.attrs && node.attrs.length > 0) {
+          const isSelfClosed = !node.endTag;
           checkExtraSpaceAfter(
             node.startTag,
-            node.attrs[node.attrs.length - 1]
+            node.attrs[node.attrs.length - 1],
+            isSelfClosed
           );
         }
         checkExtraSpacesBetweenAttrs(node.attrs || []);

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

@@ -1,3 +1,7 @@
+/**
+ * @typedef {import("../types").Rule} Rule
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 const { NodeUtils } = require("./utils");
 
@@ -5,6 +9,9 @@ const MESSAGE_IDS = {
   INLINE_STYLE: "unexpectedInlineStyle",
 };
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",

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

@@ -0,0 +1,90 @@
+/**
+ * @typedef {import("../types").Rule} Rule
+ */
+
+const { RULE_CATEGORY } = require("../constants");
+
+const MESSAGE_IDS = {
+  UNEXPECTED: "unexpected",
+};
+
+/**
+ * @type {Rule}
+ */
+module.exports = {
+  meta: {
+    type: "code",
+
+    docs: {
+      description: "Disallow multiple empty lines",
+      category: RULE_CATEGORY.STYLE,
+      recommended: false,
+    },
+
+    fixable: "whitespace",
+    schema: [
+      {
+        type: "object",
+        properties: {
+          max: {
+            type: "integer",
+            minimum: 0,
+          },
+        },
+        required: ["max"],
+        additionalProperties: false,
+      },
+    ],
+    messages: {
+      [MESSAGE_IDS.UNEXPECTED]: "More than {{max}} blank lines not allowed.",
+    },
+  },
+
+  create(context) {
+    const sourceCode = context.getSourceCode();
+    const lines = sourceCode.lines;
+    const max = context.options.length ? context.options[0].max : 2;
+    return {
+      "Program:exit"(node) {
+        /** @type {number[]} */
+        const nonEmptyLineNumbers = [];
+
+        lines.forEach((line, index) => {
+          if (line.trim().length > 0) {
+            nonEmptyLineNumbers.push(index + 1);
+          }
+        });
+
+        nonEmptyLineNumbers.forEach((current, index, arr) => {
+          const before = arr[index - 1];
+          if (typeof before === "number") {
+            if (current - before - 1 > max) {
+              context.report({
+                node,
+                loc: {
+                  start: { line: before, column: 0 },
+                  end: { line: current, column: 0 },
+                },
+                messageId: MESSAGE_IDS.UNEXPECTED,
+                data: {
+                  max,
+                },
+                fix(fixer) {
+                  const start = sourceCode.getIndexFromLoc({
+                    line: before + 1,
+                    column: 0,
+                  });
+                  const end = sourceCode.getIndexFromLoc({
+                    line: current - max,
+                    column: 0,
+                  });
+                  return fixer.removeRange([start, end]);
+                },
+              });
+            }
+          }
+        });
+      },
+    };
+  },
+};

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

@@ -1,9 +1,16 @@
+/**
+ * @typedef {import("../types").Rule} Rule
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 
 const MESSAGE_IDS = {
   MULTIPLE_H1: "unexpectedMultiH1",
 };
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",

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

@@ -1,3 +1,7 @@
+/**
+ * @typedef {import("../types").Rule} Rule
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 const { NodeUtils } = require("./utils");
 
@@ -5,6 +9,9 @@ const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
 };
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",

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

@@ -1,3 +1,7 @@
+/**
+ * @typedef {import("../types").Rule} Rule
+ */
+
 const { RULE_CATEGORY, NODE_TYPES } = require("../constants");
 const { OBSOLETE_TAGS } = require("../constants");
 
@@ -7,6 +11,9 @@ const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
 };
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",