@ethang/eslint-config 19.0.10 → 19.1.0

package/README.md

@@ -2,9 +2,10 @@
 
 [View Config](https://eslint-config-ethang.pages.dev/rules)
 
-Do **NOT** use this with Prettier! Styling rules are included.
+> [!CAUTION]
+> Do not use this with Prettier! Styling rules are included.
 
-- 873 errored rules.
+- 882 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)
@@ -15,8 +16,10 @@ Do **NOT** use this with Prettier! Styling rules are included.
 - 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)
+- 7 rules from [@eslint/markdown](https://github.com/eslint/markdown)
 - 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)
+- 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 [eslint-plugin-compat](https://github.com/amilajack/eslint-plugin-compat)
 
@@ -61,7 +64,7 @@ export default tseslint.config(...config, ...astroConfig, ...reactConfig, {
 });
 ```
 
-**Scripts**:
+**Scripts**
 
 ```json
 "scripts": {

package/build/update-readme.js

@@ -14,8 +14,22 @@ import { perfectionistRules } from "../setup/perfectionist.js";
 import { a11yRules } from "../setup/a11y.js";
 import { readFileSync, writeFileSync } from "node:fs";
 import { join } from "node:path";
+import { MarkdownGenerator } from "@ethang/markdown-generator/markdown-generator.js";
+import { markdownRules } from "../setup/markdown.js";
+import { jsonRules } from "../setup/json.js";
 
 export const updateReadme = () => {
+  const md = new MarkdownGenerator();
+  md.header(1, "Opinionated, Strict, Brutal, Unforgiving");
+  md.newLine(2);
+  md.link("View Config", "https://eslint-config-ethang.pages.dev/rules");
+  md.newLine(2);
+  md.alert(
+    "CAUTION",
+    "Do not use this with Prettier! Styling rules are included.",
+  );
+  md.newLine(2);
+
   const getRuleCount = (rules) => {
     let count = 0;
     Object.values(rules).forEach((value) => {
@@ -98,6 +112,16 @@ export const updateReadme = () => {
       name: "jsx-a11y",
       url: "https://github.com/jsx-eslint/eslint-plugin-jsx-a11y",
     },
+    {
+      list: markdownRules,
+      name: "@eslint/markdown",
+      url: "https://github.com/eslint/markdown",
+    },
+    {
+      list: jsonRules,
+      name: "@eslint/json",
+      url: "https://github.com/eslint/json",
+    },
   ];
 
   let total = 0;
@@ -110,43 +134,95 @@ export const updateReadme = () => {
     return b.count - a.count;
   });
 
-  const ruleDocs = [`- ${total} errored rules.`];
+  const ruleDocs = [`${total} errored rules.`];
   for (const list of ruleList) {
     ruleDocs.push(
-      `- ${list.count} ${list.count <= 1 ? "rule" : "rules"} from [${list.name}](${list.url})`,
+      `${list.count} ${list.count <= 1 ? "rule" : "rules"} from [${list.name}](${list.url})`,
     );
   }
 
-  const readme = readFileSync(
-    join(import.meta.dirname, "../README.md"),
-    "utf8",
+  md.unorderedList(ruleDocs);
+  md.newLine();
+  md.header(1, "Add Even More!");
+  md.newLine(2);
+  md.unorderedList(["51 rules for **Astro**"]);
+  md.unorderedList(
+    [
+      '`import astroConfig from "@ethang/eslint-config/config.astro.js";`',
+      "51 rules from [eslint-plugin-astro](https://github.com/ota-meshi/eslint-plugin-astro)",
+    ],
+    2,
   );
-  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;
-    }
-  }
+  md.unorderedList(["68 rules for **React**"]);
+  md.unorderedList(
+    [
+      '`import reactConfig from "@ethang/eslint-config/config.react.js";`',
+      "68 rules from [@eslint-react/eslint-plugin](https://eslint-react.xyz/)",
+    ],
+    2,
+  );
+  md.unorderedList(["18 rules for **Solid**"]);
+  md.unorderedList(
+    [
+      '`import solidConfig from "@ethang/eslint-config/config.solid.js";`',
+      "18 rules from [eslint-plugin-solid](https://github.com/solidjs-community/eslint-plugin-solid)",
+    ],
+    2,
+  );
+  md.newLine();
+  md.header(1, "Install");
+  md.newLine(2);
+  md.inlineCode("pnpm i -D eslint typescript-eslint @ethang/eslint-config");
+  md.newLine(2);
+  md.bold("Requires TypesScript and tsconfig.json at root directory.");
+  md.newLine(2);
+  md.header(1, "Config");
+  md.newLine(2);
+  md.text("In **eslint.config.js**");
+  md.newLine(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
 
-  readmeLines = [
-    ...readmeLines.splice(0, start + 2),
-    ...ruleDocs,
-    ...readmeLines.splice(end - 7),
-  ].join("\n");
+export default tseslint.config(...config, ...astroConfig, ...reactConfig, {
+  languageOptions: {
+    parserOptions: {
+      project: true,
+      tsconfigRootDir: import.meta.dirname,
+    },
+  },
+  rules: {
+    // your custom rules here
+  },
+});`,
+    "js",
+  );
+  md.newLine(2);
+  md.bold("Scripts");
+  md.newLine(2);
+  md.codeBlock(
+    `"scripts": {
+  "lint": "eslint",
+  "lint:fix": "eslint . --fix",
+}`,
+    "json",
+  );
+  md.newLine(2);
+  md.bold("Browserslist");
+  md.newLine(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)",
+  );
+  md.newLine(2);
+  md.codeBlock(
+    `"browserslist": [
+  "defaults and fully supports es6-module",
+  "maintained node versions"
+]`,
+    "json",
+  );
 
-  writeFileSync(join(import.meta.dirname, "../README.md"), readmeLines, "utf8");
+  writeFileSync(join(import.meta.dirname, "../README.md"), md.render(), "utf8");
 };

package/build/update-rules.js

@@ -14,9 +14,14 @@ import { perfectionistRules } from "../setup/perfectionist.js";
 import { a11yRules } from "../setup/a11y.js";
 import { readFileSync, writeFileSync } from "node:fs";
 import { join } from "node:path";
+import { deprecatedRules } from "../setup/deprecated.js";
+import { markdownRules } from "../setup/markdown.js";
+import { jsonRules } from "../setup/json.js";
 
 export const updateRules = () => {
-  const rules = {
+  let configFile = "";
+
+  const jsRules = {
     ...dependRules,
     ...barrelRules,
     ...compatRules,
@@ -31,40 +36,97 @@ export const updateRules = () => {
     ...stylisticRules,
     ...perfectionistRules,
     ...a11yRules,
+    ...deprecatedRules,
   };
 
-  let jsonified = JSON.stringify(rules);
-  jsonified = jsonified.slice(1, -1);
+  let jsRulesJon = JSON.stringify(jsRules);
+  jsRulesJon = jsRulesJon.slice(1, -1);
 
-  const config = readFileSync(
-    join(import.meta.dirname, "../eslint.config.js"),
-    "utf8",
-  );
-  const lines = config.split("\n");
+  let markdownRulesJson = JSON.stringify(markdownRules);
+  markdownRulesJson = markdownRulesJson.slice(1, -1);
 
-  let rulesStart = 0;
-  let rulesEnd = 0;
-  for (let index = 1; index < lines.length; index++) {
-    if (lines[index].endsWith("rules: {")) {
-      rulesStart = index;
-    }
+  let jsonRulesJson = JSON.stringify(jsonRules);
+  jsonRulesJson = jsonRulesJson.slice(1, -1);
 
-    if (0 !== rulesStart && lines[index].endsWith("},")) {
-      rulesEnd = index;
-    }
-  }
+  const importList = [
+    'import parser from "@typescript-eslint/parser";',
+    'import a11y from "eslint-plugin-jsx-a11y/lib/index.js";',
+    'import n from "eslint-plugin-n";',
+    'import unicorn from "eslint-plugin-unicorn";',
+    'import tseslint from "typescript-eslint";',
+    'import sonar from "eslint-plugin-sonarjs";',
+    'import tanstack from "@tanstack/eslint-plugin-query";',
+    'import perfectionist from "eslint-plugin-perfectionist";',
+    'import depend from "eslint-plugin-depend";',
+    'import barrel from "eslint-plugin-barrel-files";',
+    'import compat from "eslint-plugin-compat";',
+    'import lodashConfig from "eslint-plugin-lodash";',
+    'import tailwind from "eslint-plugin-tailwindcss";',
+    'import stylistic from "@stylistic/eslint-plugin";',
+    'import markdown from "@eslint/markdown";',
+    'import json from "@eslint/json";',
+    'import { ignores } from "./constants.js";',
+  ].sort((a, b) => {
+    return a.localeCompare(b);
+  });
+
+  importList.forEach((item) => {
+    configFile += `${item}\n`;
+  });
+
+  configFile += `\nexport const languageOptions = {
+  parser,
+  parserOptions: {
+    project: true,
+    tsconfigRootDir: import.meta.dirname,
+  },
+};
 
-  const updated = [
-    ...lines.slice(0, rulesStart),
-    "rules: {",
-    jsonified,
-    "},",
-    ...lines.slice(rulesEnd + 1),
-  ].join("\n");
+export default tseslint.config(
+  {
+    files: ["**/*.{js,ts,jsx,tsx,cjs,cts,mjs,mts}"],
+    ignores,
+    languageOptions,
+    plugins: {
+      "@tanstack/query": tanstack,
+      "@typescript-eslint": tseslint.plugin,
+      a11y,
+      barrel,
+      compat,
+      depend,
+      lodash: lodashConfig,
+      n,
+      perfectionist,
+      sonar,
+      stylistic,
+      tailwind,
+      unicorn,
+    },
+    rules: {
+      ${jsRulesJon}
+    },
+  },
+  {
+    files: ["**/*.md"],
+    plugins: {
+      markdown,
+    },
+    rules: {
+      ${markdownRulesJson}
+    },
+  },
+  {
+    files: ["**/*.{json,jsonc,json5}"],
+    plugins: { json },
+    rules: {
+      ${jsonRulesJson}
+    },
+  },
+);\n`;
 
   writeFileSync(
     join(import.meta.dirname, "../eslint.config.js"),
-    updated,
+    configFile,
     "utf8",
   );
 };

package/config.astro.js

@@ -1,7 +1,9 @@
 import astro from "eslint-plugin-astro";
 import tseslint from "typescript-eslint";
 
-import { ignores, languageOptions } from "./eslint.config.js";
+import { languageOptions } from "./eslint.config.js";
+import { ignores } from "./constants.js";
+import { astroRules } from "./setup/astro.js";
 
 export default tseslint.config({
   files: ["**/*.{astro}"],
@@ -9,56 +11,6 @@ export default tseslint.config({
   languageOptions,
   plugins: { astro },
   rules: {
-    "astro/jsx-a11y/alt-text": "error",
-    "astro/jsx-a11y/anchor-ambiguous-text": "error",
-    "astro/jsx-a11y/anchor-has-content": "error",
-    "astro/jsx-a11y/anchor-is-valid": "error",
-    "astro/jsx-a11y/aria-activedescendant-has-tabindex": "error",
-    "astro/jsx-a11y/aria-props": "error",
-    "astro/jsx-a11y/aria-proptypes": "error",
-    "astro/jsx-a11y/aria-role": "error",
-    "astro/jsx-a11y/aria-unsupported-elements": "error",
-    "astro/jsx-a11y/autocomplete-valid": "error",
-    "astro/jsx-a11y/click-events-have-key-events": "error",
-    "astro/jsx-a11y/control-has-associated-label": "error",
-    "astro/jsx-a11y/heading-has-content": "error",
-    "astro/jsx-a11y/html-has-lang": "error",
-    "astro/jsx-a11y/iframe-has-title": "error",
-    "astro/jsx-a11y/img-redundant-alt": "error",
-    "astro/jsx-a11y/interactive-supports-focus": "error",
-    "astro/jsx-a11y/label-has-associated-control": "error",
-    "astro/jsx-a11y/lang": "error",
-    "astro/jsx-a11y/media-has-caption": "error",
-    "astro/jsx-a11y/mouse-events-have-key-events": "error",
-    "astro/jsx-a11y/no-access-key": "error",
-    "astro/jsx-a11y/no-aria-hidden-on-focusable": "error",
-    "astro/jsx-a11y/no-autofocus": "error",
-    "astro/jsx-a11y/no-distracting-elements": "error",
-    "astro/jsx-a11y/no-interactive-element-to-noninteractive-role": "error",
-    "astro/jsx-a11y/no-noninteractive-element-interactions": "error",
-    "astro/jsx-a11y/no-noninteractive-element-to-interactive-role": "error",
-    "astro/jsx-a11y/no-noninteractive-tabindex": "error",
-    "astro/jsx-a11y/no-redundant-roles": "error",
-    "astro/jsx-a11y/no-static-element-interactions": "error",
-    "astro/jsx-a11y/prefer-tag-over-role": "error",
-    "astro/jsx-a11y/role-has-required-aria-props": "error",
-    "astro/jsx-a11y/role-supports-aria-props": "error",
-    "astro/jsx-a11y/scope": "error",
-    "astro/jsx-a11y/tabindex-no-positive": "error",
-    "astro/missing-client-only-directive-value": "error",
-    "astro/no-conflict-set-directives": "error",
-    "astro/no-deprecated-astro-canonicalurl": "error",
-    "astro/no-deprecated-astro-fetchcontent": "error",
-    "astro/no-deprecated-astro-resolve": "error",
-    "astro/no-deprecated-getentrybyslug": "error",
-    "astro/no-exports-from-components": "error",
-    "astro/no-set-text-directive": "error",
-    "astro/no-unused-css-selector": "error",
-    "astro/no-unused-define-vars-in-style": "error",
-    "astro/prefer-class-list-directive": "error",
-    "astro/prefer-object-class-list": "error",
-    "astro/prefer-split-class-list": "error",
-    "astro/semi": "error",
-    "astro/valid-compile": "error",
+    ...astroRules,
   },
 });

package/config.react.js

@@ -2,7 +2,9 @@ import react from "@eslint-react/eslint-plugin";
 import reactHooks from "eslint-plugin-react-hooks";
 import tseslint from "typescript-eslint";
 
-import { ignores, languageOptions } from "./eslint.config.js";
+import { languageOptions } from "./eslint.config.js";
+import { ignores } from "./constants.js";
+import { reactRules } from "./setup/react.js";
 
 export default tseslint.config({
   files: ["**/*.{jsx,tsx}"],
@@ -10,79 +12,9 @@ export default tseslint.config({
   languageOptions,
   plugins: {
     react,
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
     "react-hooks": reactHooks,
   },
   rules: {
-    "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",
-    "react/dom/no-find-dom-node": "error",
-    "react/dom/no-missing-button-type": "error",
-    "react/dom/no-missing-iframe-sandbox": "error",
-    "react/dom/no-namespace": "error",
-    "react/dom/no-render-return-value": "error",
-    "react/dom/no-script-url": "error",
-    "react/dom/no-unsafe-iframe-sandbox": "error",
-    "react/dom/no-unsafe-target-blank": "error",
-    "react/ensure-forward-ref-using-ref": "error",
-    "react/hooks-extra/ensure-custom-hooks-using-other-hooks": "error",
-    "react/hooks-extra/ensure-use-callback-has-non-empty-deps": "error",
-    "react/hooks-extra/ensure-use-memo-has-non-empty-deps": "error",
-    "react/hooks-extra/no-direct-set-state-in-use-effect": "error",
-    "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-extension": "error",
-    "react/naming-convention/use-state": "error",
-    "react/no-access-state-in-setstate": "error",
-    "react/no-array-index-key": "error",
-    "react/no-children-count": "error",
-    "react/no-children-for-each": "error",
-    "react/no-children-map": "error",
-    "react/no-children-only": "error",
-    "react/no-children-prop": "error",
-    "react/no-children-to-array": "error",
-    "react/no-class-component": "error",
-    "react/no-clone-element": "error",
-    "react/no-comment-textnodes": "error",
-    "react/no-complex-conditional-rendering": "error",
-    "react/no-complicated-conditional-rendering": "error",
-    "react/no-component-will-mount": "error",
-    "react/no-component-will-receive-props": "error",
-    "react/no-component-will-update": "error",
-    "react/no-create-ref": "error",
-    "react/no-default-props": "error",
-    "react/no-direct-mutation-state": "error",
-    "react/no-duplicate-key": "error",
-    "react/no-implicit-key": "error",
-    "react/no-leaked-conditional-rendering": "error",
-    "react/no-missing-component-display-name": "error",
-    "react/no-missing-key": "error",
-    "react/no-nested-components": "error",
-    "react/no-prop-types": "error",
-    "react/no-redundant-should-component-update": "error",
-    "react/no-set-state-in-component-did-mount": "error",
-    "react/no-set-state-in-component-did-update": "error",
-    "react/no-set-state-in-component-will-update": "error",
-    "react/no-string-refs": "error",
-    "react/no-unsafe-component-will-mount": "error",
-    "react/no-unsafe-component-will-receive-props": "error",
-    "react/no-unsafe-component-will-update": "error",
-    "react/no-unstable-context-value": "error",
-    "react/no-unstable-default-props": "error",
-    "react/no-unused-class-component-members": "error",
-    "react/no-unused-state": "error",
-    "react/no-useless-fragment": "error",
-    "react/prefer-destructuring-assignment": "error",
-    "react/prefer-read-only-props": "error",
-    "react/prefer-shorthand-boolean": "error",
-    "react/prefer-shorthand-fragment": "error",
-    "react/web-api/no-leaked-event-listener": "error",
-    "react/web-api/no-leaked-interval": "error",
-    "react/web-api/no-leaked-timeout": "error",
+    ...reactRules,
   },
 });

package/config.solid.js

@@ -1,7 +1,9 @@
 import solid from "eslint-plugin-solid";
 import tseslint from "typescript-eslint";
 
-import { ignores, languageOptions } from "./eslint.config.js";
+import { languageOptions } from "./eslint.config.js";
+import { ignores } from "./constants.js";
+import { solidRules } from "./setup/solid.js";
 
 export default tseslint.config({
   files: ["**/*.{jsx,tsx}"],
@@ -9,23 +11,6 @@ export default tseslint.config({
   languageOptions,
   plugins: { solid },
   rules: {
-    "solid/components-return-once": "error",
-    "solid/event-handlers": "error",
-    "solid/imports": "error",
-    "solid/jsx-no-duplicate-props": "error",
-    "solid/jsx-no-script-url": "error",
-    "solid/jsx-no-undef": "error",
-    "solid/jsx-uses-vars": "error",
-    "solid/no-array-handlers": "error",
-    "solid/no-destructure": "error",
-    "solid/no-innerhtml": "error",
-    "solid/no-react-deps": "error",
-    "solid/no-react-specific-props": "error",
-    "solid/no-unknown-namespaces": "error",
-    "solid/prefer-for": "error",
-    "solid/prefer-show": "error",
-    "solid/reactivity": "error",
-    "solid/self-closing-comp": "error",
-    "solid/style-prop": "error",
+    ...solidRules,
   },
 });

package/constants.js

@@ -0,0 +1 @@
+export const ignores = ["eslint.config.js", "node_modules", "dist"];