@html-eslint/eslint-plugin 0.49.0 → 0.51.0

package/lib/rules/indent/indent.js

@@ -19,6 +19,7 @@
  * @property {number} [Option2.Attribute]
  * @property {Record<string, number>} [Option2.tagChildrenIndent]
  * @property {boolean} [Option2.ignoreComment]
+ * @property {"first" | "templateTag"} [Option2.templateIndentBase]
  */
 
 const { parseTemplateLiteral } = require("../utils/template-literal");
@@ -102,6 +103,11 @@ module.exports = {
             type: "boolean",
             default: false,
           },
+          templateIndentBase: {
+            type: "string",
+            enum: ["first", "templateTag"],
+            default: "templateTag",
+          },
         },
         additionalProperties: false,
       },
@@ -116,6 +122,7 @@ module.exports = {
     const indentLevelOptions = (context.options && context.options[1]) || {};
     const lines = sourceCode.getLines();
     const ignoreComment = indentLevelOptions.ignoreComment === true;
+    const autoBaseIndent = indentLevelOptions.templateIndentBase === "first";
     const { indentType, indentSize, indentChar } = getIndentOptionInfo(context);
 
     /**
@@ -161,12 +168,35 @@ module.exports = {
       return 1;
     }
 
+    /**
+     * @param {TemplateLiteral} node
+     * @returns {number}
+     */
+    function getAutoBaseSpaces(node) {
+      if (!autoBaseIndent) {
+        return 0;
+      }
+      const startLineIndex = node.loc.start.line;
+      const endLineIndex = node.loc.end.line - 1;
+      const templateLines = lines.slice(startLineIndex, endLineIndex);
+      for (let i = 0; i < templateLines.length; i++) {
+        const line = templateLines[i];
+        if (line.trim()) {
+          return countLeftPadding(line);
+        }
+      }
+      return 0;
+    }
+
     /**
      *
      * @param {TemplateLiteral} node
      * @returns {number}
      */
     function getTemplateLiteralBaseIndentLevel(node) {
+      if (autoBaseIndent) {
+        return 0;
+      }
       // @ts-ignore
       const lineIndex = node.loc.start.line - 1;
       const line = lines[lineIndex];
@@ -181,8 +211,9 @@ module.exports = {
 
     /**
      * @param {number} baseLevel
+     * @param {number} baseSpaces
      */
-    function createIndentVisitor(baseLevel) {
+    function createIndentVisitor(baseLevel, baseSpaces) {
       const indentLevel = new IndentLevel({
         getIncreasingLevel,
       });
@@ -210,7 +241,14 @@ module.exports = {
        * @returns {string}
        */
       function getExpectedIndent() {
-        return indentChar.repeat(indentLevel.value());
+        let base = "";
+        if (indentType === "space") {
+          base = " ".repeat(baseSpaces);
+        } else {
+          base = indentChar.repeat(baseSpaces);
+        }
+
+        return base + indentChar.repeat(indentLevel.value());
       }
 
       /**
@@ -396,24 +434,26 @@ module.exports = {
     }
 
     return {
-      ...createIndentVisitor(0),
+      ...createIndentVisitor(0, 0),
       TaggedTemplateExpression(node) {
         if (shouldCheckTaggedTemplateExpression(node, context)) {
           const base = getTemplateLiteralBaseIndentLevel(node.quasi);
+          const baseSpaces = getAutoBaseSpaces(node.quasi);
           parseTemplateLiteral(
             node.quasi,
             getSourceCode(context),
-            createIndentVisitor(base)
+            createIndentVisitor(base, baseSpaces)
           );
         }
       },
       TemplateLiteral(node) {
         if (shouldCheckTemplateLiteral(node, context)) {
           const base = getTemplateLiteralBaseIndentLevel(node);
+          const baseSpaces = getAutoBaseSpaces(node);
           parseTemplateLiteral(
             node,
             getSourceCode(context),
-            createIndentVisitor(base)
+            createIndentVisitor(base, baseSpaces)
           );
         }
       },

package/lib/rules/index.js

@@ -53,6 +53,7 @@ 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");
 // import new rule here ↑
 // DO NOT REMOVE THIS COMMENT
 
@@ -112,6 +113,7 @@ const rules = {
   "no-duplicate-in-head": noDuplicateInHead,
   "no-ineffective-attrs": noIneffectiveAttrs,
   "no-restricted-tags": noRestrictedTags,
+  "no-whitespace-only-children": noWhitespaceOnlyChildren,
   // export new rule here ↑
   // DO NOT REMOVE THIS COMMENT
 };

package/lib/rules/no-empty-headings.js

@@ -36,18 +36,33 @@ function isRoleHeading(node) {
   return !!roleAttr && !!roleAttr.value && roleAttr.value.value === "heading";
 }
 
+/**
+ * @param {Tag} node
+ * @returns {string}
+ */
+function getAltText(node) {
+  if (node.name.toLowerCase() === "img") {
+    const altAttr = findAttr(node, "alt");
+    if (altAttr && altAttr.value && altAttr.value.value) {
+      return altAttr.value.value;
+    }
+  }
+  return "";
+}
+
 /**
  * @param {Text | Tag} node
  * @returns {string}
  */
 function getAllText(node) {
-  if (!isTag(node) || !node.children.length) return "";
+  if (!isTag(node)) return "";
+
   let text = "";
   for (const child of node.children) {
     if (isText(child)) {
       text += child.value.trim();
     } else if (isTag(child)) {
-      text += getAllText(child);
+      text += getAllText(child) || getAltText(child);
     }
   }
   return text;
@@ -64,7 +79,7 @@ function getAccessibleText(node) {
     if (isText(child)) {
       text += child.value.trim();
     } else if (isTag(child) && !isAriaHidden(child)) {
-      text += getAccessibleText(child);
+      text += getAccessibleText(child) || getAltText(child);
     }
   }
   return text;

package/lib/rules/no-whitespace-only-children.js

@@ -0,0 +1,114 @@
+/**
+ * @import {Tag, Text} from "@html-eslint/types";
+ * @import {RuleModule} from "../types";
+ */
+
+const { RULE_CATEGORY } = require("../constants");
+const { isText, isComment, getLocBetween } = require("./utils/node");
+const { createVisitors } = require("./utils/visitors");
+const { getRuleUrl } = require("./utils/rule");
+
+const MESSAGE_IDS = {
+  WHITESPACE_ONLY_CHILDREN: "whitespaceOnlyChildren",
+};
+
+/**
+ * @param {Tag} node
+ */
+function hasOnlyWhitespaceChildren(node) {
+  if (!node.children || node.children.length === 0) {
+    return false;
+  }
+
+  if (node.children.every((child) => isComment(child))) {
+    return false;
+  }
+
+  for (const child of node.children) {
+    if (isComment(child)) {
+      continue;
+    }
+    if (isText(child)) {
+      // Check if text contains any non-whitespace characters
+      if (child.value && child.value.trim().length > 0) {
+        return false;
+      }
+    } else {
+      return false;
+    }
+  }
+
+  return true;
+}
+
+/**
+ * @type {RuleModule<[{tagPatterns?: string[]}]>}
+ */
+module.exports = {
+  meta: {
+    type: "code",
+    docs: {
+      description: "Disallow tags with only whitespace children.",
+      recommended: false,
+      category: RULE_CATEGORY.BEST_PRACTICE,
+      url: getRuleUrl("no-whitespace-only-children"),
+    },
+    fixable: "whitespace",
+    schema: [
+      {
+        type: "object",
+        properties: {
+          tagPatterns: {
+            type: "array",
+            items: {
+              type: "string",
+            },
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
+    messages: {
+      [MESSAGE_IDS.WHITESPACE_ONLY_CHILDREN]:
+        "Tag should not have only whitespace children.",
+    },
+  },
+  create(context) {
+    const options = context.options[0] || {};
+    const tagPatterns = (options.tagPatterns || []).map(
+      (pattern) => new RegExp(pattern, "u")
+    );
+
+    return createVisitors(context, {
+      Tag(node) {
+        if (!node.close) {
+          return;
+        }
+        if (tagPatterns.length <= 0) {
+          return;
+        }
+
+        const tagName = node.name.toLowerCase();
+
+        // If tagPatterns is specified, check if tag name matches any pattern
+        const matches = tagPatterns.some((pattern) => pattern.test(tagName));
+        if (!matches) {
+          return;
+        }
+
+        if (hasOnlyWhitespaceChildren(node)) {
+          const loc = getLocBetween(node.openEnd, node.close);
+          context.report({
+            loc,
+            messageId: MESSAGE_IDS.WHITESPACE_ONLY_CHILDREN,
+            fix(fixer) {
+              return node.children
+                .filter((child) => isText(child))
+                .map((child) => fixer.removeRange(child.range));
+            },
+          });
+        }
+      },
+    });
+  },
+};

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

@@ -1,5 +1,5 @@
 /**
- * @import {Tag} from "@html-eslint/types";
+ * @import {ScriptTag, StyleTag, Tag} from "@html-eslint/types";
  * @import {RuleModule} from "../types";
  *
  * @typedef {Object} Option
@@ -10,6 +10,7 @@
 const { RULE_CATEGORY, VOID_ELEMENTS } = require("../constants");
 const { createVisitors } = require("./utils/visitors");
 const { getRuleUrl } = require("./utils/rule");
+const { getNameOf } = require("./utils/node");
 
 const VOID_ELEMENTS_SET = new Set(VOID_ELEMENTS);
 
@@ -76,14 +77,15 @@ module.exports = {
     );
 
     /**
-     * @param {Tag} node
+     * @param {Tag | ScriptTag | StyleTag} node
      */
-    function checkClosingTag(node) {
+    function checkClosing(node) {
+      const name = getNameOf(node);
       if (!node.close) {
         context.report({
           node: node,
           data: {
-            tag: node.name,
+            tag: name,
           },
           messageId: MESSAGE_IDS.MISSING,
         });
@@ -151,7 +153,7 @@ module.exports = {
         if (node.selfClosing || canSelfClose) {
           checkVoidElement(node, shouldSelfClose, canSelfClose);
         } else if (node.openEnd.value !== "/>") {
-          checkClosingTag(node);
+          checkClosing(node);
         }
         if (["svg", "math"].includes(node.name)) foreignContext.push(node.name);
       },
@@ -163,6 +165,16 @@ module.exports = {
           foreignContext.pop();
         }
       },
+      ScriptTag(node) {
+        if (!node.close) {
+          checkClosing(node);
+        }
+      },
+      StyleTag(node) {
+        if (!node.close) {
+          checkClosing(node);
+        }
+      },
     });
   },
 };

package/lib/rules/utils/node.js

@@ -247,6 +247,20 @@ function getTemplateTokens(tokens) {
   );
 }
 
+/**
+ * @param {Tag | ScriptTag | StyleTag} node
+ * @returns {string}
+ */
+function getNameOf(node) {
+  if (isScript(node)) {
+    return "script";
+  }
+  if (isStyle(node)) {
+    return "style";
+  }
+  return node.name;
+}
+
 module.exports = {
   findAttr,
   isAttributesEmpty,
@@ -266,4 +280,5 @@ module.exports = {
   getTemplateTokens,
   hasTemplate,
   hasAttr,
+  getNameOf,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@html-eslint/eslint-plugin",
-  "version": "0.49.0",
+  "version": "0.51.0",
   "type": "commonjs",
   "description": "ESLint plugin for HTML",
   "author": "yeonjuan",
@@ -40,10 +40,10 @@
   ],
   "dependencies": {
     "@eslint/plugin-kit": "^0.4.1",
-    "@html-eslint/parser": "^0.49.0",
-    "@html-eslint/template-parser": "^0.49.0",
-    "@html-eslint/template-syntax-parser": "^0.49.0",
-    "@html-eslint/types": "^0.49.0"
+    "@html-eslint/parser": "^0.51.0",
+    "@html-eslint/template-parser": "^0.51.0",
+    "@html-eslint/template-syntax-parser": "^0.51.0",
+    "@html-eslint/types": "^0.51.0"
   },
   "peerDependencies": {
     "eslint": "^8.0.0 || ^9.0.0"
@@ -59,5 +59,5 @@
   "engines": {
     "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
   },
-  "gitHead": "56d2df10793aa5014065a94815e865b753ccc76b"
+  "gitHead": "fcf6a16bcd2d74ca1b3037d0729a30a852dff494"
 }

package/types/rules/indent/indent.d.ts

@@ -21,6 +21,7 @@ type Option2 = {
     Attribute?: number | undefined;
     tagChildrenIndent?: Record<string, number> | undefined;
     ignoreComment?: boolean | undefined;
+    templateIndentBase?: "first" | "templateTag" | undefined;
 };
 import type { RuleModule } from "../../types";
 import type { AnyNode } from "@html-eslint/types";

package/types/rules/indent/indent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"indent.d.ts","sourceRoot":"","sources":["../../../lib/rules/indent/indent.js"],"names":[],"mappings":";;;wBAwDU,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;;qBAnD3B,OAAO,GAAG,IAAI;;SAEb,KAAK;WACL,OAAO;;;kBAEP,aAAa;;;gBAEb,UAAU,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC;gBACvC,MAAM;gBACN,MAAM;;eAEP,KAAK,GAAG,MAAM;;;;;;gCAd+B,aAAa;6BAD+C,oBAAoB;0BAChF,aAAa"}
+{"version":3,"file":"indent.d.ts","sourceRoot":"","sources":["../../../lib/rules/indent/indent.js"],"names":[],"mappings":";;;wBAyDU,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;;qBApD3B,OAAO,GAAG,IAAI;;SAEb,KAAK;WACL,OAAO;;;kBAEP,aAAa;;;gBAEb,UAAU,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,OAAO,CAAC;gBACvC,MAAM;gBACN,MAAM;;eAEP,KAAK,GAAG,MAAM;;;;;;;gCAd+B,aAAa;6BAD+C,oBAAoB;0BAChF,aAAa"}

package/types/rules/no-empty-headings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"no-empty-headings.d.ts","sourceRoot":"","sources":["../../lib/rules/no-empty-headings.js"],"names":[],"mappings":"wBAyEU,WAAW,EAAE,CAAC;;gCAvEK,UAAU"}
+{"version":3,"file":"no-empty-headings.d.ts","sourceRoot":"","sources":["../../lib/rules/no-empty-headings.js"],"names":[],"mappings":"wBAwFU,WAAW,EAAE,CAAC;;gCAtFK,UAAU"}

package/types/rules/no-whitespace-only-children.d.ts

@@ -0,0 +1,6 @@
+declare const _exports: RuleModule<[{
+    tagPatterns?: string[];
+}]>;
+export = _exports;
+import type { RuleModule } from "../types";
+//# sourceMappingURL=no-whitespace-only-children.d.ts.map

package/types/rules/no-whitespace-only-children.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-whitespace-only-children.d.ts","sourceRoot":"","sources":["../../lib/rules/no-whitespace-only-children.js"],"names":[],"mappings":"wBA4CU,WAAW,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAA;CAAC,CAAC,CAAC;;gCA1CnB,UAAU"}

package/types/rules/require-closing-tags.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"require-closing-tags.d.ts","sourceRoot":"","sources":["../../lib/rules/require-closing-tags.js"],"names":[],"mappings":";;;wBAsBU,WAAW,CAAC,MAAM,CAAC,CAAC;;;;;;gCApBD,UAAU"}
+{"version":3,"file":"require-closing-tags.d.ts","sourceRoot":"","sources":["../../lib/rules/require-closing-tags.js"],"names":[],"mappings":";;;wBAuBU,WAAW,CAAC,MAAM,CAAC,CAAC;;;;;;gCArBD,UAAU"}

package/types/rules/utils/node.d.ts

@@ -104,6 +104,11 @@ export function hasTemplate(node: AttributeKey | AttributeValue | Text | Comment
  * @returns {boolean}
  */
 export function hasAttr(node: Tag | ScriptTag, attrName: string): boolean;
+/**
+ * @param {Tag | ScriptTag | StyleTag} node
+ * @returns {string}
+ */
+export function getNameOf(node: Tag | ScriptTag | StyleTag): string;
 import type { Tag } from "@html-eslint/types";
 import type { ScriptTag } from "@html-eslint/types";
 import type { StyleTag } from "@html-eslint/types";

package/types/rules/utils/node.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../../lib/rules/utils/node.js"],"names":[],"mappings":"AAQA;;;;GAIG;AACH,+BAJW,GAAG,GAAG,SAAS,GAAG,QAAQ,OAC1B,MAAM,GACJ,SAAS,GAAG,SAAS,CAMjC;AAaD;;;;GAIG;AACH,wCAHW,GAAG,GAAG,SAAS,GAAG,QAAQ,GACxB,OAAO,CAInB;AAED;;;;GAIG;AACH,6CAHW,OAAO,GACL,OAAO,CAInB;AA+BD;;;;GAIG;AACH,uCAHW,IAAI,GAAG,cAAc,GACnB,IAAI,EAAE,CAwDlB;AAED;;;;;GAKG;AACH,sCAJW;IAAC,GAAG,EAAE,kBAAkB,CAAA;CAAC,SACzB;IAAC,GAAG,EAAE,kBAAkB,CAAA;CAAC,GACvB,kBAAkB,CAO9B;AA4DD;;;;GAIG;AACH,iCAJW,OAAO,aACP,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,GACxB,IAAI,GAAG,OAAO,CAiB1B;AA9ED;;;GAGG;AACH,4BAHW,QAAQ,GACN,IAAI,IAAI,GAAG,CAIvB;AAkBD;;;GAGG;AACH,gCAHW,QAAQ,GACN,IAAI,IAAI,OAAO,CAI3B;AAED;;;GAGG;AACH,6BAHW,QAAQ,GACN,IAAI,IAAI,IAAI,CAIxB;AAED;;;GAGG;AACH,6BAHW,QAAQ,GACN,IAAI,IAAI,IAAI,CAIxB;AAtCD;;;GAGG;AACH,+BAHW,QAAQ,GACN,IAAI,IAAI,SAAS,CAI7B;AAED;;;GAGG;AACH,8BAHW,QAAQ,GACN,IAAI,IAAI,QAAQ,CAI5B;AAnHD;;;;GAIG;AACH,8CAJW,CAAC,IAAI,GAAG,cAAc,CAAC,CAAC,OAAO,CAAC,SAChC,SAAS,GACP,OAAO,CAMnB;AAsID;;;GAGG;AACH,oCAHW,MAAM,GACJ,MAAM,EAAE,CAIpB;AA/JD;;;;;GAKG;AACH,wCAJW,SAAS,UACT,SAAS,GACP,OAAO,CAInB;AA+KD;;;;GAIG;AACH,0CAHW,QAAQ,EAAE,GACR,CAAC,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAaxD;AAlLD;;;GAGG;AACH,kCAHW,YAAY,GAAG,cAAc,GAAG,IAAI,GAAG,cAAc,GACnD,OAAO,CAInB;AAxDD;;;;GAIG;AACH,8BAJW,GAAG,GAAG,SAAS,YACf,MAAM,GACJ,OAAO,CAMnB;yBA3BqI,oBAAoB;+BAApB,oBAAoB;8BAApB,oBAAoB;+BAApB,oBAAoB;6BAApB,oBAAoB;0BAApB,oBAAoB;oCAApB,oBAAoB;0BACzH,aAAa;yBACxB,QAAQ;8BADG,aAAa;6BADwF,oBAAoB;8BAApB,oBAAoB;kCAApB,oBAAoB;oCAApB,oBAAoB"}
+{"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../../lib/rules/utils/node.js"],"names":[],"mappings":"AAQA;;;;GAIG;AACH,+BAJW,GAAG,GAAG,SAAS,GAAG,QAAQ,OAC1B,MAAM,GACJ,SAAS,GAAG,SAAS,CAMjC;AAaD;;;;GAIG;AACH,wCAHW,GAAG,GAAG,SAAS,GAAG,QAAQ,GACxB,OAAO,CAInB;AAED;;;;GAIG;AACH,6CAHW,OAAO,GACL,OAAO,CAInB;AA+BD;;;;GAIG;AACH,uCAHW,IAAI,GAAG,cAAc,GACnB,IAAI,EAAE,CAwDlB;AAED;;;;;GAKG;AACH,sCAJW;IAAC,GAAG,EAAE,kBAAkB,CAAA;CAAC,SACzB;IAAC,GAAG,EAAE,kBAAkB,CAAA;CAAC,GACvB,kBAAkB,CAO9B;AA4DD;;;;GAIG;AACH,iCAJW,OAAO,aACP,CAAC,IAAI,EAAE,OAAO,KAAK,OAAO,GACxB,IAAI,GAAG,OAAO,CAiB1B;AA9ED;;;GAGG;AACH,4BAHW,QAAQ,GACN,IAAI,IAAI,GAAG,CAIvB;AAkBD;;;GAGG;AACH,gCAHW,QAAQ,GACN,IAAI,IAAI,OAAO,CAI3B;AAED;;;GAGG;AACH,6BAHW,QAAQ,GACN,IAAI,IAAI,IAAI,CAIxB;AAED;;;GAGG;AACH,6BAHW,QAAQ,GACN,IAAI,IAAI,IAAI,CAIxB;AAtCD;;;GAGG;AACH,+BAHW,QAAQ,GACN,IAAI,IAAI,SAAS,CAI7B;AAED;;;GAGG;AACH,8BAHW,QAAQ,GACN,IAAI,IAAI,QAAQ,CAI5B;AAnHD;;;;GAIG;AACH,8CAJW,CAAC,IAAI,GAAG,cAAc,CAAC,CAAC,OAAO,CAAC,SAChC,SAAS,GACP,OAAO,CAMnB;AAsID;;;GAGG;AACH,oCAHW,MAAM,GACJ,MAAM,EAAE,CAIpB;AA/JD;;;;;GAKG;AACH,wCAJW,SAAS,UACT,SAAS,GACP,OAAO,CAInB;AA+KD;;;;GAIG;AACH,0CAHW,QAAQ,EAAE,GACR,CAAC,CAAC,cAAc,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,CAaxD;AAlLD;;;GAGG;AACH,kCAHW,YAAY,GAAG,cAAc,GAAG,IAAI,GAAG,cAAc,GACnD,OAAO,CAInB;AAxDD;;;;GAIG;AACH,8BAJW,GAAG,GAAG,SAAS,YACf,MAAM,GACJ,OAAO,CAMnB;AA6ND;;;GAGG;AACH,gCAHW,GAAG,GAAG,SAAS,GAAG,QAAQ,GACxB,MAAM,CAUlB;yBApQqI,oBAAoB;+BAApB,oBAAoB;8BAApB,oBAAoB;+BAApB,oBAAoB;6BAApB,oBAAoB;0BAApB,oBAAoB;oCAApB,oBAAoB;0BACzH,aAAa;yBACxB,QAAQ;8BADG,aAAa;6BADwF,oBAAoB;8BAApB,oBAAoB;kCAApB,oBAAoB;oCAApB,oBAAoB"}