@ethang/eslint-config 19.0.6 → 19.0.8

package/.github/dependabot.yml

@@ -1,13 +1,13 @@
-version: 2
-updates:
-  - package-ecosystem: "github-actions"
-    directory: /
-    schedule:
-      interval: daily
-    target-branch: "master"
-
-  - package-ecosystem: npm
-    directory: /
-    schedule:
-      interval: daily
-    target-branch: "master"
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: /
+    schedule:
+      interval: daily
+    target-branch: "master"
+
+  - package-ecosystem: npm
+    directory: /
+    schedule:
+      interval: daily
+    target-branch: "master"

package/README.md

@@ -1,83 +1,82 @@
-# Opinionated, Strict, Brutal, Unforgiving
-
-[View Config](https://eslint-config-ethang.pages.dev/rules)
-
-Do **NOT** use this with Prettier! Styling rules are included.
-
-* 900 errored rules.
-* 300 rules from [eslint-plugin-sonarjs](https://github.com/SonarSource/eslint-plugin-sonarjs)
-* 140 rules from vanilla EsLint
-* 113 rules from [sindresorhus/eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn)
-* 103 rules from [@typescript/eslint](https://github.com/typescript-eslint/typescript-eslint)
-* 91 rules from [@stylistic/eslint-plugin](https://eslint.style/)
-* 42 rules from [eslint-plugin-lodash](https://github.com/wix-incubator/eslint-plugin-lodash)
-* 35 rules from [jsx-a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y)
-* 20 rules from [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n/tree/67bbfdf3c6862dcbfe455a4afbd83fa60f9d1ea4)
-* 20 rules from [eslint-plugin-github](https://github.com/github/eslint-plugin-github)
-* 19 rules from [eslint-plugin-perfectionist](https://github.com/azat-io/eslint-plugin-perfectionist)
-* 7 rules from [eslint-plugin-tailwindcss](https://github.com/francoismassart/eslint-plugin-tailwindcss)
-* 4 rules from [eslint-plugin-barrel-files](https://github.com/thepassle/eslint-plugin-barrel-files)
-* 4 rules from [@tanstack/eslint-plugin-query](https://tanstack.com/query/latest/docs/eslint/eslint-plugin-query)
-* 1 rule from [eslint-plugin-depend](https://github.com/es-tooling/eslint-plugin-depend/tree/main)
-* 1 rule from [eslint-plugin-compat](https://github.com/amilajack/eslint-plugin-compat)
-
-# Add Even More!
-* 51 rules for **Astro**
-  * `import configAstro from "@ethang/eslint-config/config.astro.js";`
-  * 51 rules from [eslint-plugin-astro](https://github.com/ota-meshi/eslint-plugin-astro)
-* 72 rules for **React**
-  * `import configReact from "@ethang/eslint-config/config.react.js";`
-  * 70 rules from [@eslint-react/eslint-plugin](https://eslint-react.xyz/)
-  * 2 rules from [eslint-plugin-react-hooks](https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks)
-* 18 rules for **Solid**
-  * `import configSolid from "@ethang/eslint-config/config-solid.js";`
-  * 18 rules from [eslint-plugin-solid](https://github.com/solidjs-community/eslint-plugin-solid)
-
-# Install
-
-`pnpm i -D eslint typescript-eslint @ethang/eslint-config`
-
-**Requires TypesScript and tsconfig.json at root directory.**
-
-# Config
-
-In **eslint.config.js**
-
-```js
-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(...config, ...astroConfig, ...reactConfig, {
-  languageOptions: {
-    parserOptions: {
-      project: true,
-      tsconfigRootDir: import.meta.dirname,
-    },
-  },
-  rules: {
-    // your custom rules here
-  },
-});
-```
-
-**Scripts**:
-
-```json
-"scripts": {
-  "lint": "eslint",
-  "lint:fix": "eslint . --fix",
-}
-```
-
-**Browserslist**
-
-This config will also lint for browserslist features. Make sure to set this in package.json. [More info.](https://github.com/browserslist/browserslist)
-
-```json
-"browserslist": [
-  "defaults and fully supports es6-module",
-  "maintained node versions"
-]
-```
+# Opinionated, Strict, Brutal, Unforgiving
+
+[View Config](https://eslint-config-ethang.pages.dev/rules)
+
+Do **NOT** use this with Prettier! Styling rules are included.
+
+- 873 errored rules.
+- 289 rules from [eslint-plugin-sonarjs](https://github.com/SonarSource/SonarJS/blob/master/packages/jsts/src/rules/README.md)
+- 144 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)
+- 103 rules from [@typescript/eslint](https://github.com/typescript-eslint/typescript-eslint)
+- 91 rules from [@stylistic/eslint-plugin](https://eslint.style/)
+- 42 rules from [eslint-plugin-lodash](https://github.com/wix-incubator/eslint-plugin-lodash)
+- 35 rules from [jsx-a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y)
+- 20 rules from [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n)
+- 19 rules from [eslint-plugin-perfectionist](https://github.com/azat-io/eslint-plugin-perfectionist)
+- 7 rules from [eslint-plugin-tailwindcss](https://github.com/francoismassart/eslint-plugin-tailwindcss)
+- 4 rules from [eslint-plugin-barrel-files](https://github.com/thepassle/eslint-plugin-barrel-files)
+- 4 rules from [@tanstack/eslint-plugin-query](https://tanstack.com/query/latest/docs/eslint/eslint-plugin-query)
+- 1 rule from [eslint-plugin-depend](https://github.com/es-tooling/eslint-plugin-depend/tree/main)
+- 1 rule from [eslint-plugin-compat](https://github.com/amilajack/eslint-plugin-compat)
+
+# Add Even More!
+
+- 51 rules for **Astro**
+  - `import astroConfig from "@ethang/eslint-config/config.astro.js";`
+  - 51 rules from [eslint-plugin-astro](https://github.com/ota-meshi/eslint-plugin-astro)
+- 68 rules for **React**
+  - `import reactConfig from "@ethang/eslint-config/config.react.js";`
+  - 68 rules from [@eslint-react/eslint-plugin](https://eslint-react.xyz/)
+- 18 rules for **Solid**
+  - `import solidConfig from "@ethang/eslint-config/config.solid.js";`
+  - 18 rules from [eslint-plugin-solid](https://github.com/solidjs-community/eslint-plugin-solid)
+
+# Install
+
+`pnpm i -D eslint typescript-eslint @ethang/eslint-config`
+
+**Requires TypesScript and tsconfig.json at root directory.**
+
+# Config
+
+In **eslint.config.js**
+
+```js
+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(...config, ...astroConfig, ...reactConfig, {
+  languageOptions: {
+    parserOptions: {
+      project: true,
+      tsconfigRootDir: import.meta.dirname,
+    },
+  },
+  rules: {
+    // your custom rules here
+  },
+});
+```
+
+**Scripts**:
+
+```json
+"scripts": {
+  "lint": "eslint",
+  "lint:fix": "eslint . --fix",
+}
+```
+
+**Browserslist**
+
+This config will also lint for browserslist features. Make sure to set this in package.json. [More info.](https://github.com/browserslist/browserslist)
+
+```json
+"browserslist": [
+  "defaults and fully supports es6-module",
+  "maintained node versions"
+]
+```

package/build/update-readme.js

@@ -0,0 +1,152 @@
+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 { readFileSync, writeFileSync } from "node:fs";
+import { join } from "node:path";
+
+export const updateReadme = () => {
+  const getRuleCount = (rules) => {
+    let count = 0;
+    Object.values(rules).forEach((value) => {
+      if (value === "error" || (Array.isArray(value) && value[0] === "error")) {
+        count += 1;
+      }
+    });
+
+    return count;
+  };
+
+  const ruleList = [
+    {
+      list: dependRules,
+      name: "eslint-plugin-depend",
+      url: "https://github.com/es-tooling/eslint-plugin-depend/tree/main",
+    },
+    {
+      list: barrelRules,
+      name: "eslint-plugin-barrel-files",
+      url: "https://github.com/thepassle/eslint-plugin-barrel-files",
+    },
+    {
+      list: compatRules,
+      name: "eslint-plugin-compat",
+      url: "https://github.com/amilajack/eslint-plugin-compat",
+    },
+    {
+      list: eslintRules,
+      name: "@eslint/js",
+      url: "https://github.com/eslint/eslint/tree/main/packages/js",
+    },
+    {
+      list: nRules,
+      name: "eslint-plugin-n",
+      url: "https://github.com/eslint-community/eslint-plugin-n",
+    },
+    {
+      list: typescriptRules,
+      name: "@typescript/eslint",
+      url: "https://github.com/typescript-eslint/typescript-eslint",
+    },
+    {
+      list: unicornRules,
+      name: "sindresorhus/eslint-plugin-unicorn",
+      url: "https://github.com/sindresorhus/eslint-plugin-unicorn",
+    },
+    {
+      list: lodashRules,
+      name: "eslint-plugin-lodash",
+      url: "https://github.com/wix-incubator/eslint-plugin-lodash",
+    },
+    {
+      list: sonarRules,
+      name: "eslint-plugin-sonarjs",
+      url: "https://github.com/SonarSource/SonarJS/blob/master/packages/jsts/src/rules/README.md",
+    },
+    {
+      list: tanstackQueryRules,
+      name: "@tanstack/eslint-plugin-query",
+      url: "https://tanstack.com/query/latest/docs/eslint/eslint-plugin-query",
+    },
+    {
+      list: tailwindRules,
+      name: "eslint-plugin-tailwindcss",
+      url: "https://github.com/francoismassart/eslint-plugin-tailwindcss",
+    },
+    {
+      list: stylisticRules,
+      name: "@stylistic/eslint-plugin",
+      url: "https://eslint.style/",
+    },
+    {
+      list: perfectionistRules,
+      name: "eslint-plugin-perfectionist",
+      url: "https://github.com/azat-io/eslint-plugin-perfectionist",
+    },
+    {
+      list: a11yRules,
+      name: "jsx-a11y",
+      url: "https://github.com/jsx-eslint/eslint-plugin-jsx-a11y",
+    },
+  ];
+
+  let total = 0;
+  for (const list of ruleList) {
+    const count = getRuleCount(list.list);
+    total += count;
+    list["count"] = count;
+  }
+  ruleList.sort((a, b) => {
+    return b.count - a.count;
+  });
+
+  const ruleDocs = [`- ${total} errored rules.`];
+  for (const list of ruleList) {
+    ruleDocs.push(
+      `- ${list.count} ${list.count <= 1 ? "rule" : "rules"} from [${list.name}](${list.url})`,
+    );
+  }
+
+  const readme = readFileSync(
+    join(import.meta.dirname, "../README.md"),
+    "utf8",
+  );
+  let readmeLines = readme.split("\n");
+
+  let start = 0;
+  let end = 0;
+  for (let index = 1; index < readmeLines.length; index++) {
+    if (
+      readmeLines[index] ===
+      "Do **NOT** use this with Prettier! Styling rules are included."
+    ) {
+      start = index;
+    }
+
+    if (readmeLines[index] === "# Add Even More!") {
+      end = index;
+    }
+
+    if (start !== 0 && end !== 0) {
+      break;
+    }
+  }
+
+  readmeLines = [
+    ...readmeLines.splice(0, start + 2),
+    ...ruleDocs,
+    ...readmeLines.splice(end - 7),
+  ].join("\n");
+
+  writeFileSync(join(import.meta.dirname, "../README.md"), readmeLines, "utf8");
+};

package/build/update-rules.js

@@ -0,0 +1,70 @@
+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 { readFileSync, writeFileSync } from "node:fs";
+import { join } from "node:path";
+
+export const updateRules = () => {
+  const rules = {
+    ...dependRules,
+    ...barrelRules,
+    ...compatRules,
+    ...eslintRules,
+    ...nRules,
+    ...typescriptRules,
+    ...unicornRules,
+    ...lodashRules,
+    ...sonarRules,
+    ...tanstackQueryRules,
+    ...tailwindRules,
+    ...stylisticRules,
+    ...perfectionistRules,
+    ...a11yRules,
+  };
+
+  let jsonified = JSON.stringify(rules);
+  jsonified = jsonified.slice(1, -1);
+
+  const config = readFileSync(
+    join(import.meta.dirname, "../eslint.config.js"),
+    "utf8",
+  );
+  const lines = config.split("\n");
+
+  let rulesStart = 0;
+  let rulesEnd = 0;
+  for (let index = 1; index < lines.length; index++) {
+    if (lines[index].endsWith("rules: {")) {
+      rulesStart = index;
+    }
+
+    if (0 !== rulesStart && lines[index].endsWith("},")) {
+      rulesEnd = index;
+    }
+  }
+
+  const updated = [
+    ...lines.slice(0, rulesStart),
+    "rules: {",
+    jsonified,
+    "},",
+    ...lines.slice(rulesEnd + 1),
+  ].join("\n");
+
+  writeFileSync(
+    join(import.meta.dirname, "../eslint.config.js"),
+    updated,
+    "utf8",
+  );
+};

package/build.mjs

@@ -1,5 +1,10 @@
 // @ts-check
 import { projectBuilder } from "@ethang/project-builder/project-builder.js";
+import { updateRules } from "./build/update-rules.js";
+import { updateReadme } from "./build/update-readme.js";
+
+updateRules();
+updateReadme();
 
 await projectBuilder("eslint-config-ethang", "master", {
   isLibrary: true,

package/config.react.js

@@ -14,8 +14,8 @@ export default tseslint.config({
     "react-hooks": reactHooks,
   },
   rules: {
-    "react-hooks/exhaustive-deps": "off", // fix w/ v9 compatibility
-    "react-hooks/rules-of-hooks": "off", // fix w/ v9 compatibility
+    "react-hooks/exhaustive-deps": "off", // TODO fix w/ v9 compatibility
+    "react-hooks/rules-of-hooks": "off", // TODO fix w/ v9 compatibility
     "react/dom/no-children-in-void-dom-elements": "error",
     "react/dom/no-dangerously-set-innerhtml": "error",
     "react/dom/no-dangerously-set-innerhtml-with-children": "error",
@@ -35,10 +35,7 @@ export default tseslint.config({
     "react/hooks-extra/no-direct-set-state-in-use-layout-effect": "error",
     "react/hooks-extra/prefer-use-state-lazy-initialization": "error",
     "react/naming-convention/component-name": "error",
-    "react/naming-convention/filename": [
-      "error",
-      { rule: "kebab-case" },
-    ],
+    "react/naming-convention/filename": ["error", { rule: "kebab-case" }],
     "react/naming-convention/filename-extension": "error",
     "react/naming-convention/use-state": "error",
     "react/no-access-state-in-setstate": "error",