@html-eslint/eslint-plugin 0.10.1 → 0.11.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);
@@ -133,7 +138,7 @@ module.exports = {
     }
 
     /**
-     * @param {BaseNode} startTag
+     * @param {AnyNode} startTag
      */
     function checkEndOfStartTag(startTag) {
       const start = startTag.range[1] - 1;
@@ -160,7 +165,7 @@ module.exports = {
     let nodesToIgnoreChildren = [];
     return {
       /**
-       * @param {HTMLNode} node
+       * @param {ElementNode} node
        */
       "*"(node) {
         if (IGNORING_NODES.includes(node.type)) {
@@ -186,7 +191,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 +228,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,8 @@ 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");
 
 module.exports = {
   "require-lang": requireLang,
@@ -54,4 +56,6 @@ module.exports = {
   "no-abstract-roles": noAbstractRoles,
   "require-button-type": requireButtonType,
   "no-aria-hidden-body": noAriaHiddenBody,
+  "no-multiple-empty-lines": noMultipleEmptyLines,
+  "no-accesskey-attrs": noAccesskeyAttrs,
 };

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,9 +63,13 @@ module.exports = {
         }
       });
     }
+    /**
+     * @param {TagNode} startTag
+     * @param {AttrNode} lastAttr
+     */
     function checkExtraSpaceAfter(startTag, lastAttr) {
       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;
@@ -72,9 +89,14 @@ module.exports = {
         });
       }
     }
+
+    /**
+     * @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;

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",

package/lib/rules/no-positive-tabindex.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-skip-heading-levels.js

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

package/lib/rules/no-target-blank.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 = {
   MISSING: "missing",
 };
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",

package/lib/rules/quotes.js

@@ -1,3 +1,9 @@
+/**
+ * @typedef {import("../types").Rule} Rule
+ * @typedef {import("../types").Range} Range
+ * @typedef {import("../types").AttrNode} AttrNode
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 
 const MESSAGE_IDS = {
@@ -12,6 +18,9 @@ const QUOTES_STYLES = {
 
 const QUOTES_CODES = [`"`, `'`];
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",
@@ -45,16 +54,28 @@ module.exports = {
 
     const sourceCode = context.getSourceCode();
 
+    /**
+     * @param {Range} range
+     * @returns {string}
+     */
     function getCodeIn(range) {
       return sourceCode.text.slice(range[0], range[1]);
     }
 
+    /**
+     * @param {AttrNode} attr
+     * @returns {Range}
+     */
     function getValueRange(attr) {
       const attrCode = getCodeIn(attr.range);
       const [matched = ""] = attrCode.match(/\S*?\s*=\s*/) || [];
       return [attr.range[0] + matched.length, attr.range[1]];
     }
 
+    /**
+     * @param {AttrNode} attr
+     * @returns {[string, string]}
+     */
     function getQuotes(attr) {
       const [valueStart, valueEnd] = getValueRange(attr);
       const opening = getCodeIn([valueStart, valueStart + 1]);
@@ -62,11 +83,18 @@ module.exports = {
       return [opening, closing];
     }
 
+    /**
+     * @param {AttrNode} attr
+     * @returns {boolean}
+     */
     function hasEqualSign(attr) {
       const keyEnd = attr.range[0] + attr.name.length;
       return getCodeIn([keyEnd, attr.range[1]]).trimStart().startsWith("=");
     }
 
+    /**
+     * @param {AttrNode} attr
+     */
     function checkQuotes(attr) {
       const [opening, closing] = getQuotes(attr);
       if (QUOTES_CODES.includes(opening)) {

package/lib/rules/require-button-type.js

@@ -1,3 +1,7 @@
+/**
+ * @typedef {import("../types").Rule} Rule
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 const { NodeUtils } = require("./utils");
 
@@ -8,6 +12,9 @@ const MESSAGE_IDS = {
 
 const VALID_BUTTON_TYPES_SET = new Set(["submit", "button", "reset"]);
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",

package/lib/rules/require-closing-tags.js

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

package/lib/rules/require-doctype.js

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

package/lib/rules/require-frame-title.js

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

package/lib/rules/require-img-alt.js

@@ -1,9 +1,17 @@
+/**
+ * @typedef {import("../types").Rule} Rule
+ * @typedef {import("../types").ElementNode} ElementNode
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 
 const MESSAGE_IDS = {
   MISSING_ALT: "missingAlt",
 };
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",
@@ -35,6 +43,11 @@ module.exports = {
   },
 };
 
+/**
+ * Checks whether a node has `alt` attribute value or not.
+ * @param {ElementNode} node a node to check.
+ * @returns {boolean} `true` if a node has `alt` attribute value.
+ */
 function hasAltAttrAndValue(node) {
   return (node.attrs || []).some((attr) => {
     return attr.name === "alt" && attr.value.trim().length > 0;

package/lib/rules/require-lang.js

@@ -1,4 +1,7 @@
-// @ts-check
+/**
+ * @typedef {import("../types").Rule} Rule
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 const { NodeUtils } = require("./utils");
 
@@ -7,6 +10,9 @@ const MESSAGE_IDS = {
   EMPTY: "empty",
 };
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",

package/lib/rules/require-li-container.js

@@ -1,3 +1,7 @@
+/**
+ * @typedef {import("../types").Rule} Rule
+ */
+
 const { RULE_CATEGORY, NODE_TYPES } = require("../constants");
 
 const MESSAGE_IDS = {
@@ -6,6 +10,9 @@ const MESSAGE_IDS = {
 
 const VALID_CONTAINERS = [NODE_TYPES.UL, NODE_TYPES.OL, NODE_TYPES.MENU];
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",
@@ -27,7 +34,12 @@ module.exports = {
   create(context) {
     return {
       Li(node) {
-        if (!node.parent || !VALID_CONTAINERS.includes(node.parent.type)) {
+        if (!node.parent) {
+          context.report({
+            node,
+            messageId: MESSAGE_IDS.INVALID,
+          });
+        } else if (!VALID_CONTAINERS.includes(node.parent.type || "")) {
           context.report({
             node,
             messageId: MESSAGE_IDS.INVALID,

package/lib/rules/require-meta-charset.js

@@ -1,3 +1,8 @@
+/**
+ * @typedef {import("../types").ElementNode} ElementNode
+ * @typedef {import("../types").Context} Context
+ */
+
 const { RULE_CATEGORY, NODE_TYPES } = require("../constants");
 const { NodeUtils } = require("./utils");
 
@@ -24,8 +29,14 @@ module.exports = {
     },
   },
 
+  /**
+   * @param {Context} context
+   */
   create(context) {
     return {
+      /**
+       * @param {ElementNode} node
+       */
       Head(node) {
         const metaCharset = (node.childNodes || []).find((child) => {
           return (
@@ -41,7 +52,7 @@ module.exports = {
           return;
         }
         const charsetAttr = NodeUtils.findAttr(metaCharset, "charset");
-        if (!charsetAttr || !charsetAttr.value.length) {
+        if (charsetAttr && !charsetAttr.value.length) {
           context.report({
             node: charsetAttr,
             messageId: MESSAGE_IDS.EMPTY,

package/lib/rules/require-meta-description.js

@@ -1,3 +1,8 @@
+/**
+ * @typedef {import("../types").ElementNode} ElementNode
+ * @typedef {import("../types").Context} Context
+ */
+
 const { RULE_CATEGORY, NODE_TYPES } = require("../constants");
 const { NodeUtils } = require("./utils");
 
@@ -25,8 +30,14 @@ module.exports = {
     },
   },
 
+  /**
+   * @param {Context} context
+   */
   create(context) {
     return {
+      /**
+       * @param {ElementNode} node
+       */
       Head(node) {
         const metaTags = (node.childNodes || []).filter(
           (child) => child.type === NODE_TYPES.META

package/lib/rules/require-meta-viewport.js

@@ -1,7 +1,6 @@
-// @ts-check
 /**
- * @typedef {import("../types").HTMLNode} HTMLNode
- * @typedef {import("../types").AttrNode} AttrNode
+ * @typedef {import("../types").ElementNode} ElementNode
+ * @typedef {import("../types").Rule} Rule
  */
 
 const { RULE_CATEGORY, NODE_TYPES } = require("../constants");
@@ -12,6 +11,9 @@ const MESSAGE_IDS = {
   EMPTY: "empty",
 };
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",
@@ -33,7 +35,7 @@ module.exports = {
 
   create(context) {
     /**
-     * @param {HTMLNode} node
+     * @param {ElementNode} node
      * @returns {boolean}
      */
     function isMetaViewport(node) {
@@ -44,9 +46,6 @@ module.exports = {
       return false;
     }
     return {
-      /**
-       * @param {HTMLNode} node
-       */
       Head(node) {
         const metaViewport = (node.childNodes || []).find(isMetaViewport);
         if (!metaViewport) {
@@ -57,7 +56,12 @@ module.exports = {
           return;
         }
         const contentAttr = NodeUtils.findAttr(metaViewport, "content");
-        if (!contentAttr || !contentAttr.value.length) {
+        if (!contentAttr) {
+          context.report({
+            node: metaViewport,
+            messageId: MESSAGE_IDS.EMPTY,
+          });
+        } else if (!contentAttr.value.length) {
           context.report({
             node: contentAttr,
             messageId: MESSAGE_IDS.EMPTY,

package/lib/rules/require-title.js

@@ -1,10 +1,18 @@
+/**
+ * @typedef {import("../types").Rule} Rule
+ */
+
 const { RULE_CATEGORY, NODE_TYPES } = require("../constants");
+const { NodeUtils } = require("./utils");
 
 const MESSAGE_IDS = {
   MISSING_TITLE: "missing",
   EMPTY_TITLE: "empty",
 };
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",
@@ -23,7 +31,6 @@ module.exports = {
       [MESSAGE_IDS.EMPTY_TITLE]: "Unexpected empty text in `<title><title/>`",
     },
   },
-
   create(context) {
     return {
       Head(node) {
@@ -38,8 +45,7 @@ module.exports = {
           });
         } else if (
           !(titleTag.childNodes || []).some(
-            (node) =>
-              node.type === NODE_TYPES.TEXT && node.value.trim().length > 0
+            (node) => NodeUtils.isTextNode(node) && node.value.trim().length > 0
           )
         ) {
           context.report({

package/lib/rules/utils/node-utils.js

@@ -1,13 +1,17 @@
-// @ts-check
 /**
- * @typedef {import("../../types").HTMLNode} HTMLNode
+ * @typedef {import("../../types").ElementNode} ElementNode
  * @typedef {import("../../types").AttrNode} AttrNode
+ * @typedef {import("../../types").AnyNode} AnyNode
+ * @typedef {import("../../types").TextNode} TextNode
+ * @typedef {import("../../types").BaseNode} BaseNode
+ * @typedef {import("../../types").TextLineNode} TextLineNode
+ * @typedef {import("../../types").CommentNode} CommentNode
  */
 
 module.exports = {
   /**
    * Find attribute by name in the given node
-   * @param {HTMLNode} node node
+   * @param {ElementNode} node node
    * @param {string} name attribute name
    * @return {AttrNode | void}
    */
@@ -20,7 +24,7 @@ module.exports = {
   },
   /**
    * Checks a node has attribute with the given name or not.
-   * @param {HTMLNode} node node
+   * @param {ElementNode} node node
    * @param {string} name attribute name
    * @return {boolean} `true` if the node has a attribute, otherwise `false`.
    */
@@ -29,10 +33,28 @@ module.exports = {
   },
   /**
    * Checks whether a node's all tokens are on the same line or not.
-   * @param {HTMLNode} node A node to check
+   * @param {ElementNode} node A node to check
    * @returns {boolean} `true` if a node's tokens are on the same line, otherwise `false`.
    */
   isNodeTokensOnSameLine(node) {
     return node.loc.start.line === node.loc.end.line;
   },
+
+  /**
+   * Checks whether a node is a TextNode or not.
+   * @param {Object} node A node to check
+   * @returns {node is TextNode} `true` if a node is `TextNode`, otherwise `false`.
+   */
+  isTextNode(node) {
+    return !!(node && node.type === "text" && typeof node.value === "string");
+  },
+
+  /**
+   * Checks whether a node is a CommentNode or not.
+   * @param {Object} node A node to check
+   * @returns {node is CommentNode} `true` if a node is `CommentNode`, otherwise `false`.
+   */
+  isCommentNode(node) {
+    return !!(node && node.type === "comment");
+  },
 };

package/lib/types.d.ts

@@ -1,49 +1,120 @@
-export type RuleCategory = {
-  BEST_PRACTICE: "Best Practice";
-  SEO: "SEO";
-  ACCESSIBILITY: "Accessibility";
-  STYLE: "Style";
-};
+import ESTree from "estree";
+import ESLint from "eslint";
+
+type Fix = ESLint.Rule.Fix;
+type Token = ESLint.AST.Token;
+export type Range = ESLint.AST.Range;
+
+interface RuleListener {
+  [key: string]: (node: ElementNode) => void;
+}
+
+export interface Rule {
+  create(context: Context): RuleListener;
+  meta?: ESLint.Rule.RuleMetaData;
+}
+
+interface RuleFixer {
+  insertTextAfter(nodeOrToken: AnyNode | Token, text: string): Fix;
+
+  insertTextAfterRange(range: Range, text: string): Fix;
+
+  insertTextBefore(nodeOrToken: AnyNode | Token, text: string): Fix;
+
+  insertTextBeforeRange(range: Range, text: string): Fix;
+
+  remove(nodeOrToken: AnyNode | Token): Fix;
+
+  removeRange(range: Range): Fix;
+
+  replaceText(nodeOrToken: AnyNode | Token, text: string): Fix;
+
+  replaceTextRange(range: Range, text: string): Fix;
+}
+
+interface ReportDescriptorOptionsBase {
+  data?: { [key: string]: string };
+
+  fix?:
+    | null
+    | ((fixer: RuleFixer) => null | Fix | IterableIterator<Fix> | Fix[]);
+}
 
-export type NodeTypes = {
-  PROGRAM: "Program";
-  TEXT: "text";
-  TITLE: "Title";
-  PRE: "Pre";
-  MENU: "Menu";
-  OL: "Ol";
-  UL: "Ul";
-  SCRIPT: "Script";
-  XMP: "Xmp";
-  META: "Meta";
-  STYLE: "Style";
+type SuggestionDescriptorMessage = { desc: string } | { messageId: string };
+type SuggestionReportDescriptor = SuggestionDescriptorMessage &
+  ReportDescriptorOptionsBase;
+
+interface ReportDescriptorOptions extends ReportDescriptorOptionsBase {
+  suggest?: SuggestionReportDescriptor[] | null;
+}
+
+type ReportDescriptor = ReportDescriptorMessage &
+  ReportDescriptorLocation &
+  ReportDescriptorOptions;
+type ReportDescriptorMessage = { message: string } | { messageId: string };
+type ReportDescriptorLocation = {
+  node?: BaseNode;
+  loc?: ESLint.AST.SourceLocation;
+  line?: number;
+  column?: number;
 };
 
-interface BaseNode {
+export interface Context extends Omit<ESLint.Rule.RuleContext, "report"> {
+  report(descriptor: ReportDescriptor): void;
+}
+
+export interface BaseNode {
+  parent?: null | AnyNode;
+  range: [number, number];
   start: number;
   end: number;
-  range: [number, number];
   loc: {
-    end: {
-      line: number;
-      column: number;
-    };
-    start: {
-      line: number;
-      column: number;
-    };
+    start: ESTree.Position;
+    end: ESTree.Position;
   };
+  type?: string;
+}
+
+export interface TagNode extends BaseNode {
+  type: undefined;
 }
 
-export interface HTMLNode extends BaseNode {
-  childNodes?: HTMLNode[];
-  startTag?: BaseNode;
-  endTag?: BaseNode;
+export interface TextLineNode extends BaseNode {
+  textLine: string;
+}
+
+export interface TextNode extends BaseNode {
+  type: "text";
+  value: string;
+  lineNodes: TextLineNode[];
+}
+
+export interface ElementNode extends BaseNode {
   type: string;
-  attrs?: AttrNode[];
+  tagName: string;
+  attrs: AttrNode[];
+  childNodes: ElementNode[];
+  startTag?: TagNode;
+  endTag?: TagNode;
 }
 
 export interface AttrNode extends BaseNode {
   name: string;
   value: string;
 }
+
+export interface CommentNode extends BaseNode {
+  type: "comment";
+  value: string;
+  startTag?: TagNode;
+  endTag?: TagNode;
+  lineNodes: TextLineNode[];
+}
+
+export type AnyNode =
+  | AttrNode
+  | ElementNode
+  | TextNode
+  | TextLineNode
+  | TagNode
+  | CommentNode;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@html-eslint/eslint-plugin",
-  "version": "0.10.1",
+  "version": "0.11.0",
   "description": "ESLint plugin for html",
   "author": "yeonjuan",
   "homepage": "https://github.com/yeonjuan/html-eslint#readme",
@@ -21,7 +21,8 @@
     "url": "git+https://github.com/yeonjuan/html-eslint.git"
   },
   "scripts": {
-    "test": "jest --coverage"
+    "test": "jest --coverage",
+    "check:ts": "tsc"
   },
   "bugs": {
     "url": "https://github.com/yeonjuan/html-eslint/issues"
@@ -39,7 +40,10 @@
     "accessibility"
   ],
   "devDependencies": {
-    "@html-eslint/parser": "^0.10.1"
+    "@html-eslint/parser": "^0.11.0",
+    "@types/eslint": "^7.2.10",
+    "@types/estree": "^0.0.47",
+    "typescript": "^4.2.4"
   },
-  "gitHead": "827103223429c0a629d2823512df21fdf511edb5"
+  "gitHead": "a3873ecefae3b9306a5e98985cf4ccdbde95299a"
 }