@ethang/eslint-config 19.4.6 → 19.5.0

package/README.md

@@ -5,7 +5,7 @@
 > [!CAUTION]
 > Do not use this with Prettier! Styling rules are included.
 
-- 886 errored rules.
+- 887 errored rules.
 - 289 rules from [eslint-plugin-sonarjs](https://github.com/SonarSource/SonarJS/blob/master/packages/jsts/src/rules/README.md)
 - 145 rules from [@eslint/js](https://github.com/eslint/eslint/tree/main/packages/js)
 - 113 rules from [sindresorhus/eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn)
@@ -21,6 +21,7 @@
 - 4 rules from [@tanstack/eslint-plugin-query](https://tanstack.com/query/latest/docs/eslint/eslint-plugin-query)
 - 2 rules from [@eslint/json](https://github.com/eslint/json)
 - 1 rule from [eslint-plugin-depend](https://github.com/es-tooling/eslint-plugin-depend/tree/main)
+- 1 rule from [@cspell/eslint-plugin](https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-eslint-plugin)
 - 1 rule from [eslint-plugin-compat](https://github.com/amilajack/eslint-plugin-compat)
 - 1 rule from [@ethang/eslint-plugin](https://github.com/eglove/eslint-plugin)
 

package/build/create-config-file.ts

@@ -0,0 +1,51 @@
+import { writeFileSync } from "node:fs";
+import { join } from "node:path";
+
+import type { ConfigFile } from "./update-rules.ts";
+
+import { createConfig } from "./create-config.ts";
+import { getTypeImportStrings } from "./list-utils.ts";
+
+export const createConfigFile = async (
+  listConfigs: ConfigFile[],
+  fileName: string,
+) => {
+  let configFile = "";
+
+  const imports = listConfigs.flatMap((list) => {
+    const importStrings = getTypeImportStrings(list.name);
+
+    if (list.options?.extraImports && 0 < list.options.extraImports.length) {
+      importStrings.push(...list.options.extraImports);
+    }
+
+    return importStrings;
+  });
+
+  const importList = [
+    'import { ignores, languageOptions } from "./constants.js";',
+    ...imports,
+  ].toSorted((a, b) => {
+    return (a ?? "").localeCompare(b ?? "");
+  });
+
+  for (const item of importList) {
+    configFile += `${item}\n`;
+  }
+
+  const configs = await Promise.all(
+    listConfigs.map(async (list) => {
+      return createConfig(list.name, list.options);
+    }),
+  );
+
+  configFile += `\nexport default tseslint.config(
+    ${configs.join("\n")}
+  );\n`;
+
+  writeFileSync(
+    join(import.meta.dirname, `../${fileName}`),
+    configFile,
+    "utf8",
+  );
+};

package/build/{create-config.js → create-config.ts}

@@ -1,12 +1,22 @@
+import { getLatestReact } from "./get-react-version.ts";
 import {
   getList,
   getListJson,
   getListPlugins,
   getTypeFiles,
-} from "./list-utils.mjs";
-import { getLatestReact } from "./get-react-version.js";
+} from "./list-utils.ts";
 
-export const createConfig = async (type, options = {}) => {
+export type ConfigOptions = {
+  extraImports?: string[];
+  includeIgnores?: boolean;
+  includeLanguageOptions?: boolean;
+  includeReactVersion?: boolean;
+};
+
+export const createConfig = async (
+  type: string,
+  options: ConfigOptions = {},
+) => {
   let config = "";
   let settings;
 

package/build/{get-react-version.js → get-react-version.ts}

@@ -1,4 +1,4 @@
 export async function getLatestReact() {
   const response = await fetch("https://registry.npmjs.org/react/latest");
-  return response.json();
+  return response.json() as Promise<{ version: string }>;
 }

package/build/{list-utils.mjs → list-utils.ts}

@@ -1,44 +1,35 @@
-import { ruleList } from "./rule-list.mjs";
+import { ruleList } from "./rule-list.ts";
 
-export const getList = (type) => {
+export const getList = (type: string) => {
   return ruleList
-    .filter((list) => list.type === type)
-    .sort((a, b) => a.order - b.order);
+    .filter((list) => {
+      return list.type === type;
+    })
+    .sort((a, b) => {
+      return (a.order ?? 0) - (b.order ?? 0);
+    });
 };
 
-export const getListImportStrings = (list) => {
-  return list
+export const getTypeImportStrings = (type: string) => {
+  return ruleList
+    .filter((list) => {
+      return list.type === type;
+    })
     .map((item) => {
       return item.importString;
     })
     .filter(Boolean);
 };
 
-export const getTypeImportStrings = (type) => {
-  return ruleList
-    .filter((list) => list.type === type)
-    .map((item) => item.importString)
-    .filter(Boolean);
-};
-
-export const getListJson = (list) => {
+export const getListJson = (list: typeof ruleList) => {
   return list
     .map((list) => {
-      const sortedKeys = Object.keys(list.list).sort((a, b) =>
-        a.localeCompare(b),
-      );
-      const sortedObject = {};
-
-      for (const key of sortedKeys) {
-        sortedObject[key] = list.list[key];
-      }
-
-      return JSON.stringify(sortedObject).slice(1, -1);
+      return JSON.stringify(list.list).slice(1, -1);
     })
     .join(",");
 };
 
-export const getTypeFiles = (type) => {
+export const getTypeFiles = (type: string) => {
   switch (type) {
     case "core": {
       return ["**/*.{js,ts,jsx,tsx,cjs,cts,mjs,mts}"];
@@ -63,10 +54,14 @@ export const getTypeFiles = (type) => {
     case "solid": {
       return ["**/*.{jsx,tsx}"];
     }
+
+    default: {
+      return [];
+    }
   }
 };
 
-export const getListPlugins = (list) => {
+export const getListPlugins = (list: typeof ruleList) => {
   let pluginString = "";
 
   for (const item of list) {

package/build/{rule-list.mjs → rule-list.ts}

@@ -1,240 +1,250 @@
-import { dependRules } from "../setup/depend.js";
-import { barrelRules } from "../setup/barrel.js";
-import { compatRules } from "../setup/compat.js";
-import { eslintRules } from "../setup/eslint.js";
-import { nRules } from "../setup/n.js";
-import { typescriptRules } from "../setup/typescript-eslint.js";
-import { unicornRules } from "../setup/unicorn.js";
-import { lodashRules } from "../setup/lodash.js";
-import { sonarRules } from "../setup/sonar.js";
-import { tanstackQueryRules } from "../setup/tanstack-query.js";
-import { tailwindRules } from "../setup/tailwind.js";
-import { stylisticRules } from "../setup/stylistic.js";
-import { perfectionistRules } from "../setup/perfectionist.js";
-import { a11yRules } from "../setup/a11y.js";
-import { markdownRules } from "../setup/markdown.js";
-import { jsonRules } from "../setup/json.js";
-import { ethangRules } from "../setup/ethang.js";
-import { astroRules } from "../setup/astro.js";
-import { reactHookRules, reactRules } from "../setup/react.js";
-import { solidRules } from "../setup/solid.js";
-import { deprecatedRules } from "../setup/deprecated.js";
+import { a11yRules } from "../setup/a11y.ts";
+import { astroRules } from "../setup/astro.ts";
+import { barrelRules } from "../setup/barrel.ts";
+import { compatRules } from "../setup/compat.ts";
+import { dependRules } from "../setup/depend.ts";
+import { deprecatedRules } from "../setup/deprecated.ts";
+import { eslintRules } from "../setup/eslint.ts";
+import { ethangRules } from "../setup/ethang.ts";
+import { jsonRules } from "../setup/json.ts";
+import { lodashRules } from "../setup/lodash.ts";
+import { markdownRules } from "../setup/markdown.ts";
+import { nRules } from "../setup/n.ts";
+import { perfectionistRules } from "../setup/perfectionist.ts";
+import { reactHookRules, reactRules } from "../setup/react.ts";
+import { solidRules } from "../setup/solid.ts";
+import { sonarRules } from "../setup/sonar.ts";
+import { stylisticRules } from "../setup/stylistic.ts";
+import { tailwindRules } from "../setup/tailwind.ts";
+import { tanstackQueryRules } from "../setup/tanstack-query.ts";
+import { typescriptRules } from "../setup/typescript-eslint.ts";
+import { unicornRules } from "../setup/unicorn.ts";
+import { cspellRules } from "../setup/cspell.js";
 
 export const ruleList = [
   {
+    importString: 'import depend from "eslint-plugin-depend";',
     list: dependRules,
     name: "eslint-plugin-depend",
-    url: "https://github.com/es-tooling/eslint-plugin-depend/tree/main",
-    type: "core",
-    importString: 'import depend from "eslint-plugin-depend";',
     order: 0,
     pluginName: "depend",
     pluginValue: "depend",
+    type: "core",
+    url: "https://github.com/es-tooling/eslint-plugin-depend/tree/main",
   },
   {
+    importString: 'import barrel from "eslint-plugin-barrel-files";',
     list: barrelRules,
     name: "eslint-plugin-barrel-files",
-    url: "https://github.com/thepassle/eslint-plugin-barrel-files",
-    type: "core",
-    importString: 'import barrel from "eslint-plugin-barrel-files";',
     order: 1,
     pluginName: "barrel",
     pluginValue: "barrel",
+    type: "core",
+    url: "https://github.com/thepassle/eslint-plugin-barrel-files",
   },
   {
+    importString: 'import compat from "eslint-plugin-compat";',
     list: compatRules,
     name: "eslint-plugin-compat",
-    url: "https://github.com/amilajack/eslint-plugin-compat",
-    type: "core",
-    importString: 'import compat from "eslint-plugin-compat";',
     order: 2,
     pluginName: "compat",
     pluginValue: "compat",
+    type: "core",
+    url: "https://github.com/amilajack/eslint-plugin-compat",
   },
   {
+    importString: undefined,
     list: eslintRules,
     name: "@eslint/js",
-    url: "https://github.com/eslint/eslint/tree/main/packages/js",
-    type: "core",
-    importString: undefined,
     order: 3,
     pluginName: undefined,
     pluginValue: undefined,
+    type: "core",
+    url: "https://github.com/eslint/eslint/tree/main/packages/js",
   },
   {
+    importString: 'import n from "eslint-plugin-n";',
     list: nRules,
     name: "eslint-plugin-n",
-    url: "https://github.com/eslint-community/eslint-plugin-n",
-    type: "core",
-    importString: 'import n from "eslint-plugin-n";',
     order: 4,
     pluginName: "n",
     pluginValue: "n",
+    type: "core",
+    url: "https://github.com/eslint-community/eslint-plugin-n",
   },
   {
+    importString: 'import tseslint from "typescript-eslint";',
     list: typescriptRules,
     name: "@typescript/eslint",
-    url: "https://github.com/typescript-eslint/typescript-eslint",
-    type: "core",
-    importString: 'import tseslint from "typescript-eslint";',
     order: 5,
     pluginName: "@typescript-eslint",
     pluginValue: "tseslint.plugin",
+    type: "core",
+    url: "https://github.com/typescript-eslint/typescript-eslint",
   },
   {
+    importString: 'import unicorn from "eslint-plugin-unicorn";',
     list: unicornRules,
     name: "sindresorhus/eslint-plugin-unicorn",
-    url: "https://github.com/sindresorhus/eslint-plugin-unicorn",
-    type: "core",
-    importString: 'import unicorn from "eslint-plugin-unicorn";',
     order: 6,
     pluginName: "unicorn",
     pluginValue: "unicorn",
+    type: "core",
+    url: "https://github.com/sindresorhus/eslint-plugin-unicorn",
   },
   {
+    importString: 'import lodashConfig from "eslint-plugin-lodash";',
     list: lodashRules,
     name: "eslint-plugin-lodash",
-    url: "https://github.com/wix-incubator/eslint-plugin-lodash",
-    type: "core",
-    importString: 'import lodashConfig from "eslint-plugin-lodash";',
     order: 7,
     pluginName: "lodash",
     pluginValue: "lodashConfig",
+    type: "core",
+    url: "https://github.com/wix-incubator/eslint-plugin-lodash",
   },
   {
+    importString: 'import sonar from "eslint-plugin-sonarjs";',
     list: sonarRules,
     name: "eslint-plugin-sonarjs",
-    url: "https://github.com/SonarSource/SonarJS/blob/master/packages/jsts/src/rules/README.md",
-    type: "core",
-    importString: 'import sonar from "eslint-plugin-sonarjs";',
     order: 8,
     pluginName: "sonar",
     pluginValue: "fixupPluginRules(sonar)", // TODO remove with v9 compat
+    type: "core",
+    url: "https://github.com/SonarSource/SonarJS/blob/master/packages/jsts/src/rules/README.md",
   },
   {
+    importString: 'import ethang from "@ethang/eslint-plugin";',
     list: ethangRules,
     name: "@ethang/eslint-plugin",
-    url: "https://github.com/eglove/eslint-plugin",
-    type: "core",
-    importString: 'import ethang from "@ethang/eslint-plugin";',
     order: 9,
     pluginName: "ethang",
     pluginValue: "ethang",
+    type: "core",
+    url: "https://github.com/eglove/eslint-plugin",
   },
   {
+    importString: 'import tanstack from "@tanstack/eslint-plugin-query";',
     list: tanstackQueryRules,
     name: "@tanstack/eslint-plugin-query",
-    url: "https://tanstack.com/query/latest/docs/eslint/eslint-plugin-query",
-    type: "core",
-    importString: 'import tanstack from "@tanstack/eslint-plugin-query";',
     order: 10,
     pluginName: "@tanstack/query",
     pluginValue: "tanstack",
+    type: "core",
+    url: "https://tanstack.com/query/latest/docs/eslint/eslint-plugin-query",
   },
   {
+    importString: 'import tailwind from "eslint-plugin-tailwindcss";',
     list: tailwindRules,
     name: "eslint-plugin-tailwindcss",
-    url: "https://github.com/francoismassart/eslint-plugin-tailwindcss",
-    type: "core",
-    importString: 'import tailwind from "eslint-plugin-tailwindcss";',
     order: 11,
     pluginName: "tailwind",
     pluginValue: "tailwind",
+    type: "core",
+    url: "https://github.com/francoismassart/eslint-plugin-tailwindcss",
   },
   {
+    importString: 'import stylistic from "@stylistic/eslint-plugin";',
     list: stylisticRules,
     name: "@stylistic/eslint-plugin",
-    url: "https://eslint.style/",
-    type: "core",
-    importString: 'import stylistic from "@stylistic/eslint-plugin";',
     order: 12,
     pluginName: "stylistic",
     pluginValue: "stylistic",
+    type: "core",
+    url: "https://eslint.style/",
   },
   {
+    importString: 'import perfectionist from "eslint-plugin-perfectionist";',
     list: perfectionistRules,
     name: "eslint-plugin-perfectionist",
-    url: "https://github.com/azat-io/eslint-plugin-perfectionist",
-    type: "core",
-    importString: 'import perfectionist from "eslint-plugin-perfectionist";',
     order: 13,
     pluginName: "perfectionist",
     pluginValue: "perfectionist",
+    type: "core",
+    url: "https://github.com/azat-io/eslint-plugin-perfectionist",
   },
   {
+    importString: 'import a11y from "eslint-plugin-jsx-a11y/lib/index.js";',
     list: a11yRules,
     name: "jsx-a11y",
-    url: "https://github.com/jsx-eslint/eslint-plugin-jsx-a11y",
-    type: "core",
-    importString: 'import a11y from "eslint-plugin-jsx-a11y/lib/index.js";',
     order: 14,
     pluginName: "a11y",
     pluginValue: "a11y",
+    type: "core",
+    url: "https://github.com/jsx-eslint/eslint-plugin-jsx-a11y",
   },
   {
+    importString: undefined,
     list: deprecatedRules,
     name: "@eslint/js",
-    url: "https://github.com/eslint/eslint/tree/main/packages/js",
-    type: "core",
-    importString: undefined,
     order: 15,
     pluginName: undefined,
     pluginValue: undefined,
+    type: "core",
+    url: "https://github.com/eslint/eslint/tree/main/packages/js",
   },
   {
+    importString: 'import markdown from "@eslint/markdown";',
     list: markdownRules,
     name: "@eslint/markdown",
-    url: "https://github.com/eslint/markdown",
-    type: "markdown",
-    importString: 'import markdown from "@eslint/markdown";',
     order: 0,
     pluginName: "markdown",
     pluginValue: "markdown",
+    type: "markdown",
+    url: "https://github.com/eslint/markdown",
   },
   {
+    importString: 'import json from "@eslint/json";',
     list: jsonRules,
     name: "@eslint/json",
-    url: "https://github.com/eslint/json",
-    type: "json",
-    importString: 'import json from "@eslint/json";',
     order: 0,
     pluginName: "json",
     pluginValue: "json",
+    type: "json",
+    url: "https://github.com/eslint/json",
   },
   {
+    importString: 'import astro from "eslint-plugin-astro";',
     list: astroRules,
     name: "eslint-plugin-astro",
-    url: "https://github.com/ota-meshi/eslint-plugin-astro",
-    type: "astro",
-    importString: 'import astro from "eslint-plugin-astro";',
     pluginName: "astro",
     pluginValue: "astro",
+    type: "astro",
+    url: "https://github.com/ota-meshi/eslint-plugin-astro",
   },
   {
+    importString: 'import react from "@eslint-react/eslint-plugin";',
     list: reactRules,
     name: "@eslint-react/eslint-plugin",
-    url: "https://eslint-react.xyz/",
-    type: "react",
-    importString: 'import react from "@eslint-react/eslint-plugin";',
     pluginName: "react",
     pluginValue: "react",
+    type: "react",
+    url: "https://eslint-react.xyz/",
   },
   {
+    importString: 'import reactHooks from "eslint-plugin-react-hooks";',
     list: reactHookRules,
     name: "eslint-plugin-react-hooks",
-    url: "https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks",
-    type: "react",
-    importString: 'import reactHooks from "eslint-plugin-react-hooks";',
     pluginName: "react-hooks",
     pluginValue: "fixupPluginRules(reactHooks)", // TODO remove with v9 compat
+    type: "react",
+    url: "https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks",
   },
   {
+    importString: 'import solid from "eslint-plugin-solid";',
     list: solidRules,
     name: "eslint-plugin-solid",
-    url: "https://github.com/solidjs-community/eslint-plugin-solid",
-    type: "solid",
-    importString: 'import solid from "eslint-plugin-solid";',
     pluginName: "solid",
     pluginValue: "solid",
+    type: "solid",
+    url: "https://github.com/solidjs-community/eslint-plugin-solid",
+  },
+  {
+    importString: 'import cspell from "@cspell/eslint-plugin";',
+    list: cspellRules,
+    name: "@cspell/eslint-plugin",
+    pluginName: "cspell",
+    pluginValue: "cspell",
+    type: "core",
+    url: "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-eslint-plugin",
   },
 ];

package/build/{update-readme.js → update-readme.ts}

@@ -1,7 +1,10 @@
+import { MarkdownGenerator } from "@ethang/markdown-generator/markdown-generator.js";
 import { writeFileSync } from "node:fs";
 import { join } from "node:path";
-import { MarkdownGenerator } from "@ethang/markdown-generator/markdown-generator.js";
-import { getList } from "./list-utils.mjs";
+
+import type { genRules } from "../setup/gen-rules.ts";
+
+import { getList } from "./list-utils.ts";
 
 export const updateReadme = () => {
   const md = new MarkdownGenerator();
@@ -13,13 +16,13 @@ export const updateReadme = () => {
     2,
   );
 
-  const getRuleCount = (rules) => {
+  const getRuleCount = (rules: ReturnType<typeof genRules>) => {
     let count = 0;
-    Object.values(rules).forEach((value) => {
-      if (value === "error" || (Array.isArray(value) && value[0] === "error")) {
+    for (const value of Object.values(rules)) {
+      if ("error" === value || (Array.isArray(value) && "error" === value[0])) {
         count += 1;
       }
-    });
+    }
 
     return count;
   };
@@ -28,13 +31,18 @@ export const updateReadme = () => {
     ...getList("core"),
     ...getList("json"),
     ...getList("markdown"),
-  ];
+  ].map((rules) => {
+    return {
+      ...rules,
+      count: 0,
+    };
+  });
 
   let total = 0;
   for (const list of coreRules) {
     const count = getRuleCount(list.list);
     total += count;
-    list["count"] = count;
+    list.count = count;
   }
   coreRules.sort((a, b) => {
     return b.count - a.count;
@@ -42,12 +50,14 @@ export const updateReadme = () => {
 
   const ruleDocs = [`${total} errored rules.`];
   for (const list of coreRules) {
-    if (list.count < 1) {
+    if (1 > list.count) {
       continue;
     }
 
     ruleDocs.push(
-      `${list.count} ${list.count <= 1 ? "rule" : "rules"} from [${list.name}](${list.url})`,
+      `${list.count} ${
+        1 >= list.count ? "rule" : "rules"
+      } from [${list.name}](${list.url})`,
     );
   }
 
@@ -78,7 +88,9 @@ export const updateReadme = () => {
     [
       '`import astroConfig from "@ethang/eslint-config/config.astro.js";`',
       ...astroRules
-        .filter((rule) => getRuleCount(rule.list) > 0)
+        .filter((rule) => {
+          return 0 < getRuleCount(rule.list);
+        })
         .map((rule) => {
           return `${getRuleCount(rule.list)} rules from [${rule.name}](${rule.url})`;
         }),
@@ -87,7 +99,9 @@ export const updateReadme = () => {
     [
       '`import reactConfig from "@ethang/eslint-config/config.react.js";`',
       ...reactRules
-        .filter((rule) => getRuleCount(rule.list) > 0)
+        .filter((rule) => {
+          return 0 < getRuleCount(rule.list);
+        })
         .map((rule) => {
           return `${getRuleCount(rule.list)} rules from [${rule.name}](${rule.url})`;
         }),
@@ -96,7 +110,9 @@ export const updateReadme = () => {
     [
       '`import solidConfig from "@ethang/eslint-config/config.solid.js";`',
       ...solidRules
-        .filter((rule) => getRuleCount(rule.list) > 0)
+        .filter((rule) => {
+          return 0 < getRuleCount(rule.list);
+        })
         .map((rule) => {
           return `${getRuleCount(rule.list)} rules from [${rule.name}](${rule.url})`;
         }),