@html-eslint/eslint-plugin 0.29.0 → 0.30.0

package/lib/rules/indent.js

@@ -4,6 +4,10 @@
  * @typedef { import("../types").LineNode } LineNode
  * @typedef { import("../types").BaseNode } BaseNode
  * @typedef { import("../types").TagNode } TagNode
+ * @typedef { import("../types").RuleListener } RuleListener
+ * @typedef { import("eslint").AST.Token } Token
+ * @typedef { import("eslint").SourceCode } SourceCode
+ * @typedef { import("estree").TemplateLiteral } TemplateLiteral
  * @typedef {Object} IndentType
  * @property {"tab"} TAB
  * @property {"space"} SPACE
@@ -11,10 +15,14 @@
  * @property {"wrongIndent"} WRONG_INDENT
  */
 
+const { parse } = require("@html-eslint/template-parser");
 const { RULE_CATEGORY } = require("../constants");
 const { splitToLineNodes } = require("./utils/node");
+const {
+  shouldCheckTaggedTemplateExpression,
+  shouldCheckTemplateLiteral,
+} = require("./utils/settings");
 const { getSourceCode } = require("./utils/source-code");
-const { createVisitors } = require("./utils/visitors");
 
 /** @type {MessageId} */
 const MESSAGE_ID = {
@@ -63,6 +71,8 @@ module.exports = {
   },
   create(context) {
     const sourceCode = getSourceCode(context);
+
+    let baseIndentLevel = 0;
     let indentLevel = -1;
     let parentIgnoringChildCount = 0;
 
@@ -91,6 +101,9 @@ module.exports = {
     function unindent() {
       indentLevel--;
     }
+    function getIndentLevel() {
+      return indentLevel + baseIndentLevel;
+    }
 
     /**
      * @param {string} str
@@ -128,7 +141,7 @@ module.exports = {
      * @returns {string}
      */
     function getExpectedIndent() {
-      return indentChar.repeat(indentLevel);
+      return indentChar.repeat(getIndentLevel());
     }
 
     /**
@@ -199,6 +212,7 @@ module.exports = {
       }
       const actualIndent = getActualIndent(node);
       const expectedIndent = getExpectedIndent();
+
       if (actualIndent.trim().length) {
         return;
       }
@@ -207,7 +221,7 @@ module.exports = {
         context.report({
           node: targetNode,
           messageId: MESSAGE_ID.WRONG_INDENT,
-          data: getMessageData(actualIndent, indentLevel),
+          data: getMessageData(actualIndent, getIndentLevel()),
           fix(fixer) {
             return fixer.replaceText(targetNode, expectedIndent);
           },
@@ -215,7 +229,58 @@ module.exports = {
       }
     }
 
-    return createVisitors(context, {
+    /**
+     *
+     * @param {Token} token
+     */
+    function getBaseIndentToken(token) {
+      /**
+       * @type {Token | null}
+       */
+      let currentToken = token;
+      let tokenBefore = token;
+
+      while (
+        // @ts-ignore
+        (tokenBefore = sourceCode.getTokenBefore(currentToken, {
+          includeComments: true,
+        }))
+      ) {
+        if (!tokenBefore) {
+          return currentToken;
+        }
+        if (tokenBefore.loc.start.line !== currentToken.loc.start.line) {
+          return currentToken;
+        }
+        currentToken = tokenBefore;
+      }
+      return tokenBefore;
+    }
+
+    /**
+     *
+     * @param {TemplateLiteral} node
+     * @returns {number}
+     */
+    function getBaseIndentLevel(node) {
+      const firstToken = sourceCode.getFirstToken(node);
+      if (!firstToken) return 0;
+      const baseToken = getBaseIndentToken(firstToken);
+      if (!baseToken) {
+        return 0;
+      }
+      const spaceCount = baseToken.loc.start.column;
+
+      if (indentType === "space") {
+        return Math.floor(spaceCount / indentSize);
+      } else {
+        return spaceCount;
+      }
+    }
+    /**
+     * @type {RuleListener}
+     */
+    const visitor = {
       Tag(node) {
         if (IGNORING_NODES.includes(node.name)) {
           parentIgnoringChildCount++;
@@ -282,6 +347,32 @@ module.exports = {
       CommentClose: checkIndent,
       "Comment:exit": unindent,
       "CommentContent:exit": unindent,
-    });
+    };
+
+    return {
+      ...visitor,
+      TaggedTemplateExpression(node) {
+        if (shouldCheckTaggedTemplateExpression(node, context)) {
+          baseIndentLevel = getBaseIndentLevel(node.quasi) + 1;
+          parse(node.quasi, getSourceCode(context), visitor);
+        }
+      },
+      "TaggedTemplateExpression:exit"(node) {
+        if (shouldCheckTaggedTemplateExpression(node, context)) {
+          baseIndentLevel = 0;
+        }
+      },
+      TemplateLiteral(node) {
+        if (shouldCheckTemplateLiteral(node, context)) {
+          baseIndentLevel = getBaseIndentLevel(node) + 1;
+          parse(node, getSourceCode(context), visitor);
+        }
+      },
+      "TemplateLiteral:exit"(node) {
+        if (shouldCheckTemplateLiteral(node, context)) {
+          baseIndentLevel = 0;
+        }
+      },
+    };
   },
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@html-eslint/eslint-plugin",
-  "version": "0.29.0",
+  "version": "0.30.0",
   "description": "ESLint plugin for html",
   "author": "yeonjuan",
   "homepage": "https://github.com/yeonjuan/html-eslint#readme",
@@ -45,15 +45,15 @@
     "accessibility"
   ],
   "dependencies": {
-    "@html-eslint/template-parser": "^0.29.0"
+    "@html-eslint/template-parser": "^0.30.0"
   },
   "devDependencies": {
-    "@html-eslint/parser": "^0.29.0",
+    "@html-eslint/parser": "^0.30.0",
     "@types/eslint": "^9.6.1",
     "@types/estree": "^0.0.47",
     "es-html-parser": "^1.0.0-alpha.4",
     "espree": "^10.3.0",
     "typescript": "^5.7.2"
   },
-  "gitHead": "e8908db01b8bd4a682227a2144c0dd5588fc347e"
+  "gitHead": "29f274f996d9cd41b82f2f2fa5c642564d3bc756"
 }

package/types/rules/indent.d.ts

@@ -1,5 +1,5 @@
 declare namespace _exports {
-    export { RuleModule, AnyNode, LineNode, BaseNode, TagNode, IndentType, MessageId };
+    export { RuleModule, AnyNode, LineNode, BaseNode, TagNode, RuleListener, Token, SourceCode, TemplateLiteral, IndentType, MessageId };
 }
 declare const _exports: RuleModule;
 export = _exports;
@@ -8,6 +8,10 @@ type AnyNode = import("../types").AnyNode;
 type LineNode = import("../types").LineNode;
 type BaseNode = import("../types").BaseNode;
 type TagNode = import("../types").TagNode;
+type RuleListener = import("../types").RuleListener;
+type Token = import("eslint").AST.Token;
+type SourceCode = import("eslint").SourceCode;
+type TemplateLiteral = import("estree").TemplateLiteral;
 type IndentType = {
     TAB: "tab";
     SPACE: "space";

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

@@ -1 +1 @@
-{"version":3,"file":"indent.d.ts","sourceRoot":"","sources":["../../lib/rules/indent.js"],"names":[],"mappings":";;;wBAgCU,UAAU;;kBA/BN,OAAO,UAAU,EAAE,UAAU;eAC7B,OAAO,UAAU,EAAE,OAAO;gBAC1B,OAAO,UAAU,EAAE,QAAQ;gBAC3B,OAAO,UAAU,EAAE,QAAQ;eAC3B,OAAO,UAAU,EAAE,OAAO;;SAE1B,KAAK;WACL,OAAO;;;kBAEP,aAAa"}
+{"version":3,"file":"indent.d.ts","sourceRoot":"","sources":["../../lib/rules/indent.js"],"names":[],"mappings":";;;wBAwCU,UAAU;;kBAvCN,OAAO,UAAU,EAAE,UAAU;eAC7B,OAAO,UAAU,EAAE,OAAO;gBAC1B,OAAO,UAAU,EAAE,QAAQ;gBAC3B,OAAO,UAAU,EAAE,QAAQ;eAC3B,OAAO,UAAU,EAAE,OAAO;oBAC1B,OAAO,UAAU,EAAE,YAAY;aAC/B,OAAO,QAAQ,EAAE,GAAG,CAAC,KAAK;kBAC1B,OAAO,QAAQ,EAAE,UAAU;uBAC3B,OAAO,QAAQ,EAAE,eAAe;;SAEhC,KAAK;WACL,OAAO;;;kBAEP,aAAa"}