@ethang/eslint-config 21.4.0 → 21.4.2

package/src/build/rule-list.ts

@@ -1,284 +0,0 @@
-import { a11yRules } from "../setup/a11y.ts";
-import { angularTemplateRules, angularTsRules } from "../setup/angular.js";
-import { astroRules } from "../setup/astro.ts";
-import { barrelRules } from "../setup/barrel.ts";
-import { compatRules } from "../setup/compat.ts";
-import { cspellRules } from "../setup/cspell.js";
-import { cssRules } from "../setup/css.js";
-import { dependRules } from "../setup/depend.ts";
-import { eslintRules } from "../setup/eslint.ts";
-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 {
-  reactCompilerRules,
-  reactHookRules,
-  reactRules,
-} from "../setup/react.ts";
-import { solidRules } from "../setup/solid.ts";
-import { sonarRules } from "../setup/sonar.ts";
-import { tailwindRules } from "../setup/tailwind.js";
-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";
-
-export const ruleList = [
-  {
-    importString: 'import depend from "eslint-plugin-depend";',
-    list: dependRules,
-    name: "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",
-    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",
-    order: 2,
-    pluginName: "compat",
-    pluginValue: "compat",
-    type: "core",
-    url: "https://github.com/amilajack/eslint-plugin-compat",
-  },
-  {
-    importString: undefined,
-    list: eslintRules,
-    name: "@eslint/js",
-    order: 3,
-    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: 4,
-    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: 5,
-    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: 6,
-    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: 7,
-    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 tailwind from "eslint-plugin-tailwindcss";',
-    list: tailwindRules,
-    name: "eslint-plugin-tailwindcss",
-    order: 8,
-    pluginName: "tailwind",
-    pluginValue: "tailwind",
-    type: "core",
-    url: "https://github.com/francoismassart/eslint-plugin-tailwindcss",
-  },
-  {
-    importString: 'import perfectionist from "eslint-plugin-perfectionist";',
-    list: perfectionistRules,
-    name: "eslint-plugin-perfectionist",
-    order: 9,
-    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: 10,
-    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: 11,
-    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: 12,
-    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: 13,
-    pluginName: "cspell",
-    pluginValue: "cspell",
-    type: "core",
-    url: "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-eslint-plugin",
-  },
-  {
-    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 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 reactCompiler from "eslint-plugin-react-compiler";',
-    list: reactCompilerRules,
-    name: "eslint-plugin-react-compiler",
-    pluginName: "react-compiler",
-    pluginValue: "reactCompiler",
-    type: "react",
-    url: "https://github.com/facebook/react/tree/main/compiler/packages/eslint-plugin-react-compiler",
-  },
-  {
-    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",
-  },
-];

package/src/build/update-readme.ts

@@ -1,195 +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})`;
-    });
-  },
-);
-
-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 astroRules = getList("astro");
-  const reactRules = getList("react");
-  const solidRules = getList("solid");
-  const angularRules = getList("angular");
-  const angularTemplateRules = getList("angular:template");
-
-  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);
-  }
-
-  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),
-    ],
-    `${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),
-    ],
-  ]);
-  md.newLine();
-  md.header(1, "Install", 2);
-  md.inlineCode("pnpm i -D eslint typescript-eslint @ethang/eslint-config", 2);
-  md.bold("Requires TypesScript and tsconfig.json at root directory.", 2);
-  md.header(1, "Config", 2);
-  md.text("In **eslint.config.js**", 2);
-  md.codeBlock(
-    `import config from "@ethang/eslint-config/eslint.config.js";
-import tseslint from "typescript-eslint";
-import astroConfig from "@ethang/eslint-config/config.astro.js"; // OPTIONAL
-import reactConfig from "@ethang/eslint-config/config.react.js"; // OPTIONAL
-
-export default tseslint.config(
-  {
-    ignores: [], // Ignored files apply to all following configs
-  },
-  ...config,
-  ...astroConfig,
-  ...reactConfig,
-  {
-    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",
-  "lint:fix": "eslint . --fix",
-}`,
-    "json",
-    2,
-  );
-  md.bold("Browserslist", 2);
-  md.text(
-    "This config will also lint for browserslist features. Make sure to set this in package.json. [More info.](https://github.com/browserslist/browserslist)",
-    2,
-  );
-  md.codeBlock(
-    `"browserslist": [
-  "defaults and fully supports es6-module",
-  "maintained node versions"
-]`,
-    "json",
-  );
-
-  writeFileSync(
-    path.join(import.meta.dirname, "../README.md"),
-    md.render(),
-    "utf8",
-  );
-};
-
-updateReadme();

package/src/build/update-rules.ts

@@ -1,124 +0,0 @@
-import type { ConfigOptions } from "./create-config.ts";
-
-import { createConfigFile } from "./create-config-file.ts";
-
-export type ConfigFile = {
-  importString?: string;
-  label?: string;
-  name: string;
-  options?: ConfigOptions;
-};
-
-const importTsEslint = 'import tseslint from "typescript-eslint";';
-
-export const coreFile = [
-  {
-    importString: 'import config from "@ethang/eslint-config/eslint.config.js',
-    label: "Core",
-    name: "core",
-    options: {
-      extraImports: [
-        'import { fixupPluginRules } from "@eslint/compat";', // TODO remove with v9 compat
-        'import eslintConfigPrettier from "eslint-config-prettier";',
-        'import eslintPluginPrettierRecommended from "eslint-plugin-prettier/recommended";',
-      ],
-      includeIgnores: true,
-      includeLanguageOptions: true,
-      includeReactVersion: true,
-    },
-  },
-  {
-    name: "markdown",
-  },
-  {
-    name: "css",
-  },
-  {
-    name: "json",
-  },
-  {
-    name: "jsonc",
-  },
-  {
-    name: "json5",
-  },
-];
-
-const astroFile = [
-  {
-    importString:
-      'import astroConfig from "@ethang/eslint-config/config.astro.ts',
-    label: "Astro",
-    name: "astro",
-    options: {
-      extraImports: [importTsEslint],
-      includeIgnores: true,
-      includeLanguageOptions: true,
-    },
-  },
-];
-
-const reactFile = [
-  {
-    importString:
-      'import reactConfig from "@ethang/eslint-config/config.react.ts',
-    label: "React",
-    name: "react",
-    options: {
-      extraImports: [importTsEslint],
-      includeIgnores: true,
-      includeLanguageOptions: true,
-      includeReactVersion: true,
-    },
-  },
-];
-
-const solidFile = [
-  {
-    importString:
-      'import solidConfig from "@ethang/eslint-config/config.solid.ts',
-    label: "Solid",
-    name: "solid",
-    options: {
-      extraImports: [importTsEslint],
-      includeIgnores: true,
-      includeLanguageOptions: true,
-    },
-  },
-];
-
-const angularFile = [
-  {
-    importString:
-      'import angularConfig from "@ethang/eslint-config/config.angular.ts',
-    label: "Angular",
-    name: "angular",
-    options: {
-      extraImports: [importTsEslint, 'import angular from "angular-eslint";'],
-      globalIgnores: ["**/*.spec.ts", "src/main.server.ts"],
-      includeIgnores: true,
-      includeLanguageOptions: true,
-      processor: "angular.processInlineTemplates",
-    },
-  },
-  {
-    name: "angular:template",
-    options: {
-      extraImports: ['import { angularLanguageOptions } from "./constants.js"'],
-      includeAngularLanguageOptions: true,
-      includeLanguageOptions: false,
-    },
-  },
-];
-
-export const updateRules = async () => {
-  await Promise.all([
-    createConfigFile(coreFile, "eslint.config.js"),
-    createConfigFile(astroFile, "config.astro.js"),
-    createConfigFile(reactFile, "config.react.js"),
-    createConfigFile(solidFile, "config.solid.js"),
-    createConfigFile(angularFile, "config.angular.js"),
-  ]);
-};
-
-await updateRules();