eslint-plugin-kirklin 1.1.0 → 1.3.0

package/dist/index.cjs

@@ -1,6 +1,6 @@
 'use strict';
 
-const version = "1.1.0";
+const version = "1.3.0";
 
 const hasDocs = [
   "consistent-list-newline",
@@ -49,6 +49,27 @@ function createRule({
 const createEslintRule = RuleCreator(
   (ruleName) => hasDocs.includes(ruleName) ? `${blobUrl}${ruleName}.md` : `${blobUrl}${ruleName}.test.ts`
 );
+const _reFullWs = /^\s*$/;
+function unindent(str) {
+  const lines = (typeof str === "string" ? str : str[0]).split("\n");
+  const whitespaceLines = lines.map((line) => _reFullWs.test(line));
+  const commonIndent = lines.reduce((min, line, idx) => {
+    if (whitespaceLines[idx]) {
+      return min;
+    }
+    const indent = line.match(/^\s*/)?.[0].length;
+    return indent === void 0 ? min : Math.min(min, indent);
+  }, Number.POSITIVE_INFINITY);
+  let emptyLinesHead = 0;
+  while (emptyLinesHead < lines.length && whitespaceLines[emptyLinesHead]) {
+    emptyLinesHead++;
+  }
+  let emptyLinesTail = 0;
+  while (emptyLinesTail < lines.length && whitespaceLines[lines.length - emptyLinesTail - 1]) {
+    emptyLinesTail++;
+  }
+  return lines.slice(emptyLinesHead, lines.length - emptyLinesTail).map((line) => line.slice(commonIndent)).join("\n");
+}
 
 const RULE_NAME$6 = "if-newline";
 const ifNewline = createEslintRule({
@@ -351,7 +372,8 @@ const consistentListNewline = createEslintRule({
         TSTypeParameterDeclaration: { type: "boolean" },
         TSTypeParameterInstantiation: { type: "boolean" },
         ObjectPattern: { type: "boolean" },
-        ArrayPattern: { type: "boolean" }
+        ArrayPattern: { type: "boolean" },
+        JSXOpeningElement: { type: "boolean" }
       },
       additionalProperties: false
     }],
@@ -372,7 +394,10 @@ const consistentListNewline = createEslintRule({
       if (items.length === 0) {
         return;
       }
-      const startToken = context.sourceCode.getTokenBefore(items[0]);
+      let startToken = ["CallExpression", "NewExpression"].includes(node.type) ? void 0 : context.sourceCode.getFirstToken(node);
+      if (startToken?.type !== "Punctuator") {
+        startToken = context.sourceCode.getTokenBefore(items[0]);
+      }
       const endToken = context.sourceCode.getTokenAfter(items[items.length - 1]);
       const startLine = startToken.loc.start.line;
       if (startToken.loc.start.line === endToken.loc.end.line) {
@@ -400,16 +425,22 @@ const consistentListNewline = createEslintRule({
           });
         } else if (mode === "inline" && currentStart !== lastLine) {
           const lastItem2 = items[idx - 1];
-          context.report({
-            node: item,
-            messageId: "shouldNotWrap",
-            data: {
-              name: node.type
-            },
-            *fix(fixer) {
-              yield removeLines(fixer, lastItem2.range[1], item.range[0]);
-            }
-          });
+          if (context.sourceCode.getCommentsBefore(item).length > 0) {
+            return;
+          }
+          const content = context.sourceCode.text.slice(lastItem2.range[1], item.range[0]);
+          if (content.includes("\n")) {
+            context.report({
+              node: item,
+              messageId: "shouldNotWrap",
+              data: {
+                name: node.type
+              },
+              *fix(fixer) {
+                yield removeLines(fixer, lastItem2.range[1], item.range[0]);
+              }
+            });
+          }
         }
         lastLine = item.loc.end.line;
       });
@@ -434,6 +465,9 @@ const consistentListNewline = createEslintRule({
         if (items.length === 1 && items[0].loc.start.line !== items[1]?.loc.start.line) {
           return;
         }
+        if (context.sourceCode.getCommentsAfter(lastItem).length > 0) {
+          return;
+        }
         const content = context.sourceCode.text.slice(lastItem.range[1], endRange);
         if (content.includes("\n")) {
           context.report({
@@ -512,6 +546,12 @@ const consistentListNewline = createEslintRule({
       },
       ArrayPattern(node) {
         check(node, node.elements);
+      },
+      JSXOpeningElement(node) {
+        if (node.attributes.some((attr) => attr.loc.start.line !== attr.loc.end.line)) {
+          return;
+        }
+        check(node, node.attributes);
       }
     };
     Object.keys(options).forEach((key) => {
@@ -523,17 +563,93 @@ const consistentListNewline = createEslintRule({
   }
 });
 
+const indentUnindent = createEslintRule({
+  name: "indent-unindent",
+  meta: {
+    type: "layout",
+    docs: {
+      description: "Enforce consistent indentation in `unindent` template tag"
+    },
+    fixable: "code",
+    schema: [
+      {
+        type: "object",
+        properties: {
+          indent: {
+            type: "number",
+            minimum: 0,
+            default: 2
+          },
+          tags: {
+            type: "array",
+            items: {
+              type: "string"
+            }
+          }
+        },
+        additionalProperties: false
+      }
+    ],
+    messages: {
+      "indent-unindent": "Consistent indentation in unindent tag"
+    }
+  },
+  defaultOptions: [{}],
+  create(context) {
+    const {
+      tags = ["$", "unindent", "unIndent"],
+      indent = 2
+    } = context.options?.[0] ?? {};
+    return {
+      TaggedTemplateExpression(node) {
+        const id = node.tag;
+        if (!id || id.type !== "Identifier") {
+          return;
+        }
+        if (!tags.includes(id.name)) {
+          return;
+        }
+        if (node.quasi.quasis.length !== 1) {
+          return;
+        }
+        const quasi = node.quasi.quasis[0];
+        const value = quasi.value.raw;
+        const lineStartIndex = context.sourceCode.getIndexFromLoc({
+          line: node.loc.start.line,
+          column: 0
+        });
+        const baseIndent = context.sourceCode.text.slice(lineStartIndex).match(/^\s*/)?.[0] ?? "";
+        const targetIndent = baseIndent + " ".repeat(indent);
+        const pure = unindent([value]);
+        let final = pure.split("\n").map((line) => targetIndent + line).join("\n");
+        final = `
+${final}
+${baseIndent}`;
+        if (final !== value) {
+          context.report({
+            node: quasi,
+            messageId: "indent-unindent",
+            fix: (fixer) => fixer.replaceText(quasi, `\`${final}\``)
+          });
+        }
+      }
+    };
+  }
+});
+
 const plugin = {
   meta: {
     name: "kirklin",
     version
   },
+  // @keep-sorted
   rules: {
     "consistent-list-newline": consistentListNewline,
     "if-newline": ifNewline,
     "import-dedupe": importDedupe,
-    "no-import-node-modules-by-path": noImportNodeModulesByPath,
+    "indent-unindent": indentUnindent,
     "no-import-dist": noImportDist,
+    "no-import-node-modules-by-path": noImportNodeModulesByPath,
     "no-ts-export-equal": noTsExportEqual,
     "top-level-function": topLevelFunction
   }

package/dist/index.d.cts

@@ -4,6 +4,13 @@ interface RuleModule<T extends readonly unknown[]> extends Rule.RuleModule {
     defaultOptions: T;
 }
 
+type Options$1 = [
+    {
+        indent?: number;
+        tags?: string[];
+    }
+];
+
 type Options = [
     {
         ArrayExpression?: boolean;
@@ -22,6 +29,7 @@ type Options = [
         TSTypeParameterInstantiation?: boolean;
         ObjectPattern?: boolean;
         ArrayPattern?: boolean;
+        JSXOpeningElement?: boolean;
     }
 ];
 
@@ -34,8 +42,9 @@ declare const plugin: {
         "consistent-list-newline": RuleModule<Options>;
         "if-newline": RuleModule<[]>;
         "import-dedupe": RuleModule<[]>;
-        "no-import-node-modules-by-path": RuleModule<[]>;
+        "indent-unindent": RuleModule<Options$1>;
         "no-import-dist": RuleModule<[]>;
+        "no-import-node-modules-by-path": RuleModule<[]>;
         "no-ts-export-equal": RuleModule<[]>;
         "top-level-function": RuleModule<[]>;
     };

package/dist/index.d.mts

@@ -4,6 +4,13 @@ interface RuleModule<T extends readonly unknown[]> extends Rule.RuleModule {
     defaultOptions: T;
 }
 
+type Options$1 = [
+    {
+        indent?: number;
+        tags?: string[];
+    }
+];
+
 type Options = [
     {
         ArrayExpression?: boolean;
@@ -22,6 +29,7 @@ type Options = [
         TSTypeParameterInstantiation?: boolean;
         ObjectPattern?: boolean;
         ArrayPattern?: boolean;
+        JSXOpeningElement?: boolean;
     }
 ];
 
@@ -34,8 +42,9 @@ declare const plugin: {
         "consistent-list-newline": RuleModule<Options>;
         "if-newline": RuleModule<[]>;
         "import-dedupe": RuleModule<[]>;
-        "no-import-node-modules-by-path": RuleModule<[]>;
+        "indent-unindent": RuleModule<Options$1>;
         "no-import-dist": RuleModule<[]>;
+        "no-import-node-modules-by-path": RuleModule<[]>;
         "no-ts-export-equal": RuleModule<[]>;
         "top-level-function": RuleModule<[]>;
     };

package/dist/index.d.ts

@@ -4,6 +4,13 @@ interface RuleModule<T extends readonly unknown[]> extends Rule.RuleModule {
     defaultOptions: T;
 }
 
+type Options$1 = [
+    {
+        indent?: number;
+        tags?: string[];
+    }
+];
+
 type Options = [
     {
         ArrayExpression?: boolean;
@@ -22,6 +29,7 @@ type Options = [
         TSTypeParameterInstantiation?: boolean;
         ObjectPattern?: boolean;
         ArrayPattern?: boolean;
+        JSXOpeningElement?: boolean;
     }
 ];
 
@@ -34,8 +42,9 @@ declare const plugin: {
         "consistent-list-newline": RuleModule<Options>;
         "if-newline": RuleModule<[]>;
         "import-dedupe": RuleModule<[]>;
-        "no-import-node-modules-by-path": RuleModule<[]>;
+        "indent-unindent": RuleModule<Options$1>;
         "no-import-dist": RuleModule<[]>;
+        "no-import-node-modules-by-path": RuleModule<[]>;
         "no-ts-export-equal": RuleModule<[]>;
         "top-level-function": RuleModule<[]>;
     };

package/dist/index.mjs

@@ -1,4 +1,4 @@
-const version = "1.1.0";
+const version = "1.3.0";
 
 const hasDocs = [
   "consistent-list-newline",
@@ -47,6 +47,27 @@ function createRule({
 const createEslintRule = RuleCreator(
   (ruleName) => hasDocs.includes(ruleName) ? `${blobUrl}${ruleName}.md` : `${blobUrl}${ruleName}.test.ts`
 );
+const _reFullWs = /^\s*$/;
+function unindent(str) {
+  const lines = (typeof str === "string" ? str : str[0]).split("\n");
+  const whitespaceLines = lines.map((line) => _reFullWs.test(line));
+  const commonIndent = lines.reduce((min, line, idx) => {
+    if (whitespaceLines[idx]) {
+      return min;
+    }
+    const indent = line.match(/^\s*/)?.[0].length;
+    return indent === void 0 ? min : Math.min(min, indent);
+  }, Number.POSITIVE_INFINITY);
+  let emptyLinesHead = 0;
+  while (emptyLinesHead < lines.length && whitespaceLines[emptyLinesHead]) {
+    emptyLinesHead++;
+  }
+  let emptyLinesTail = 0;
+  while (emptyLinesTail < lines.length && whitespaceLines[lines.length - emptyLinesTail - 1]) {
+    emptyLinesTail++;
+  }
+  return lines.slice(emptyLinesHead, lines.length - emptyLinesTail).map((line) => line.slice(commonIndent)).join("\n");
+}
 
 const RULE_NAME$6 = "if-newline";
 const ifNewline = createEslintRule({
@@ -349,7 +370,8 @@ const consistentListNewline = createEslintRule({
         TSTypeParameterDeclaration: { type: "boolean" },
         TSTypeParameterInstantiation: { type: "boolean" },
         ObjectPattern: { type: "boolean" },
-        ArrayPattern: { type: "boolean" }
+        ArrayPattern: { type: "boolean" },
+        JSXOpeningElement: { type: "boolean" }
       },
       additionalProperties: false
     }],
@@ -370,7 +392,10 @@ const consistentListNewline = createEslintRule({
       if (items.length === 0) {
         return;
       }
-      const startToken = context.sourceCode.getTokenBefore(items[0]);
+      let startToken = ["CallExpression", "NewExpression"].includes(node.type) ? void 0 : context.sourceCode.getFirstToken(node);
+      if (startToken?.type !== "Punctuator") {
+        startToken = context.sourceCode.getTokenBefore(items[0]);
+      }
       const endToken = context.sourceCode.getTokenAfter(items[items.length - 1]);
       const startLine = startToken.loc.start.line;
       if (startToken.loc.start.line === endToken.loc.end.line) {
@@ -398,16 +423,22 @@ const consistentListNewline = createEslintRule({
           });
         } else if (mode === "inline" && currentStart !== lastLine) {
           const lastItem2 = items[idx - 1];
-          context.report({
-            node: item,
-            messageId: "shouldNotWrap",
-            data: {
-              name: node.type
-            },
-            *fix(fixer) {
-              yield removeLines(fixer, lastItem2.range[1], item.range[0]);
-            }
-          });
+          if (context.sourceCode.getCommentsBefore(item).length > 0) {
+            return;
+          }
+          const content = context.sourceCode.text.slice(lastItem2.range[1], item.range[0]);
+          if (content.includes("\n")) {
+            context.report({
+              node: item,
+              messageId: "shouldNotWrap",
+              data: {
+                name: node.type
+              },
+              *fix(fixer) {
+                yield removeLines(fixer, lastItem2.range[1], item.range[0]);
+              }
+            });
+          }
         }
         lastLine = item.loc.end.line;
       });
@@ -432,6 +463,9 @@ const consistentListNewline = createEslintRule({
         if (items.length === 1 && items[0].loc.start.line !== items[1]?.loc.start.line) {
           return;
         }
+        if (context.sourceCode.getCommentsAfter(lastItem).length > 0) {
+          return;
+        }
         const content = context.sourceCode.text.slice(lastItem.range[1], endRange);
         if (content.includes("\n")) {
           context.report({
@@ -510,6 +544,12 @@ const consistentListNewline = createEslintRule({
       },
       ArrayPattern(node) {
         check(node, node.elements);
+      },
+      JSXOpeningElement(node) {
+        if (node.attributes.some((attr) => attr.loc.start.line !== attr.loc.end.line)) {
+          return;
+        }
+        check(node, node.attributes);
       }
     };
     Object.keys(options).forEach((key) => {
@@ -521,17 +561,93 @@ const consistentListNewline = createEslintRule({
   }
 });
 
+const indentUnindent = createEslintRule({
+  name: "indent-unindent",
+  meta: {
+    type: "layout",
+    docs: {
+      description: "Enforce consistent indentation in `unindent` template tag"
+    },
+    fixable: "code",
+    schema: [
+      {
+        type: "object",
+        properties: {
+          indent: {
+            type: "number",
+            minimum: 0,
+            default: 2
+          },
+          tags: {
+            type: "array",
+            items: {
+              type: "string"
+            }
+          }
+        },
+        additionalProperties: false
+      }
+    ],
+    messages: {
+      "indent-unindent": "Consistent indentation in unindent tag"
+    }
+  },
+  defaultOptions: [{}],
+  create(context) {
+    const {
+      tags = ["$", "unindent", "unIndent"],
+      indent = 2
+    } = context.options?.[0] ?? {};
+    return {
+      TaggedTemplateExpression(node) {
+        const id = node.tag;
+        if (!id || id.type !== "Identifier") {
+          return;
+        }
+        if (!tags.includes(id.name)) {
+          return;
+        }
+        if (node.quasi.quasis.length !== 1) {
+          return;
+        }
+        const quasi = node.quasi.quasis[0];
+        const value = quasi.value.raw;
+        const lineStartIndex = context.sourceCode.getIndexFromLoc({
+          line: node.loc.start.line,
+          column: 0
+        });
+        const baseIndent = context.sourceCode.text.slice(lineStartIndex).match(/^\s*/)?.[0] ?? "";
+        const targetIndent = baseIndent + " ".repeat(indent);
+        const pure = unindent([value]);
+        let final = pure.split("\n").map((line) => targetIndent + line).join("\n");
+        final = `
+${final}
+${baseIndent}`;
+        if (final !== value) {
+          context.report({
+            node: quasi,
+            messageId: "indent-unindent",
+            fix: (fixer) => fixer.replaceText(quasi, `\`${final}\``)
+          });
+        }
+      }
+    };
+  }
+});
+
 const plugin = {
   meta: {
     name: "kirklin",
     version
   },
+  // @keep-sorted
   rules: {
     "consistent-list-newline": consistentListNewline,
     "if-newline": ifNewline,
     "import-dedupe": importDedupe,
-    "no-import-node-modules-by-path": noImportNodeModulesByPath,
+    "indent-unindent": indentUnindent,
     "no-import-dist": noImportDist,
+    "no-import-node-modules-by-path": noImportNodeModulesByPath,
     "no-ts-export-equal": noTsExportEqual,
     "top-level-function": topLevelFunction
   }

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "eslint-plugin-kirklin",
   "type": "module",
-  "version": "1.1.0",
-  "packageManager": "pnpm@8.10.2",
+  "version": "1.3.0",
+  "packageManager": "pnpm@9.1.0",
   "description": "Kirk Lin extended ESLint rules",
   "author": "Kirk Lin (https://github.com/kirklin)",
   "license": "MIT",
@@ -41,34 +41,34 @@
     "prepare": "simple-git-hooks"
   },
   "peerDependencies": {
-    "eslint": "*"
+    "eslint": ">=8.40.0"
   },
   "devDependencies": {
-    "@antfu/ni": "^0.21.8",
-    "@kirklin/eslint-config": "^1.1.1",
-    "@types/eslint": "^8.44.6",
-    "@types/lodash.merge": "^4.6.8",
-    "@types/node": "^20.8.10",
-    "@types/semver": "^7.5.4",
-    "@typescript-eslint/rule-tester": "^6.9.1",
-    "@typescript-eslint/typescript-estree": "^6.9.1",
-    "@typescript-eslint/utils": "^6.9.1",
-    "ajv": "^8.12.0",
-    "bumpp": "^9.2.0",
-    "eslint": "^8.53.0",
-    "eslint-define-config": "^1.24.1",
-    "esno": "^0.17.0",
-    "lint-staged": "^15.0.2",
+    "@antfu/ni": "^0.21.12",
+    "@kirklin/eslint-config": "^2.3.0",
+    "@types/eslint": "^8.56.10",
+    "@types/lodash.merge": "^4.6.9",
+    "@types/node": "^20.12.11",
+    "@types/semver": "^7.5.8",
+    "@typescript-eslint/typescript-estree": "^7.8.0",
+    "@typescript-eslint/utils": "^7.8.0",
+    "bumpp": "^9.4.1",
+    "eslint": "^9.2.0",
+    "eslint-define-config": "^2.1.0",
+    "eslint-vitest-rule-tester": "^0.3.2",
+    "esno": "^4.7.0",
+    "lint-staged": "^15.2.2",
     "lodash.merge": "4.6.2",
-    "pnpm": "^8.10.2",
+    "pnpm": "^9.1.0",
     "rimraf": "^5.0.5",
-    "semver": "^7.5.4",
-    "simple-git-hooks": "^2.9.0",
-    "tsup": "^7.2.0",
-    "typescript": "^5.2.2",
+    "semver": "^7.6.1",
+    "simple-git-hooks": "^2.11.1",
+    "tsup": "^8.0.2",
+    "tsx": "^4.9.3",
+    "typescript": "^5.4.5",
     "unbuild": "^2.0.0",
-    "vite": "^4.5.0",
-    "vitest": "^0.34.6"
+    "vite": "^5.2.11",
+    "vitest": "^1.6.0"
   },
   "resolutions": {
     "eslint-plugin-kirklin": "workspace:*"
@@ -79,4 +79,4 @@
   "lint-staged": {
     "*": "eslint --fix"
   }
-}
+}