@resolid/config 2.1.2 → 3.0.1

package/README.md

@@ -1,20 +1,18 @@
 # @resolid/config
 
-Resolid 通用配置, 包含了 `TypeScript`, `Biome` 的基础配置
+Resolid 通用配置, 包含了 `TypeScript`, `Eslint` 和 `Prettier` 的基础配置
 
-## 使用方法
-
-### 安装
+## 安装
 
 ```bash
 pnpm add -D @resolid/config
 ```
 
-### TypeScript 配置
+## TypeScript 配置
 
 增加下面内容到 `tsconfig.json`
 
-#### 普通项目
+### 普通项目
 
 ```json
 {
@@ -22,7 +20,7 @@ pnpm add -D @resolid/config
 }
 ```
 
-#### React 项目
+### React 项目
 
 ```json
 {
@@ -30,38 +28,65 @@ pnpm add -D @resolid/config
 }
 ```
 
-### Biome 配置
+## ESLint 配置
 
-#### 普通配置
+本配置包是纯 ESM 包, 并使用了 ESLint 扁平配置, 需要使用 `eslint.config.js` 文件来进行配置
 
-```json
-{
-  "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
-  "extends": ["@resolid/config/biome"]
-}
+语言选项默认为 `ecmaVersion: 2022`, `sourceType: 'module'`
+
+### 基本 Lint 配置
+
+```js
+// eslint.config.js
+import eslintBase from "@resolid/config/eslint.base";
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+export default [...eslintBase];
 ```
 
-#### React 项目
+### TypeScript Lint 配置
 
-```json
-{
-  "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
-  "extends": [
-    "@resolid/config/biome",
-    "@resolid/config/biome.react"
-  ]
-}
+```js
+// eslint.config.js
+import eslintTypescript from "@resolid/config/eslint.typescript";
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+export default [...eslintTypescript];
 ```
 
-#### TailwindCSS 项目
+### React Lint 配置
 
-```json
-{
-  "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
-  "extends": [
-    "@resolid/config/biome",
-    "@resolid/config/biome.tailwind"
-  ]
-}
+```js
+// eslint.config.js
+import eslintReact from "@resolid/config/eslint.react";
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+export default [...eslintReact];
+```
+
+### ESLint 环境设置
+
+```js
+// eslint.config.js
+
+// 浏览器环境
+import eslintBowser from "@resolid/config/eslint.bowser";
+
+// Node 环境
+import eslintNode from "@resolid/config/eslint.node";
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+export default [...eslintBowser, ...eslintNode];
 ```
 
+### ESLint 配置查看
+
+你可以进入拥有 `eslint.config.js` 文件的目录运行下面的命令来检查
+
+```bash
+npx @eslint/config-inspector@latest
+ ```
+ 
+ ## 致谢
+
+- [ESLint Config Inspector](https://github.com/eslint/config-inspector) 用于检查和理解 ESLint 平面配置的可视化工具。

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@resolid/config",
-  "version": "2.1.2",
+  "version": "3.0.1",
   "type": "module",
   "sideEffects": false,
   "description": "Resolid 通用配置",
@@ -8,7 +8,8 @@
   "license": "MIT",
   "keywords": [
     "resolid",
-    "biome",
+    "eslint",
+    "prettier",
     "typescript"
   ],
   "publishConfig": {
@@ -16,24 +17,38 @@
     "provenance": true
   },
   "files": [
-    "config"
+    "src",
+    "tsconfig"
   ],
   "exports": {
-    "./tsconfig.base": "./config/tsconfig.base.json",
-    "./tsconfig.react": "./config/tsconfig.react.json",
-    "./biome": "./config/biome.json",
-    "./biome.react": "./config/biome.react.json",
-    "./biome.tailwind": "./config/biome.tailwind.json"
+    "./*": "./src/*.js",
+    "./tsconfig.base": "./tsconfig/base.json",
+    "./tsconfig.react": "./tsconfig/react.json"
+  },
+  "dependencies": {
+    "@eslint/js": "^9.17.0",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-n": "^17.15.0",
+    "eslint-plugin-react": "^7.37.2",
+    "eslint-plugin-react-compiler": "beta",
+    "eslint-plugin-react-hooks": "^5.1.0",
+    "eslint-plugin-react-refresh": "^0.4.16",
+    "globals": "^15.14.0",
+    "prettier-plugin-organize-imports": "^4.1.0",
+    "typescript-eslint": "^8.18.1"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
-    "@biomejs/biome": "^1.9.4",
     "@changesets/changelog-github": "^0.5.0",
-    "@changesets/cli": "^2.27.10",
-    "@commitlint/cli": "^19.6.0",
+    "@changesets/cli": "^2.27.11",
+    "@commitlint/cli": "^19.6.1",
     "@commitlint/config-conventional": "^19.6.0",
-    "lefthook": "^1.9.0",
-    "typescript": "^5.7.2"
+    "lefthook": "^1.9.3",
+    "prettier": "^3.4.2"
+  },
+  "peerDependencies": {
+    "eslint": "^9.16.0",
+    "prettier": "^3.4.2"
   },
   "engines": {
     "node": ">=20.0.0"
@@ -45,7 +60,8 @@
   },
   "scripts": {
     "preinstall": "npx only-allow pnpm",
-    "check": "biome check --write .",
-    "check-exports": "attw --pack ."
+    "check-exports": "attw --pack . --no-definitely-typed --profile esm-only",
+    "lint": "eslint .",
+    "format": "prettier --write ."
   }
 }

package/src/eslint.base.js

@@ -0,0 +1,39 @@
+import js from "@eslint/js";
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+export default [
+  {
+    ignores: [
+      "**/node_modules",
+      "**/build",
+      "**/dist",
+      "**/package-lock.json",
+      "**/pnpm-lock.yaml",
+      "**/.vercel",
+      "**/.changeset",
+      "**/.idea",
+      "**/.cache",
+      "**/.output",
+      "**/.resolid",
+      "**/.vite-inspect",
+      "**/*.min.*",
+      "**/LICENSE*",
+    ],
+  },
+  {
+    languageOptions: {
+      ecmaVersion: 2022,
+      sourceType: "module",
+      parserOptions: {
+        ecmaVersion: 2022,
+        sourceType: "module",
+      },
+    },
+    linterOptions: {
+      reportUnusedDisableDirectives: true,
+    },
+    rules: {
+      ...js.configs.recommended.rules,
+    },
+  },
+];

package/src/eslint.browser.js

@@ -0,0 +1,12 @@
+import globals from "globals";
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+export default [
+  {
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+      },
+    },
+  },
+];

package/src/eslint.node.js

@@ -0,0 +1,24 @@
+import n from "eslint-plugin-n";
+import globals from "globals";
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+export default [
+  {
+    plugins: { n },
+    rules: {
+      "n/handle-callback-err": ["error", "^(err|error)$"],
+      "n/no-deprecated-api": "error",
+      "n/no-exports-assign": "error",
+      "n/no-new-require": "error",
+      "n/no-path-concat": "error",
+      "n/prefer-global/buffer": ["error", "never"],
+      "n/prefer-global/process": ["error", "never"],
+      "n/process-exit-as-throw": "error",
+    },
+    languageOptions: {
+      globals: {
+        ...globals.node,
+      },
+    },
+  },
+];

package/src/eslint.react.js

@@ -0,0 +1,77 @@
+import jsxA11y from "eslint-plugin-jsx-a11y";
+import react from "eslint-plugin-react";
+import reactCompiler from "eslint-plugin-react-compiler";
+import reactHooks from "eslint-plugin-react-hooks";
+import reactRefresh from "eslint-plugin-react-refresh";
+import eslintTypescript from "./eslint.typescript.js";
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+export default [
+  ...eslintTypescript,
+  {
+    files: ["**/*.{jsx,tsx}"],
+    plugins: {
+      react: react,
+      "react-refresh": reactRefresh,
+    },
+    rules: {
+      ...react.configs.recommended.rules,
+      ...react.configs["jsx-runtime"].rules,
+      "react/prop-types": "off",
+      "react-refresh/only-export-components": [
+        "warn",
+        {
+          allowConstantExport: true,
+          allowExportNames: [
+            "clientAction",
+            "clientLoader",
+            "ErrorBoundary",
+            "handle",
+            "HydrateFallback",
+            "Layout",
+            "links",
+            "meta",
+            "loader",
+            "action",
+            "shouldRevalidate",
+          ],
+        },
+      ],
+    },
+    languageOptions: {
+      parserOptions: {
+        ecmaVersion: 2022,
+        sourceType: "module",
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+    },
+    settings: {
+      react: {
+        version: "detect",
+      },
+    },
+  },
+  {
+    files: ["**/*.{js,jsx,ts,tsx}"],
+    plugins: {
+      "react-hooks": reactHooks,
+      "react-compiler": reactCompiler,
+    },
+    rules: {
+      ...reactHooks.configs.recommended.rules,
+      "react-hooks/exhaustive-deps": [
+        "warn",
+        {
+          additionalHooks: "(useIsomorphicEffect)",
+        },
+      ],
+      "react-compiler/react-compiler": "warn",
+    },
+  },
+  {
+    files: ["**/*.{jsx,tsx}"],
+    ...jsxA11y.flatConfigs.recommended,
+  },
+];

package/src/eslint.typescript.js

@@ -0,0 +1,13 @@
+import typescript from "typescript-eslint";
+import eslintBase from "./eslint.base.js";
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+export default typescript.config(...eslintBase, ...typescript.configs.recommended, {
+  rules: {
+    "@typescript-eslint/no-import-type-side-effects": "error",
+    "@typescript-eslint/method-signature-style": ["error", "property"],
+    "@typescript-eslint/prefer-function-type": "error",
+    "@typescript-eslint/prefer-for-of": "error",
+    "@typescript-eslint/consistent-type-imports": "error",
+  },
+});

package/src/prettier.js

@@ -0,0 +1,8 @@
+/**
+ * @type {import("prettier").Config}
+ */
+const config = {
+  plugins: ["prettier-plugin-organize-imports"],
+};
+
+export default config;

package/{config/tsconfig.base.json → tsconfig/base.json}

@@ -1,7 +1,6 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
   "compilerOptions": {
-    /* Base Options: */
     "esModuleInterop": true,
     "skipLibCheck": true,
     "target": "es2022",
@@ -10,17 +9,11 @@
     "moduleDetection": "force",
     "isolatedModules": true,
     "verbatimModuleSyntax": true,
-
-    /* Strictness */
     "strict": true,
     "noFallthroughCasesInSwitch": true,
     "noImplicitOverride": true,
-
-    /* If NOT transpiling with TypeScript: */
     "module": "preserve",
     "noEmit": true,
-
-    /* If your code runs in the DOM: */
     "lib": ["es2022", "dom", "dom.iterable"]
   }
 }

package/tsconfig/react.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "./base.json",
+  "compilerOptions": {
+    "jsx": "react-jsx"
+  }
+}

package/config/biome.json

@@ -1,37 +0,0 @@
-{
-  "files": {
-    "ignore": ["tsconfig.*.json"]
-  },
-  "vcs": {
-    "enabled": true,
-    "clientKind": "git",
-    "defaultBranch": "main"
-  },
-  "organizeImports": {
-    "enabled": true
-  },
-  "formatter": {
-    "enabled": true,
-    "indentStyle": "space",
-    "indentWidth": 2,
-    "lineEnding": "lf",
-    "lineWidth": 120
-  },
-  "linter": {
-    "enabled": true,
-    "rules": {
-      "recommended": true,
-      "style": {
-        "noNonNullAssertion": "off"
-      },
-      "suspicious": {
-        "noDoubleEquals": "off"
-      },
-      "a11y": {
-        "noSvgWithoutTitle": "off",
-        "useSemanticElements": "off",
-        "noLabelWithoutControl": "off"
-      }
-    }
-  }
-}

package/config/biome.react.json

@@ -1,21 +0,0 @@
-{
-  "linter": {
-    "rules": {
-      "correctness": {
-        "useExhaustiveDependencies": {
-          "level": "error",
-          "options": {
-            "hooks": [
-              {
-                "name": "useIsomorphicEffect",
-                "closureIndex": 0,
-                "dependenciesIndex": 1,
-                "stableResult": true
-              }
-            ]
-          }
-        }
-      }
-    }
-  }
-}

package/config/biome.tailwind.json

@@ -1,15 +0,0 @@
-{
-  "linter": {
-    "rules": {
-      "nursery": {
-        "useSortedClasses": {
-          "level": "error",
-          "options": {
-            "attributes": ["textClassName", "statusClassName"],
-            "functions": ["clsx", "classed"]
-          }
-        }
-      }
-    }
-  }
-}

package/config/tsconfig.react.json

@@ -1,6 +0,0 @@
-{
-  "extends": "./tsconfig.base.json",
-  "compilerOptions": {
-    "jsx": "react-jsx"
-  }
-}