@ethang/eslint-config 24.0.2 → 24.1.0

package/src/build/list-utilities.ts

@@ -1,137 +0,0 @@
-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

@@ -1,283 +0,0 @@
-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",
-  },
-];

package/src/build/update-readme.ts

@@ -1,259 +0,0 @@
-import { MarkdownGenerator } from "@ethang/markdown-generator/markdown-generator.js";
-import filter from "lodash/filter.js";
-import flow from "lodash/flow.js";
-import isArray from "lodash/isArray.js";
-import map from "lodash/map.js";
-import values from "lodash/values.js";
-import { writeFileSync } from "node:fs";
-import path from "node:path";
-
-import type { genRules } from "../setup/gen-rules.ts";
-
-import { getList } from "./list-utilities.ts";
-
-const getRuleCount = (rules: ReturnType<typeof genRules>) => {
-  let count = 0;
-  for (const value of values(rules)) {
-    if ("error" === value || (isArray(value) && "error" === value[0])) {
-      count += 1;
-    }
-  }
-
-  return count;
-};
-
-const getImports = flow(
-  (rules: ReturnType<typeof getList>) => {
-    return filter(rules, (rule) => {
-      return 0 < getRuleCount(rule.list);
-    });
-  },
-  (filteredRules) => {
-    return map(filteredRules, (rule) => {
-      return `${getRuleCount(rule.list)} rules from [${rule.name}](${rule.url})`;
-    });
-  },
-);
-
-// eslint-disable-next-line sonar/max-lines-per-function
-export const updateReadme = () => {
-  const md = new MarkdownGenerator();
-  md.header(1, "Relentless. Unapologetic.", 2);
-  md.link("View Config", "https://eslint-config-ethang.pages.dev/rules", 2);
-  md.alert("CAUTION", "Prettier is already included for styling!", 2);
-
-  const coreRules = map(
-    [
-      ...getList("core"),
-      ...getList("json"),
-      ...getList("css"),
-      ...getList("markdown"),
-    ],
-    (rules) => {
-      return {
-        ...rules,
-        count: 0,
-      };
-    },
-  );
-
-  let total = 0;
-  for (const list of coreRules) {
-    const count = getRuleCount(list.list);
-    total += count;
-    list.count = count;
-  }
-  coreRules.sort((a, b) => {
-    return b.count - a.count;
-  });
-
-  const ruleDocumentation = [`${total} errored rules.`];
-  for (const list of coreRules) {
-    if (0 < list.count) {
-      ruleDocumentation.push(
-        `${list.count} ${
-          1 >= list.count ? "rule" : "rules"
-        } from [${list.name}](${list.url})`,
-      );
-    }
-  }
-
-  const htmlRules = getList("html");
-  const tailwindRules = getList("tailwind");
-  const astroRules = getList("astro");
-  const reactRules = getList("react");
-  const solidRules = getList("solid");
-  const angularRules = getList("angular");
-  const angularTemplateRules = getList("angular:template");
-  const storybookRules = getList("storybook");
-
-  let htmlCount = 0;
-  for (const htmlRule of htmlRules) {
-    htmlCount += getRuleCount(htmlRule.list);
-  }
-
-  let tailwindCount = 0;
-  for (const tailwindRule of tailwindRules) {
-    tailwindCount += getRuleCount(tailwindRule.list);
-  }
-
-  let astroCount = 0;
-  for (const astroRule of astroRules) {
-    astroCount += getRuleCount(astroRule.list);
-  }
-
-  let reactCount = 0;
-  for (const reactRule of reactRules) {
-    reactCount += getRuleCount(reactRule.list);
-  }
-
-  let solidCount = 0;
-  for (const solidRule of solidRules) {
-    solidCount += getRuleCount(solidRule.list);
-  }
-
-  let angularCount = 0;
-  for (const angularRule of [...angularRules, ...angularTemplateRules]) {
-    angularCount += getRuleCount(angularRule.list);
-  }
-
-  let storybookCount = 0;
-  for (const storybookRule of storybookRules) {
-    storybookCount += getRuleCount(storybookRule.list);
-  }
-
-  md.unorderedList(ruleDocumentation);
-  md.newLine();
-  md.header(1, "Add Even More!", 2);
-  md.unorderedList([
-    `${angularCount} rules for **Angular**`,
-    [
-      '`import angularConfig from "@ethang/eslint-config/config.angular.js";`',
-      getImports(angularRules),
-      getImports(angularTemplateRules),
-    ],
-    `${astroCount} rules for **Astro**`,
-    [
-      '`import astroConfig from "@ethang/eslint-config/config.astro.js";`',
-      getImports(astroRules),
-    ],
-    `${htmlCount} rules for **HTML**`,
-    [
-      `import html from "@ethang/eslint-config/config.html.js";`,
-      getImports(htmlRules),
-    ],
-    `${reactCount} rules for **React**`,
-    [
-      '`import reactConfig from "@ethang/eslint-config/config.react.js";`',
-      getImports(reactRules),
-    ],
-    `${solidCount} rules for **Solid**`,
-    [
-      '`import solidConfig from "@ethang/eslint-config/config.solid.js";`',
-      getImports(solidRules),
-    ],
-    `${storybookCount} rules for **Storybook**`,
-    [
-      '`import storybookConfig from "@ethang/eslint-config/config.storybook.js";`',
-      getImports(storybookRules),
-    ],
-    `${tailwindCount} rules for **Tailwind**`,
-    [
-      `import tailwindConfig from "@ethang/eslint-config/config.tailwind.js";`,
-      getImports(tailwindRules),
-    ],
-  ]);
-  md.newLine();
-  md.header(1, "Install", 2);
-  md.codeBlock("pnpm i -D eslint @ethang/eslint-config", "powershell", 2);
-  md.bold("Requires TypesScript and tsconfig.json at root directory.", 2);
-  md.header(1, "Config", 2);
-  md.text("In **eslint.config.ts**", 2);
-  md.codeBlock(
-    `import config from "@ethang/eslint-config/eslint.config.js";
-import { defineConfig } from "eslint/config";
-import path from "node:path";
-import reactConfig from "@ethang/eslint-config/config.react.js"; // OPTIONAL
-import tailwindConfig from "@ethang/eslint-config/config.tailwind.js"; // OPTIONAL
-import htmlConfig from "@ethang/eslint-config/config.html.js"; // OPTIONAL
-
-export default defineConfig(
-  {
-    ignores: [], // Ignored files apply to all following configs
-  },
-  ...config,
-  ...reactConfig,
-  ...htmlConfig,
-  ...tailwindConfig(path.join(import.meta.dirname, "src", "index.css")),
-  {
-    languageOptions: {
-      parserOptions: {
-        project: true,
-        tsconfigRootDir: import.meta.dirname,
-      },
-    },
-    rules: {
-      // Override rules from above configs
-    },
-  }
-);`,
-    "js",
-    2,
-  );
-  md.bold("Scripts", 2);
-  md.codeBlock(
-    `"scripts": {
-  "lint": "eslint . --fix --concurrency=auto"
-}`,
-    "json",
-    2,
-  );
-  md.bold("Browserslist", 2);
-  md.text(
-    "This config will also lint for browserslist features. [More info.](https://github.com/browserslist/browserslist)",
-    2,
-  );
-  md.text("It's recommended to use ");
-  md.link(
-    "browserslist-config-baseline",
-    "https://github.com/web-platform-dx/browserslist-config-baseline",
-    2,
-  );
-  md.codeBlock("pnpm i -D browserslist-config-baseline", "powershell", 2);
-
-  md.codeBlock(
-    `"browserslist": [
-  "extends browserslist-config-baseline",
-  "current node"
-],`,
-    "json",
-    2,
-  );
-
-  md.text("Or a simpler config without an additional dependency.", 2);
-
-  md.codeBlock(
-    `"browserslist": [
-  "defaults and fully supports es6-module",
-  "current node"
-],`,
-    "json",
-    2,
-  );
-
-  md.bold("Engines", 2);
-  md.codeBlock(
-    `"engines": {
-  "node": ">=24"
-},`,
-    "json",
-  );
-
-  writeFileSync(
-    path.join(import.meta.dirname, "../README.md"),
-    md.render(),
-    "utf8",
-  );
-};
-
-updateReadme();