@ethang/eslint-config 24.0.1 → 24.0.2

package/src/build/create-config-file.ts

@@ -0,0 +1,70 @@
+import isNil from "lodash/isNil.js";
+import map from "lodash/map.js";
+import { writeFileSync } from "node:fs";
+import path from "node:path";
+
+import type { ConfigFile } from "./update-rules.ts";
+
+import { createConfig } from "./create-config.ts";
+import { getTypeImportStrings } from "./list-utilities.ts";
+
+const mainFile = "eslint.config.js";
+
+export const createConfigFile = async (
+  listConfigs: ConfigFile[],
+  fileName: string,
+  functionParameters?: string,
+) => {
+  let configFile = "// @ts-nocheck\n";
+
+  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;
+  });
+
+  // eslint-disable-next-line compat/compat
+  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(
+    map(listConfigs, async (list) => {
+      return createConfig(list.name, list.options);
+    }),
+  );
+
+  // eslint-disable-next-line unicorn/prefer-ternary
+  if (isNil(functionParameters)) {
+    configFile += `\nexport default defineConfig(
+      ${configs.join("\n")}
+      ${mainFile === fileName ? "eslintConfigPrettier," : ""}
+      ${mainFile === fileName ? "eslintPluginPrettierRecommended," : ""}
+    );\n`;
+  } else {
+    configFile += `\nconst config = (${functionParameters}) => {
+      return defineConfig(
+        ${configs.join("\n")}
+        ${mainFile === fileName ? "eslintConfigPrettier," : ""}
+        ${mainFile === fileName ? "eslintPluginPrettierRecommended," : ""}
+      );
+    }\n\nexport default config;\n`;
+  }
+
+  writeFileSync(
+    path.join(import.meta.dirname, `../${fileName}`),
+    configFile,
+    "utf8",
+  );
+};

package/src/build/create-config.ts

@@ -0,0 +1,98 @@
+import flow from "lodash/flow.js";
+import isNil from "lodash/isNil.js";
+import map from "lodash/map.js";
+
+import { getLatestReact } from "./get-react-version.ts";
+import {
+  getList,
+  getListJson,
+  getListPlugins,
+  getTypeFiles,
+  getTypeLanguage,
+} from "./list-utilities.ts";
+
+export type ConfigOptions = {
+  extraImports?: string[];
+  extraOptions?: string;
+  globalIgnores?: string[];
+  includeAngularLanguageOptions?: boolean;
+  includeIgnores?: boolean;
+  includeLanguageOptions?: boolean;
+  includeReactVersion?: boolean;
+  processor?: string;
+};
+
+const getIgnoresString = flow(
+  (globalIgnores: string[] | undefined) => {
+    return map(globalIgnores, (ignore) => {
+      return `"${ignore}"`;
+    });
+  },
+  (list) => list.join(", "),
+);
+
+export const createConfig = async (
+  type: string,
+  options: ConfigOptions = {},
+) => {
+  let config = "";
+  let settings;
+
+  if (!isNil(options.includeReactVersion)) {
+    const react = await getLatestReact();
+    settings = JSON.stringify({
+      react: { version: react?.version },
+    }).slice(1, -1);
+  }
+
+  const list = getList(type);
+  const ruleJson = getListJson(list);
+
+  let optionals = "";
+
+  if (!isNil(options.includeIgnores)) {
+    optionals += "\nignores,";
+  }
+
+  if (
+    !isNil(options.includeLanguageOptions) &&
+    isNil(options.includeAngularLanguageOptions)
+  ) {
+    optionals += "\nlanguageOptions,";
+  }
+
+  if (!isNil(options.includeAngularLanguageOptions)) {
+    optionals += "\nlanguageOptions: angularLanguageOptions,";
+  }
+
+  if (!isNil(options.processor)) {
+    optionals += `\nprocessor: ${options.processor},`;
+  }
+
+  if (!isNil(options.includeReactVersion) && !isNil(settings)) {
+    optionals += `\nsettings: {
+  ${settings}
+},`;
+  }
+
+  const language = getTypeLanguage(type);
+
+  if (options.globalIgnores) {
+    config += `{
+      ignores: [${getIgnoresString(options.globalIgnores)}],
+    },`;
+  }
+
+  config += `{
+    files: ["${getTypeFiles(type)}"],${optionals}${language ? `language: "${language}",` : ""}
+    plugins: {
+      ${getListPlugins(list)}
+    },
+    rules: {
+      ${ruleJson}
+    },
+    ${isNil(options.extraOptions) ? "" : options.extraOptions}
+  },`;
+
+  return config;
+};

package/src/build/get-react-version.ts

@@ -0,0 +1,19 @@
+import { parseFetchJson } from "@ethang/toolbelt/fetch/json.js";
+import isError from "lodash/isError.js";
+import { z } from "zod";
+
+export const getLatestReact = async () => {
+  const response = await globalThis.fetch(
+    "https://registry.npmjs.org/react/latest",
+  );
+  const data = await parseFetchJson(
+    response,
+    z.object({ version: z.string() }),
+  );
+
+  if (isError(data)) {
+    return;
+  }
+
+  return data;
+};

package/src/build/list-utilities.ts

@@ -0,0 +1,137 @@
+import filter from "lodash/filter.js";
+import flow from "lodash/flow.js";
+import isNil from "lodash/isNil.js";
+import map from "lodash/map.js";
+
+import { ruleList } from "./rule-list.ts";
+
+const filterRuleListByType = (type: string) => {
+  return filter(ruleList, (list) => {
+    return list.type === type;
+  });
+};
+
+export const getList = flow(filterRuleListByType, (list) => {
+  return list.toSorted((a, b) => {
+    return (a.order ?? 0) - (b.order ?? 0);
+  });
+});
+
+export const getTypeImportStrings = flow(
+  filterRuleListByType,
+  (list) =>
+    map(list, (item) => {
+      return item.importString;
+    }),
+  (list) => filter(list, Boolean),
+);
+
+export const getListJson = flow(
+  (list: typeof ruleList) => {
+    return map(list, (item) => {
+      return JSON.stringify(item.list).slice(1, -1);
+    });
+  },
+  (list) => list.join(","),
+);
+
+export const getTypeLanguage = (type: string) => {
+  switch (type) {
+    case "css": {
+      return "css/css";
+    }
+
+    case "html": {
+      return "html/html";
+    }
+
+    case "json": {
+      return "json/json";
+    }
+
+    case "json5": {
+      return "json/json5";
+    }
+
+    case "jsonc": {
+      return "json/jsonc";
+    }
+
+    default: {
+      return null;
+    }
+  }
+};
+
+export const getTypeFiles = (type: string) => {
+  switch (type) {
+    case "angular": {
+      return "**/*.ts";
+    }
+
+    case "angular:template": {
+      return "**/*.html";
+    }
+
+    case "astro": {
+      return "**/*.{astro}";
+    }
+
+    case "core":
+    case "tailwind": {
+      return "**/*.{js,ts,jsx,tsx,cjs,cts,mjs,mts}";
+    }
+
+    case "css": {
+      return "**/*.css";
+    }
+
+    case "html": {
+      return "**/*.html";
+    }
+
+    case "json": {
+      return "**/*.json";
+    }
+
+    case "json5": {
+      return "**/*.json5";
+    }
+
+    case "jsonc": {
+      return "**/*.jsonc";
+    }
+
+    case "markdown": {
+      return "**/*.md";
+    }
+
+    case "react": {
+      return "**/*.{jsx,tsx}";
+    }
+
+    case "solid": {
+      return "**/*.{jsx,tsx}";
+    }
+
+    case "storybook": {
+      return "**/*.stories.@(ts|tsx|js|jsx|mjs|cjs)";
+    }
+
+    default: {
+      return "";
+    }
+  }
+};
+
+export const getListPlugins = (list: typeof ruleList) => {
+  let pluginString = "";
+
+  for (const item of list) {
+    if (!isNil(item.pluginName) && !isNil(item.pluginValue)) {
+      pluginString += `"${item.pluginName}": ${item.pluginValue},`;
+    }
+  }
+
+  return pluginString;
+};

package/src/build/rule-list.ts

@@ -0,0 +1,283 @@
+import type { Linter } from "eslint";
+
+import { a11yRules } from "../setup/a11y.ts";
+import { angularTemplateRules, angularTsRules } from "../setup/angular.js";
+import { astroRules } from "../setup/astro.ts";
+import { compatRules } from "../setup/compat.ts";
+import { cspellRules } from "../setup/cspell.js";
+import { cssRules } from "../setup/css.js";
+import { eslintRules } from "../setup/eslint.ts";
+import { htmlRules } from "../setup/html.js";
+import { jsonRules } from "../setup/json.ts";
+import { lodashRules } from "../setup/lodash.ts";
+import { markdownRules } from "../setup/markdown.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 { storybookRules } from "../setup/storybook.js";
+import { tailwindRules } from "../setup/tailwind.ts";
+import { tanstackQueryRules } from "../setup/tanstack-query.ts";
+import { tanstackRouterRules } from "../setup/tanstack-router.js";
+import { typescriptRules } from "../setup/typescript-eslint.ts";
+import { unicornRules } from "../setup/unicorn.ts";
+
+const eslintJson = "@eslint/json";
+const eslintJsonGithub = "https://github.com/eslint/json";
+
+type RuleConfig = {
+  importString?: string | undefined;
+  list: Linter.RulesRecord;
+  name: string;
+  order?: number;
+  pluginName?: string | undefined;
+  pluginValue?: string | undefined;
+  type: string;
+  url: string;
+};
+
+export const ruleList: RuleConfig[] = [
+  {
+    importString: 'import compat from "eslint-plugin-compat";',
+    list: compatRules,
+    name: "eslint-plugin-compat",
+    order: 0,
+    pluginName: "compat",
+    pluginValue: "compat",
+    type: "core",
+    url: "https://github.com/amilajack/eslint-plugin-compat",
+  },
+  {
+    importString: undefined,
+    list: eslintRules,
+    name: "@eslint/js",
+    order: 1,
+    pluginName: undefined,
+    pluginValue: undefined,
+    type: "core",
+    url: "https://github.com/eslint/eslint/tree/main/packages/js",
+  },
+  {
+    importString: 'import tseslint from "typescript-eslint";',
+    list: typescriptRules,
+    name: "@typescript/eslint",
+    order: 2,
+    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",
+    order: 3,
+    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",
+    order: 4,
+    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",
+    order: 5,
+    pluginName: "sonar",
+    pluginValue: "sonar",
+    type: "core",
+    url: "https://github.com/SonarSource/SonarJS/blob/master/packages/jsts/src/rules/README.md",
+  },
+  {
+    importString: 'import perfectionist from "eslint-plugin-perfectionist";',
+    list: perfectionistRules,
+    name: "eslint-plugin-perfectionist",
+    order: 6,
+    pluginName: "perfectionist",
+    pluginValue: "perfectionist",
+    type: "core",
+    url: "https://github.com/azat-io/eslint-plugin-perfectionist",
+  },
+  {
+    importString: 'import tanstackQuery from "@tanstack/eslint-plugin-query";',
+    list: tanstackQueryRules,
+    name: "@tanstack/eslint-plugin-query",
+    order: 7,
+    pluginName: "@tanstack/query",
+    pluginValue: "tanstackQuery",
+    type: "core",
+    url: "https://tanstack.com/query/latest/docs/eslint/eslint-plugin-query",
+  },
+  {
+    importString:
+      'import tanstackRouter from "@tanstack/eslint-plugin-router";',
+    list: tanstackRouterRules,
+    name: "@tanstack/eslint-plugin-router",
+    order: 8,
+    pluginName: "@tanstack/router",
+    pluginValue: "tanstackRouter",
+    type: "core",
+    url: "https://tanstack.com/router/latest/docs/eslint/eslint-plugin-router",
+  },
+  {
+    importString: 'import a11y from "eslint-plugin-jsx-a11y";',
+    list: a11yRules,
+    name: "jsx-a11y",
+    order: 9,
+    pluginName: "a11y",
+    pluginValue: "a11y",
+    type: "core",
+    url: "https://github.com/jsx-eslint/eslint-plugin-jsx-a11y",
+  },
+  {
+    importString: 'import cspell from "@cspell/eslint-plugin";',
+    list: cspellRules,
+    name: "@cspell/eslint-plugin",
+    order: 10,
+    pluginName: "cspell",
+    pluginValue: "cspell",
+    type: "core",
+    url: "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-eslint-plugin",
+  },
+  {
+    importString: 'import html from "@html-eslint/eslint-plugin";',
+    list: htmlRules,
+    name: "@html-eslint/eslint-plugin",
+    order: 0,
+    pluginName: "html",
+    pluginValue: "html",
+    type: "html",
+    url: "https://github.com/html-eslint/html-eslint",
+  },
+  {
+    importString: "import css from '@eslint/css';",
+    list: cssRules,
+    name: "@eslint/css",
+    order: 0,
+    pluginName: "css",
+    pluginValue: "css",
+    type: "css",
+    url: "https://github.com/eslint/css",
+  },
+  {
+    importString: 'import tailwind from "eslint-plugin-tailwindcss";',
+    list: tailwindRules,
+    name: "eslint-plugin-tailwindcss",
+    order: 0,
+    pluginName: "tailwind",
+    pluginValue: "tailwind",
+    type: "tailwind",
+    url: "https://github.com/francoismassart/eslint-plugin-tailwindcss",
+  },
+  {
+    importString: 'import markdown from "@eslint/markdown";',
+    list: markdownRules,
+    name: "@eslint/markdown",
+    order: 0,
+    pluginName: "markdown",
+    pluginValue: "markdown",
+    type: "markdown",
+    url: "https://github.com/eslint/markdown",
+  },
+  {
+    importString: `import json from "${eslintJson}";`,
+    list: jsonRules,
+    name: eslintJson,
+    order: 0,
+    pluginName: "json",
+    pluginValue: "json",
+    type: "json",
+    url: eslintJsonGithub,
+  },
+  {
+    list: jsonRules,
+    name: eslintJson,
+    order: 0,
+    pluginName: "json",
+    pluginValue: "json",
+    type: "jsonc",
+    url: eslintJsonGithub,
+  },
+  {
+    list: jsonRules,
+    name: eslintJson,
+    order: 0,
+    pluginName: "json",
+    pluginValue: "json",
+    type: "json5",
+    url: eslintJsonGithub,
+  },
+  {
+    importString: 'import astro from "eslint-plugin-astro";',
+    list: astroRules,
+    name: "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",
+    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",
+    pluginName: "react-hooks",
+    pluginValue: "reactHooks",
+    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",
+    pluginName: "solid",
+    pluginValue: "solid",
+    type: "solid",
+    url: "https://github.com/solidjs-community/eslint-plugin-solid",
+  },
+  {
+    importString: 'import angularTS from "@angular-eslint/eslint-plugin";',
+    list: angularTsRules,
+    name: "@angular-eslint/eslint-plugin",
+    pluginName: "@angular-eslint",
+    pluginValue: "angularTS",
+    type: "angular",
+    url: "https://github.com/angular-eslint/angular-eslint/blob/main/packages/eslint-plugin/README.md",
+  },
+  {
+    importString:
+      'import angularTemplate from "@angular-eslint/eslint-plugin-template";',
+    list: angularTemplateRules,
+    name: "@angular-eslint/eslint-plugin-template",
+    pluginName: "@angular-eslint/template",
+    pluginValue: "angularTemplate",
+    type: "angular:template",
+    url: "https://github.com/angular-eslint/angular-eslint/blob/main/packages/eslint-plugin-template/README.md",
+  },
+  {
+    importString: 'import storybook from "eslint-plugin-storybook";',
+    list: storybookRules,
+    name: "eslint-plugin-storybook",
+    pluginName: "storybook",
+    pluginValue: "storybook",
+    type: "storybook",
+    url: "https://github.com/storybookjs/eslint-plugin-storybook",
+  },
+];