@html-eslint/eslint-plugin 0.9.0-alpha.0 → 0.11.0

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,28 +54,47 @@ 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 openinig = getCodeIn([valueStart, valueStart + 1]);
+      const opening = getCodeIn([valueStart, valueStart + 1]);
       const closing = getCodeIn([valueEnd - 1, valueEnd]);
-      return [openinig, closing];
+      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

@@ -0,0 +1,58 @@
+/**
+ * @typedef {import("../types").Rule} Rule
+ */
+
+const { RULE_CATEGORY } = require("../constants");
+const { NodeUtils } = require("./utils");
+
+const MESSAGE_IDS = {
+  MISSING: "missing",
+  INVALID: "invalid",
+};
+
+const VALID_BUTTON_TYPES_SET = new Set(["submit", "button", "reset"]);
+
+/**
+ * @type {Rule}
+ */
+module.exports = {
+  meta: {
+    type: "code",
+
+    docs: {
+      description: "Require use of button element with a valid type attribute.",
+      category: RULE_CATEGORY.BEST_PRACTICE,
+      recommended: false,
+    },
+
+    fixable: null,
+    schema: [],
+    messages: {
+      [MESSAGE_IDS.MISSING]: "Missing a type attribute for button",
+      [MESSAGE_IDS.INVALID]:
+        '"{{type}}" is an invalid value for button type attribute.',
+    },
+  },
+
+  create(context) {
+    return {
+      Button(node) {
+        const typeAttr = NodeUtils.findAttr(node, "type");
+        if (!typeAttr) {
+          context.report({
+            node: node.startTag || node,
+            messageId: MESSAGE_IDS.MISSING,
+          });
+        } else if (!VALID_BUTTON_TYPES_SET.has(typeAttr.value)) {
+          context.report({
+            node: typeAttr,
+            messageId: MESSAGE_IDS.INVALID,
+            data: {
+              type: typeAttr.value,
+            },
+          });
+        }
+      },
+    };
+  },
+};

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

@@ -1,19 +1,26 @@
+/**
+ * @typedef {import("../types").Rule} Rule
+ */
+
 const { RULE_CATEGORY, VOID_ELEMENTS } = require("../constants");
 
 const VOID_ELEMENTS_SET = new Set(VOID_ELEMENTS);
 
 const MESSAGE_IDS = {
-  MISSNG: "missing",
+  MISSING: "missing",
   MISSING_SELF: "missingSelf",
   UNEXPECTED: "unexpected",
 };
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",
 
     docs: {
-      description: "Reqiure closing tags.",
+      description: "Require closing tags.",
       category: RULE_CATEGORY.BEST_PRACTICE,
       recommended: true,
     },
@@ -31,7 +38,7 @@ module.exports = {
       },
     ],
     messages: {
-      [MESSAGE_IDS.MISSNG]: "Missing closing tag for {{tag}}.",
+      [MESSAGE_IDS.MISSING]: "Missing closing tag for {{tag}}.",
       [MESSAGE_IDS.MISSING_SELF]: "Missing self closing tag for {{tag}}",
       [MESSAGE_IDS.UNEXPECTED]: "Unexpected self closing tag for {{tag}}.",
     },
@@ -55,7 +62,7 @@ module.exports = {
           data: {
             tag: node.tagName,
           },
-          messageId: MESSAGE_IDS.MISSNG,
+          messageId: MESSAGE_IDS.MISSING,
         });
       }
     }

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,12 +1,18 @@
-// @ts-check
+/**
+ * @typedef {import("../types").Rule} Rule
+ */
+
 const { RULE_CATEGORY } = require("../constants");
 const { NodeUtils } = require("./utils");
 
 const MESSAGE_IDS = {
-  MISSNG: "missing",
+  MISSING: "missing",
   EMPTY: "empty",
 };
 
+/**
+ * @type {Rule}
+ */
 module.exports = {
   meta: {
     type: "code",
@@ -20,7 +26,7 @@ module.exports = {
     fixable: null,
     schema: [],
     messages: {
-      [MESSAGE_IDS.MISSNG]: "Missing `lang` attribute in `<html>` tag.",
+      [MESSAGE_IDS.MISSING]: "Missing `lang` attribute in `<html>` tag.",
       [MESSAGE_IDS.EMPTY]: "Unexpected empty `lang` in in `<html>` tag.",
     },
   },
@@ -32,7 +38,7 @@ module.exports = {
         if (!langAttr) {
           context.report({
             node: node.startTag,
-            messageId: MESSAGE_IDS.MISSNG,
+            messageId: MESSAGE_IDS.MISSING,
           });
         } else if (langAttr.value.trim().length === 0) {
           context.report({

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");
 
@@ -21,28 +26,34 @@ module.exports = {
     messages: {
       [MESSAGE_IDS.MISSING]: 'Missing `<meta name="description">`.',
       [MESSAGE_IDS.EMPTY]:
-        'Unexpected emtpy `conetnt` in `<meta name="description">`',
+        'Unexpected empty `content` in `<meta name="description">`',
     },
   },
 
+  /**
+   * @param {Context} context
+   */
   create(context) {
     return {
+      /**
+       * @param {ElementNode} node
+       */
       Head(node) {
         const metaTags = (node.childNodes || []).filter(
           (child) => child.type === NODE_TYPES.META
         );
-        const descripMetaTags = metaTags.filter((meta) => {
+        const descriptionMetaTags = metaTags.filter((meta) => {
           const nameAttr = NodeUtils.findAttr(meta, "name");
           return !!nameAttr && nameAttr.value.toLowerCase() === "description";
         });
 
-        if (descripMetaTags.length === 0) {
+        if (descriptionMetaTags.length === 0) {
           context.report({
             node,
             messageId: MESSAGE_IDS.MISSING,
           });
         } else {
-          descripMetaTags.forEach((meta) => {
+          descriptionMetaTags.forEach((meta) => {
             const content = NodeUtils.findAttr(meta, "content");
             if (!content || !content.value.trim().length) {
               context.report({

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({