@html-eslint/eslint-plugin 0.50.0 → 0.52.0

package/lib/rules/indent/indent.js

@@ -1,20 +1,38 @@
 /**
- * @import {AnyNode, Tag, TemplateText, TemplateLiteral, OpenTemplate, CloseTemplate, ScriptTag, StyleTag, Text} from "@html-eslint/types";
- * @import {Line, RuleListener, Context, RuleModule} from "../../types";
- * @import {AST} from "eslint";
- *
+ * @import {
+ *   AnyNode,
+ *   CloseTemplate,
+ *   OpenTemplate,
+ *   ScriptTag,
+ *   StyleTag,
+ *   Tag,
+ *   TemplateLiteral,
+ *   TemplateText,
+ *   Text
+ * } from "@html-eslint/types"
+ * @import {AST} from "eslint"
+ * @import {
+ *   Context,
+ *   Line,
+ *   RuleListener,
+ *   RuleModule
+ * } from "../../types"
  * @typedef {AnyNode | Line} AnyNodeOrLine
+ *
  * @typedef {Object} IndentType
  * @property {"tab"} TAB
  * @property {"space"} SPACE
+ *
  * @typedef {Object} MessageId
  * @property {"wrongIndent"} WRONG_INDENT
+ *
  * @typedef {Object} IndentOptionInfo
  * @property {IndentType["TAB"] | IndentType["SPACE"]} indentType
  * @property {number} indentSize
  * @property {string} indentChar
  *
  * @typedef {"tab" | number} Option1
+ *
  * @typedef {Object} Option2
  * @property {number} [Option2.Attribute]
  * @property {Record<string, number>} [Option2.tagChildrenIndent]
@@ -29,7 +47,6 @@ const {
   splitToLineNodes,
   isLine,
   isTag,
-  hasTemplate,
   isScript,
   isStyle,
   isText,
@@ -54,9 +71,7 @@ const INDENT_TYPES = {
 
 const IGNORING_NODES = ["pre", "xmp"];
 
-/**
- * @type {RuleModule<[Option1, Option2]>}
- */
+/** @type {RuleModule<[Option1, Option2]>} */
 module.exports = {
   meta: {
     type: "code",
@@ -127,7 +142,7 @@ module.exports = {
 
     /**
      * @param {Tag | ScriptTag | StyleTag | Text} node
-     * @return {number}
+     * @returns {number}
      */
     function getTagIncreasingLevel(node) {
       if (
@@ -149,7 +164,7 @@ module.exports = {
 
     /**
      * @param {AnyNode} node
-     * @return {number}
+     * @returns {number}
      */
     function getIncreasingLevel(node) {
       if (isLine(node)) {
@@ -189,7 +204,6 @@ module.exports = {
     }
 
     /**
-     *
      * @param {TemplateLiteral} node
      * @returns {number}
      */
@@ -222,7 +236,11 @@ module.exports = {
       let parentIgnoringChildCount = 0;
 
       /**
-       * @param {AnyNode | Line | TemplateText | OpenTemplate | CloseTemplate} node
+       * @param {AnyNode
+       *   | Line
+       *   | TemplateText
+       *   | OpenTemplate
+       *   | CloseTemplate} node
        * @returns {string}
        */
       function getActualIndent(node) {
@@ -237,9 +255,7 @@ module.exports = {
         return line.slice(0, column);
       }
 
-      /**
-       * @returns {string}
-       */
+      /** @returns {string} */
       function getExpectedIndent() {
         let base = "";
         if (indentType === "space") {
@@ -284,7 +300,11 @@ module.exports = {
       }
 
       /**
-       * @param {AnyNode | Line | TemplateText | OpenTemplate | CloseTemplate} node
+       * @param {AnyNode
+       *   | Line
+       *   | TemplateText
+       *   | OpenTemplate
+       *   | CloseTemplate} node
        */
       function checkIndent(node) {
         if (parentIgnoringChildCount > 0) {
@@ -309,9 +329,7 @@ module.exports = {
         }
       }
 
-      /**
-       * @type {RuleListener}
-       */
+      /** @type {RuleListener} */
       const commentVisitor = {
         Comment(node) {
           indentLevel.indent(node);
@@ -319,22 +337,13 @@ module.exports = {
         CommentOpen: checkIndent,
         CommentContent(node) {
           indentLevel.indent(node);
-          if (hasTemplate(node)) {
-            node.parts.forEach((part) => {
-              if (part.type !== NODE_TYPES.Part) {
-                if (part.open) {
-                  checkIndent(part.open);
-                }
-                if (part.close) {
-                  checkIndent(part.close);
-                }
-              }
-            });
-          }
-
           const lineNodes = splitToLineNodes(node);
           lineNodes.forEach((lineNode) => {
-            if (lineNode.hasTemplate) {
+            if (
+              lineNode.isOverlapTemplate &&
+              !lineNode.hasCloseTemplate &&
+              !lineNode.hasOpenTemplate
+            ) {
               return;
             }
             if (lineNode.value.trim().length) {
@@ -351,9 +360,7 @@ module.exports = {
         },
       };
 
-      /**
-       * @type {RuleListener}
-       */
+      /** @type {RuleListener} */
       const visitor = {
         Tag(node) {
           if (IGNORING_NODES.includes(node.name)) {
@@ -401,23 +408,13 @@ module.exports = {
         },
         Text(node) {
           indentLevel.indent(node);
-          if (hasTemplate(node)) {
-            node.parts.forEach((part) => {
-              if (part.type !== NODE_TYPES.Part) {
-                if (part.open) {
-                  checkIndent(part.open);
-                }
-                if (part.close) {
-                  checkIndent(part.close);
-                }
-              }
-            });
-          }
-
           const lineNodes = splitToLineNodes(node);
-
           lineNodes.forEach((lineNode) => {
-            if (lineNode.hasTemplate) {
+            if (
+              lineNode.isOverlapTemplate &&
+              !lineNode.hasCloseTemplate &&
+              !lineNode.hasOpenTemplate
+            ) {
               return;
             }
             if (lineNode.value.trim().length) {
@@ -464,7 +461,7 @@ module.exports = {
 /**
  * @param {AnyNodeOrLine | TemplateText | OpenTemplate | CloseTemplate} node
  * @param {string} actualIndent
- * @return {{range: AST.Range; loc: AST.SourceLocation}}
+ * @returns {{ range: AST.Range; loc: AST.SourceLocation }}
  */
 function getIndentNodeToReport(node, actualIndent) {
   let rangeStart = node.range[0];
@@ -498,13 +495,11 @@ function countLeftPadding(str) {
 
 /**
  * @param {Context<any[]>} context
- * @return {IndentOptionInfo}
+ * @returns {IndentOptionInfo}
  */
 function getIndentOptionInfo(context) {
   const options = context.options;
-  /**
-   * @type {IndentType['SPACE'] | IndentType['TAB']}
-   */
+  /** @type {IndentType["SPACE"] | IndentType["TAB"]} */
   let indentType = INDENT_TYPES.SPACE;
   let indentSize = 4;
   if (options.length) {

package/lib/rules/index.js

@@ -53,6 +53,9 @@ const noInvalidEntity = require("./no-invalid-entity");
 const noDuplicateInHead = require("./no-duplicate-in-head");
 const noIneffectiveAttrs = require("./no-ineffective-attrs");
 const noRestrictedTags = require("./no-restricted-tags");
+const noWhitespaceOnlyChildren = require("./no-whitespace-only-children");
+const noObsoleteAttrs = require("./no-obsolete-attrs");
+const classSpacing = require("./class-spacing");
 // import new rule here ↑
 // DO NOT REMOVE THIS COMMENT
 
@@ -112,11 +115,14 @@ const rules = {
   "no-duplicate-in-head": noDuplicateInHead,
   "no-ineffective-attrs": noIneffectiveAttrs,
   "no-restricted-tags": noRestrictedTags,
+  "no-whitespace-only-children": noWhitespaceOnlyChildren,
+  "no-obsolete-attrs": noObsoleteAttrs,
+  "class-spacing": classSpacing,
   // export new rule here ↑
   // DO NOT REMOVE THIS COMMENT
 };
 
 module.exports =
-  /** @type {Record<string, import('@eslint/core').RuleDefinition>} */ (
+  /** @type {Record<string, import("@eslint/core").RuleDefinition>} */ (
     /** @type {unknown} */ (rules)
   );

package/lib/rules/lowercase.js

@@ -1,11 +1,11 @@
 /**
  * @import {
- *   Tag,
- *   StyleTag,
- *   ScriptTag,
  *   Doctype,
- * } from "@html-eslint/types";
- * @import {RuleModule} from "../types";
+ *   ScriptTag,
+ *   StyleTag,
+ *   Tag
+ * } from "@html-eslint/types"
+ * @import {RuleModule} from "../types"
  */
 
 const { RULE_CATEGORY } = require("../constants");
@@ -18,9 +18,7 @@ const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
 };
 
-/**
- * @type {RuleModule<[]>}
- */
+/** @type {RuleModule<[]>} */
 module.exports = {
   meta: {
     type: "suggestion",
@@ -41,14 +39,10 @@ module.exports = {
 
   create(context) {
     const allowedAttrKeySet = new Set(SVG_CAMEL_CASE_ATTRIBUTES);
-    /**
-     * @type {Tag[]}
-     */
+    /** @type {Tag[]} */
     const svgStack = [];
 
-    /**
-     * @param {Tag} node
-     */
+    /** @param {Tag} node */
     function enterSvg(node) {
       svgStack.push(node);
     }
@@ -65,18 +59,14 @@ module.exports = {
       return !!svgStack.length && allowedAttrKeySet.has(key);
     }
 
-    /**
-     * @param {Tag | StyleTag | ScriptTag} node
-     */
+    /** @param {Tag | StyleTag | ScriptTag} node */
     function nameOf(node) {
       if (isScript(node)) return "script";
       if (isStyle(node)) return "style";
       return node.name;
     }
 
-    /**
-     * @param {Tag | StyleTag | ScriptTag} node
-     */
+    /** @param {Tag | StyleTag | ScriptTag} node */
     function check(node) {
       const raw = node.openStart.value.slice(1);
       const name = nameOf(node);
@@ -133,9 +123,7 @@ module.exports = {
       }
     }
 
-    /**
-     * @param {Doctype} doctype
-     */
+    /** @param {Doctype} doctype */
     function checkDoctype(doctype) {
       if (doctype.open.value !== doctype.open.value.toLowerCase()) {
         context.report({

package/lib/rules/max-element-depth.js

@@ -1,7 +1,10 @@
 /**
- * @import {Tag, StyleTag, ScriptTag} from "@html-eslint/types";
- * @import {RuleModule} from "../types";
- *
+ * @import {
+ *   ScriptTag,
+ *   StyleTag,
+ *   Tag
+ * } from "@html-eslint/types"
+ * @import {RuleModule} from "../types"
  * @typedef {Object} Option
  * @property {number} [Option.max]
  */
@@ -14,9 +17,7 @@ const MESSAGE_IDS = {
   MAX_DEPTH_EXCEEDED: "maxDepthExceeded",
 };
 
-/**
- * @type {RuleModule<[Option]>}
- */
+/** @type {RuleModule<[Option]>} */
 module.exports = {
   meta: {
     type: "code",
@@ -63,10 +64,7 @@ module.exports = {
       depth = 0;
     }
 
-    /**
-     *
-     * @param {Tag | ScriptTag | StyleTag} node
-     */
+    /** @param {Tag | ScriptTag | StyleTag} node */
     function increaseDepth(node) {
       depth++;
       if (depth > maxDepth) {

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

@@ -1,6 +1,10 @@
 /**
- * @import {Tag, StyleTag, ScriptTag} from "@html-eslint/types";
- * @import {RuleModule} from "../types";
+ * @import {
+ *   ScriptTag,
+ *   StyleTag,
+ *   Tag
+ * } from "@html-eslint/types"
+ * @import {RuleModule} from "../types"
  */
 
 const { RULE_CATEGORY } = require("../constants");
@@ -27,9 +31,7 @@ const ABSTRACT_ROLE_SET = new Set([
   "window",
 ]);
 
-/**
- * @type {RuleModule<[]>}
- */
+/** @type {RuleModule<[]>} */
 module.exports = {
   meta: {
     type: "code",
@@ -49,9 +51,7 @@ module.exports = {
   },
 
   create(context) {
-    /**
-     * @param {Tag | ScriptTag | StyleTag} node
-     */
+    /** @param {Tag | ScriptTag | StyleTag} node */
     function check(node) {
       const roleAttr = findAttr(node, "role");
       if (

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

@@ -1,6 +1,10 @@
 /**
- * @import {Tag, StyleTag, ScriptTag} from "@html-eslint/types";
- * @import {RuleModule} from "../types";
+ * @import {
+ *   ScriptTag,
+ *   StyleTag,
+ *   Tag
+ * } from "@html-eslint/types"
+ * @import {RuleModule} from "../types"
  */
 
 const { RULE_CATEGORY } = require("../constants");
@@ -12,9 +16,7 @@ const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
 };
 
-/**
- * @type {RuleModule<[]>}
- */
+/** @type {RuleModule<[]>} */
 module.exports = {
   meta: {
     type: "code",
@@ -34,9 +36,7 @@ module.exports = {
   },
 
   create(context) {
-    /**
-     * @param {Tag | ScriptTag | StyleTag} node
-     */
+    /** @param {Tag | ScriptTag | StyleTag} node */
     function check(node) {
       const accessKeyAttr = findAttr(node, "accesskey");
       if (accessKeyAttr) {

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

@@ -1,6 +1,4 @@
-/**
- * @import {RuleModule} from "../types";
- */
+/** @import {RuleModule} from "../types" */
 
 const { RULE_CATEGORY } = require("../constants");
 const { findAttr } = require("./utils/node");
@@ -11,9 +9,7 @@ const MESSAGE_IDS = {
   UNEXPECTED: "unexpected",
 };
 
-/**
- * @type {RuleModule<[]>}
- */
+/** @type {RuleModule<[]>} */
 module.exports = {
   meta: {
     type: "code",

package/lib/rules/no-aria-hidden-on-focusable.js

@@ -1,6 +1,6 @@
 /**
- * @import {Tag} from "@html-eslint/types";
- * @import {RuleModule} from "../types";
+ * @import {Tag} from "@html-eslint/types"
+ * @import {RuleModule} from "../types"
  */
 
 const { RULE_CATEGORY } = require("../constants");
@@ -27,9 +27,7 @@ const FOCUSABLE_ELEMENTS = new Set([
   "summary",
 ]);
 
-/**
- * @type {RuleModule<[]>}
- */
+/** @type {RuleModule<[]>} */
 module.exports = {
   meta: {
     type: "code",
@@ -52,6 +50,7 @@ module.exports = {
   create(context) {
     /**
      * Checks if an element is focusable
+     *
      * @param {Tag} node
      * @returns {boolean}
      */

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

@@ -1,6 +1,14 @@
 /**
- * @import {Tag, StyleTag, ScriptTag, Attribute} from "@html-eslint/types";
- * @import {RuleModule, SuggestionReportDescriptor} from "../types";
+ * @import {
+ *   Attribute,
+ *   ScriptTag,
+ *   StyleTag,
+ *   Tag
+ * } from "@html-eslint/types"
+ * @import {
+ *   RuleModule,
+ *   SuggestionReportDescriptor
+ * } from "../types"
  */
 
 const { RULE_CATEGORY } = require("../constants");
@@ -13,9 +21,7 @@ const MESSAGE_IDS = {
   REMOVE_ATTR: "removeAttr",
 };
 
-/**
- * @type {RuleModule<[]>}
- */
+/** @type {RuleModule<[]>} */
 module.exports = {
   meta: {
     type: "code",
@@ -55,9 +61,7 @@ module.exports = {
       ];
     }
 
-    /**
-     * @param {Tag | StyleTag | ScriptTag} node
-     */
+    /** @param {Tag | StyleTag | ScriptTag} node */
     function check(node) {
       if (Array.isArray(node.attributes)) {
         const attrsSet = new Set();

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

@@ -1,10 +1,10 @@
 /**
- * @import {AttributeValue} from "@html-eslint/types";
- * @import {RuleModule} from "../types";
+ * @import {AttributeValue} from "@html-eslint/types"
+ * @import {RuleModule} from "../types"
  * @typedef {Object} ClassInfo
  * @property {string} name
- * @property {import("@html-eslint/types").AnyNode['loc']} loc
- * @property {import("@html-eslint/types").AnyNode['range']} range
+ * @property {import("@html-eslint/types").AnyNode["loc"]} loc
+ * @property {import("@html-eslint/types").AnyNode["range"]} range
  */
 
 const { NODE_TYPES } = require("@html-eslint/parser");
@@ -16,9 +16,7 @@ const MESSAGE_IDS = {
   DUPLICATE_CLASS: "duplicateClass",
 };
 
-/**
- * @type {RuleModule<[]>}
- */
+/** @type {RuleModule<[]>} */
 module.exports = {
   meta: {
     type: "code",
@@ -38,17 +36,13 @@ module.exports = {
   create(context) {
     /**
      * @param {AttributeValue} value
-     * @returns {{value: string, pos: number}[]}
+     * @returns {{ value: string; pos: number }[]}
      */
     function splitClassAndSpaces(value) {
-      /**
-       * @type {{value: string, pos: number}[]}
-       */
+      /** @type {{ value: string; pos: number }[]} */
       const result = [];
       const regex = /(\s+|\S+)/g;
-      /**
-       * @type {RegExpExecArray | null}
-       */
+      /** @type {RegExpExecArray | null} */
       let match = null;
 
       while ((match = regex.exec(value.value)) !== null) {

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

@@ -1,6 +1,9 @@
 /**
- * @import {Tag, AttributeValue} from "@html-eslint/types";
- * @import {RuleModule} from "../types";
+ * @import {
+ *   AttributeValue,
+ *   Tag
+ * } from "@html-eslint/types"
+ * @import {RuleModule} from "../types"
  */
 
 const { parseTemplateLiteral } = require("./utils/template-literal");
@@ -17,9 +20,7 @@ const MESSAGE_IDS = {
   DUPLICATE_ID: "duplicateId",
 };
 
-/**
- * @type {RuleModule<[]>}
- */
+/** @type {RuleModule<[]>} */
 module.exports = {
   meta: {
     type: "code",
@@ -40,13 +41,9 @@ module.exports = {
 
   create(context) {
     const htmlIdAttrsMap = new Map();
-    /**
-     * @param {Map<string, AttributeValue[]>} map
-     */
+    /** @param {Map<string, AttributeValue[]>} map */
     function createTagVisitor(map) {
-      /**
-       * @param {Tag} node
-       */
+      /** @param {Tag} node */
       return function (node) {
         if (!node.attributes || node.attributes.length <= 0) {
           return;
@@ -64,10 +61,7 @@ module.exports = {
       };
     }
 
-    /**
-     *
-     * @param {Map<string, AttributeValue[]>} map
-     */
+    /** @param {Map<string, AttributeValue[]>} map */
     function report(map) {
       map.forEach((attrs) => {
         if (Array.isArray(attrs) && attrs.length > 1) {

package/lib/rules/no-duplicate-in-head.js

@@ -1,6 +1,6 @@
 /**
- * @import {Tag} from "@html-eslint/types";
- * @import {RuleModule} from "../types";
+ * @import {Tag} from "@html-eslint/types"
+ * @import {RuleModule} from "../types"
  */
 
 const { parseTemplateLiteral } = require("./utils/template-literal");
@@ -18,8 +18,9 @@ const MESSAGE_IDS = {
 };
 
 /**
- * Returns a formatted string representing a tag's key detail.
- * E.g., meta[charset=UTF-8], meta[name=viewport], link[rel=canonical]
+ * Returns a formatted string representing a tag's key detail. E.g.,
+ * meta[charset=UTF-8], meta[name=viewport], link[rel=canonical]
+ *
  * @param {Tag} node
  * @returns {string | null}
  */
@@ -58,9 +59,7 @@ function getTrackingKey(node) {
   return null;
 }
 
-/**
- * @type {RuleModule<[]>}
- */
+/** @type {RuleModule<[]>} */
 module.exports = {
   meta: {
     type: "code",
@@ -83,13 +82,11 @@ module.exports = {
 
     /**
      * @param {Map<string, Tag[]>} map
-     * @param {{count: number}|null} headCountRef
+     * @param {{ count: number } | null} headCountRef
      */
     function createTagVisitor(map, headCountRef = null) {
       return {
-        /**
-         * @param {Tag} node
-         */
+        /** @param {Tag} node */
         Tag(node) {
           const tagName = node.name.toLowerCase();
 
@@ -119,9 +116,7 @@ module.exports = {
           }
         },
 
-        /**
-         * @param {Tag} node
-         */
+        /** @param {Tag} node */
         "Tag:exit"(node) {
           const tagName = node.name.toLowerCase();
           if (tagName === "head") {
@@ -135,9 +130,7 @@ module.exports = {
       };
     }
 
-    /**
-     * @param {Map<string, Tag[]>} map
-     */
+    /** @param {Map<string, Tag[]>} map */
     function report(map) {
       map.forEach((tags, tagKey) => {
         if (Array.isArray(tags) && tags.length > 1) {