@html-eslint/eslint-plugin 0.50.0 → 0.51.0

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-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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@html-eslint/eslint-plugin",
-  "version": "0.50.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.50.0",
-    "@html-eslint/template-parser": "^0.50.0",
-    "@html-eslint/template-syntax-parser": "^0.50.0",
-    "@html-eslint/types": "^0.50.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": "68100e43c5da0e3edb3d288f428a18d729d981d3"
+  "gitHead": "fcf6a16bcd2d74ca1b3037d0729a30a852dff494"
 }

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