eslint-config-gorgon 1.2.7 → 2.0.0

package/README.md

@@ -1,3 +1,6 @@
+> [!IMPORTANT]  
+> This package is not ready yet.
+
 ### Why
 
 this package include prettier and eslint in one extends.
@@ -7,28 +10,33 @@ you can eazy use it.
 ### Install
 
 ```zsh
-pnpm i -D eslint-config-grogon
+pnpm i -D eslint-config-gorgon
 ```
 
 ### Start
 
-in your eslintrc file
+in your eslint config file
 
-`.eslintrc`
+`.eslint.config.mjs`
 
-```json
-{
-  "extends": ["gorgon"]
-}
+```js
+import gorgon from 'eslint-config-gorgon';
+export default gorgon;
+// or
+import { init } from 'eslint-config-gorgon';
+export default init();
 ```
 
+### VsCode Setting (Optional)
 `./vscode/settings.json`
 
 ```json
 {
-  "editor.formatOnSave": true, // use prettier
+  "prettier.enable": false,
+  "editor.formatOnSave": false,
   "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true // use eslint
+    "source.fixAll.eslint": "explicit",
+    "source.organizeImports": "never"
   }
 }
 ```
@@ -36,12 +44,8 @@ in your eslintrc file
 `./vscode/extensions.json`
 
 ```json
-
 {
-  "recommendations": [
-    "dbaeumer.vscode-eslint",
-    "rvest.vs-code-prettier-eslint"
-  ]
+  "recommendations": ["dbaeumer.vscode-eslint"]
 }
 ```
 
@@ -49,11 +53,11 @@ in your eslintrc file
 
 [using-a-shareable-configuration-package](https://eslint.org/docs/latest/use/configure/configuration-files#using-a-shareable-configuration-package)
 
-### Desc
+<!-- ### Desc
 
 > just collect recommended eslint, no more custom rules.
 
 - eslint
 - typescript
 - react
-- prettier
+- prettier -->

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "eslint-config-gorgon",
-  "version": "1.2.7",
+  "version": "2.0.0",
+  "type": "module",
   "main": "src/index.js",
   "license": "MIT",
   "keywords": [
@@ -11,20 +12,33 @@
     "src/*"
   ],
   "dependencies": {
-    "@typescript-eslint/eslint-plugin": "^7.3.1",
-    "@typescript-eslint/parser": "^7.3.1",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-import": "^2.30.0",
     "eslint-plugin-jsx-a11y": "^6.9.0",
-    "eslint-plugin-perfectionist": "^3.1.3",
+    "eslint-plugin-perfectionist": "^3.3.0",
     "eslint-plugin-prettier": "^5.2.1",
-    "eslint-plugin-react": "^7.35.0",
+    "eslint-plugin-react": "^7.35.1",
     "eslint-plugin-react-hooks": "^4.6.2",
-    "eslint-plugin-tailwindcss": "^3.17.4"
+    "eslint-plugin-tailwindcss": "^3.17.4",
+    "fast-glob": "^3.3.2",
+    "ignore": "^5.3.2",
+    "prettier": "^3.3.3",
+    "typescript-eslint": "^8.4.0"
   },
   "devDependencies": {
-    "eslint": "^8.57.0",
-    "prettier": "^3.3.3",
+    "@eslint/js": "^9.9.1",
+    "@types/eslint-config-prettier": "^6.11.3",
+    "@types/eslint-plugin-jsx-a11y": "^6.9.0",
+    "@types/eslint-plugin-tailwindcss": "^3.17.0",
+    "@types/eslint__js": "^8.42.3",
+    "@types/node": "^22.5.2",
+    "eslint": "^9.9.1",
+    "tsup": "^8.2.4",
     "typescript": "^5.5.4"
+  },
+  "scripts": {
+    "lint": "npx eslint",
+    "build": "tsup",
+    "build:watch": "tsup --watch",
+    "dev": "npm run build && npm run lint"
   }
 }

package/src/configs/base.ts

@@ -0,0 +1,12 @@
+import perfectionist from "eslint-plugin-perfectionist";
+
+export default [
+  perfectionist.configs["recommended-natural"],
+  {
+    rules: {
+      "no-console": "warn", // handle console
+      "no-unused-vars": "warn", // unused
+      "perfectionist/sort-enums": "warn", // sort enums
+    },
+  },
+];

package/src/configs/import.ts

@@ -0,0 +1,22 @@
+import importPlugin from "eslint-plugin-import";
+
+export default [
+  {
+    plugins: { import: importPlugin },
+    rules: {
+      "import/first": "error",
+      "import/newline-after-import": "error",
+      "import/no-duplicates": "error",
+    },
+    settings: {
+      // This will do the trick
+      "import/parsers": {
+        espree: [".js", ".cjs", ".mjs", ".jsx"],
+      },
+      "import/resolver": {
+        node: true,
+        typescript: true,
+      },
+    },
+  },
+];

package/src/configs/index.tsx

@@ -0,0 +1,6 @@
+export * from './base';
+export * from './import';
+export * from './jsx-a11y';
+export * from './prettier';
+export * from './tailwind';
+export * from './typescript';

package/src/configs/jsx-a11y.ts

@@ -0,0 +1,5 @@
+import jsxA11y from "eslint-plugin-jsx-a11y";
+
+export default [
+  jsxA11y.flatConfigs.recommended,
+];

package/src/configs/prettier.ts

@@ -0,0 +1,4 @@
+import eslintConfigPrettier from "eslint-config-prettier";
+import eslintPluginPrettierRecommended from "eslint-plugin-prettier/recommended";
+
+export default [eslintPluginPrettierRecommended, eslintConfigPrettier];

package/src/configs/tailwind.ts

@@ -0,0 +1,3 @@
+import tailwind from "eslint-plugin-tailwindcss";
+
+export default [...tailwind.configs["flat/recommended"]];

package/src/configs/typescript.ts

@@ -0,0 +1,7 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+
+import tseslint from "typescript-eslint";
+
+export default [
+  ...tseslint.configs.recommended,
+] as TSESLint.FlatConfig.ConfigArray;

package/src/constants.ts

@@ -0,0 +1,9 @@
+import checkHasReact from "./utils/check-react";
+import checkHasTailwindcss from "./utils/check-tailwindcss";
+import checkHasTypeScript from "./utils/check-typescript";
+
+const hasReact = checkHasReact();
+const hasTailwindcss = checkHasTailwindcss();
+const hasTypeScript = checkHasTypeScript();
+
+export { hasReact, hasTailwindcss, hasTypeScript };

package/src/index.ts

@@ -0,0 +1,52 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+import type eslint from "eslint";
+
+import tseslint from "typescript-eslint";
+
+import base from "./configs/base";
+import jsxA11y from "./configs/jsx-a11y";
+// import _import from "./configs/import";
+import prettier from "./configs/prettier";
+import tailwind from "./configs/tailwind";
+import { hasReact, hasTailwindcss, hasTypeScript } from "./constants";
+
+const initialConfigs: eslint.Linter.Config[] = [...base];
+
+type InitConfigProps = {
+  a11y?: boolean;
+  ignores?: string[];
+  prettier?: boolean;
+  react?: boolean;
+  tailwind?: boolean;
+  typescript?: boolean;
+};
+
+type InitConfigReturnType = eslint.Linter.Config | TSESLint.FlatConfig.Config;
+
+export const init = (configs?: InitConfigProps): InitConfigReturnType[] => {
+  let reasonConfigs: InitConfigReturnType[] = initialConfigs;
+  // 判断是否存在 a11y
+  if (configs?.a11y ?? hasReact) reasonConfigs.push(...jsxA11y);
+  // 判断是否存在 tailwindcss
+  if (configs?.tailwind ?? hasTailwindcss) reasonConfigs.push(...tailwind);
+  // 判断是否存在 prettier
+  if (configs?.prettier ?? hasReact) reasonConfigs.push(...prettier);
+  // 判断是否存在 typescript
+  if (configs?.typescript ?? hasTypeScript) {
+    const defaultIgnores = ["**/node_modules/**", "dist/**", "output/**"];
+    reasonConfigs = [...initialConfigs, ...tseslint.configs.recommended].map(
+      (config) => ({
+        ...config,
+        files: [
+          "**/*.ts",
+          "**/*.tsx",
+          ...(config?.files?.flat(Infinity) ?? []),
+        ],
+        ignores: [...defaultIgnores, ...(configs?.ignores ?? [])],
+      }),
+    );
+  }
+  return reasonConfigs;
+};
+
+export default initialConfigs;

package/src/rules/react.ts

@@ -0,0 +1,8 @@
+// /** @type {import('eslint').Linter.Config} */
+// export default {
+//   extends: ["plugin:react-hooks/recommended", "plugin:jsx-a11y/recommended"],
+//   plugins: ["react"],
+//   rules: {
+//     "react/self-closing-comp": "warn", // 要求没有子元素的组件使用自闭合标签
+//   },
+// };

package/src/types.d.ts

@@ -0,0 +1,5 @@
+declare module "eslint-plugin-import" {
+  const flatConfigs: {
+    recommended: import("eslint").Linter.Config;
+  };
+}

package/src/utils/check-react.ts

@@ -0,0 +1,17 @@
+import fs from "fs";
+import path from "path";
+
+const checkHasReact = () => {
+  const packageJsonPath = path.join(process.cwd(), "package.json");
+  if (fs.existsSync(packageJsonPath)) {
+    const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf-8"));
+    const dependencies = packageJson.dependencies || {};
+    const devDependencies = packageJson.devDependencies || {};
+    const isReactProject =
+      "react" in dependencies || "react" in devDependencies;
+    return isReactProject;
+  }
+  return false;
+};
+
+export default checkHasReact;

package/src/utils/check-tailwindcss.ts

@@ -0,0 +1,17 @@
+import fs from "fs";
+import path from "path";
+
+const checkHasTailwindcss = () => {
+  const possibleConfigFiles = [
+    "tailwind.config.js",
+    "tailwind.config.cjs",
+    "tailwind.config.mjs",
+    "tailwind.config.ts",
+    "tailwind.config.mts",
+  ];
+  const configFileExists = possibleConfigFiles.some((file) =>
+    fs.existsSync(path.join(process.cwd(), file)),
+  );
+  return configFileExists;
+};
+export default checkHasTailwindcss;

package/src/utils/check-typescript.ts

@@ -0,0 +1,8 @@
+import fs from "fs";
+import path from "path";
+
+const tsConfigPath = path.join(process.cwd(), "tsconfig.json");
+
+const checkHasTypeScript = () => fs.existsSync(tsConfigPath);
+
+export default checkHasTypeScript;

package/src/constants.js

@@ -1,13 +0,0 @@
-const checkHasTailwindcss = require("./utils/check-tailwindcss");
-const checkHasReact = require("./utils/check-react");
-const checkHasTypeScript = require("./utils/check-typescript");
-
-const hasReact = checkHasReact();
-const hasTailwindcss = checkHasTailwindcss();
-const hasTypeScript = checkHasTypeScript();
-
-module.exports = {
-    hasReact,
-    hasTailwindcss,
-    hasTypeScript,
-};

package/src/index.js

@@ -1,20 +0,0 @@
-const { hasReact, hasTailwindcss, hasTypeScript } = require("./constants");
-
-const baseExtendsList = [
-  "/rules/base.js",
-  "/rules/imports.js",
-  "/rules/prettier.js",
-];
-
-if (hasReact) baseExtendsList.push("/rules/react.js");
-if (hasTailwindcss) baseExtendsList.push("/rules/tailwind.js");
-if (hasTypeScript) baseExtendsList.push("/rules/typescript.js");
-
-const extendsList = baseExtendsList.map((item) => require.resolve(__dirname + item));
-
-/** @type {import('eslint').Linter.Config} */
-const config = {
-  extends: extendsList,
-};
-
-module.exports = config;

package/src/rules/base.js

@@ -1,14 +0,0 @@
-/** @type {import('eslint').Linter.Config} */
-const config = {
-  extends: [
-    'plugin:perfectionist/recommended-natural-legacy',
-    // "plugin:perfectionist/recommended-alphabetical", // sort by alphabetical
-  ],
-  plugins: ["perfectionist"],
-  rules: {
-    "no-console": "warn", // handle console
-    "perfectionist/sort-enums": "warn", // sort enums
-  },
-};
-
-module.exports = config;

package/src/rules/imports.js

@@ -1,11 +0,0 @@
-/** @type {import('eslint').Linter.Config} */
-const config = {
-  plugins: ["import"],
-  rules: {
-    // handle import
-    "import/first": "error",
-    "import/newline-after-import": "error",
-    "import/no-duplicates": "error",
-  },
-};
-module.exports = config;

package/src/rules/prettier.js

@@ -1,6 +0,0 @@
-/** @type {import('eslint').Linter.Config} */
-const config = {
-  extends: ["plugin:prettier/recommended"],
-};
-
-module.exports = config;

package/src/rules/react.js

@@ -1,13 +0,0 @@
-/** @type {import('eslint').Linter.Config} */
-const config = {
-  extends: [
-    "plugin:react-hooks/recommended",
-    "plugin:jsx-a11y/recommended",
-  ],
-  plugins: ["react"],
-  rules: {
-    "react/self-closing-comp": "warn", // 要求没有子元素的组件使用自闭合标签
-  },
-};
-
-module.exports = config;

package/src/rules/tailwind.js

@@ -1,6 +0,0 @@
-/** @type {import('eslint').Linter.Config} */
-const config = {
-  extends: ["plugin:tailwindcss/recommended"],
-};
-
-module.exports = config;

package/src/rules/typescript.js

@@ -1,12 +0,0 @@
-/** @type {import('eslint').Linter.Config} */
-const config = {
-  extends: ["plugin:@typescript-eslint/recommended"],
-  parser: "@typescript-eslint/parser",
-  plugins: ["@typescript-eslint"],
-  rules: {
-    "@typescript-eslint/no-explicit-any": "warn", // handle explicit any
-    "@typescript-eslint/no-shadow": "off", // handle shadow
-    "@typescript-eslint/no-unused-vars": "error", // handle unused
-  },
-};
-module.exports = config;

package/src/utils/check-react.js

@@ -1,16 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-
-const checkHasReact = () => {
-    const packageJsonPath = path.join(process.cwd(), 'package.json');
-    if (fs.existsSync(packageJsonPath)) {
-        const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8'));
-        const dependencies = packageJson.dependencies || {};
-        const devDependencies = packageJson.devDependencies || {};
-        const isReactProject = 'react' in dependencies || 'react' in devDependencies;
-        return isReactProject;
-    }
-    return false;
-}
-
-module.exports = checkHasReact;

package/src/utils/check-tailwindcss.js

@@ -1,17 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-
-const checkHasTailwindcss = () => {
-    const possibleConfigFiles = [
-        'tailwind.config.js',
-        'tailwind.config.cjs',
-        'tailwind.config.mjs',
-        'tailwind.config.ts',
-        'tailwind.config.mts',
-    ];
-    const configFileExists = possibleConfigFiles.some(file =>
-        fs.existsSync(path.join(process.cwd(), file))
-    );
-    return configFileExists;
-}
-module.exports = checkHasTailwindcss;

package/src/utils/check-typescript.js

@@ -1,8 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-
-const tsConfigPath = path.join(process.cwd(), 'tsconfig.json');
-
-const checkHasTypeScript = () => fs.existsSync(tsConfigPath);
-
-module.exports = checkHasTypeScript;