@ethang/eslint-config 19.0.11 → 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

@@ -15,9 +15,13 @@ 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,
@@ -35,38 +39,94 @@ export const updateRules = () => {
     ...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",
   );
 };