@resolid/config 1.0.3 → 2.0.0

package/README.md

@@ -1,13 +1,13 @@
 # @resolid/config
 
-Resolid 通用配置, 包含了 `TypeScript`, `ESLint` 的基础配置
+Resolid 通用配置, 包含了 `TypeScript`, `Biome` 的基础配置
 
 ## 使用方法
 
 ### 安装
 
 ```bash
-pnpm add -D eslint @resolid/config
+pnpm add -D @resolid/config
 ```
 
 ### TypeScript 配置
@@ -30,55 +30,13 @@ pnpm add -D eslint @resolid/config
 }
 ```
 
-### ESLint 配置
+### Biome 配置
 
-本配置包是纯 ESM 包, 并使用了 ESLint 扁平配置, 需要使用 `eslint.config.js` 文件来进行配置
-
-语言选项默认为 `ecmaVersion: 2022`, `sourceType: 'module'`
-
-#### TypeScript Lint 配置
-
-```js
-// eslint.config.js
-import eslintTypescript from "@resolid/config/eslint.typescript";
-
-/** @type {import('eslint').Linter.FlatConfig[]} */
-export default [...eslintTypescript];
-```
-
-#### React Lint 配置
-
-```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-flat-config-viewer
+```json
+{
+  "$schema": "https://biomejs.dev/schemas/1.7.1/schema.json",
+  "extends": ["@resolid/config/biome"]
+}
 ```
 
-## 感谢
-
-- [eslint-flat-config-viewer](https://github.com/antfu/eslint-flat-config-viewer)
+## 致谢

package/biome.json

@@ -0,0 +1,36 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.7.3/schema.json",
+  "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"
+      }
+    }
+  }
+}

package/biome.react.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.7.3/schema.json",
+  "linter": {
+    "rules": {
+      "correctness": {
+        "useExhaustiveDependencies": {
+          "level": "error",
+          "options": {
+            "hooks": [
+              {
+                "name": "useIsomorphicEffect",
+                "closureIndex": 0,
+                "dependenciesIndex": 1,
+                "stableResult": true
+              }
+            ]
+          }
+        }
+      }
+    }
+  }
+}

package/biome.tailwind.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.7.3/schema.json",
+  "linter": {
+    "rules": {
+      "nursery": {
+        "useSortedClasses": {
+          "level": "error",
+          "options": {
+            "attributes": ["textClassName", "statusClassName"],
+            "functions": ["clsx", "classed"]
+          }
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@resolid/config",
-  "version": "1.0.3",
+  "version": "2.0.0",
   "type": "module",
   "sideEffects": false,
   "description": "Resolid 通用配置",
@@ -8,7 +8,7 @@
   "license": "MIT",
   "keywords": [
     "resolid",
-    "eslint",
+    "biome",
     "typescript"
   ],
   "publishConfig": {
@@ -16,44 +16,29 @@
     "provenance": true
   },
   "files": [
-    "src",
+    "biome.json",
+    "biome.react.json",
+    "biome.tailwind.json",
     "tsconfig.base.json",
     "tsconfig.react.json"
   ],
   "exports": {
     "./tsconfig.base": "./tsconfig.base.json",
     "./tsconfig.react": "./tsconfig.react.json",
-    "./*": "./src/*.js"
-  },
-  "dependencies": {
-    "@eslint/js": "^8.57.0",
-    "eslint-plugin-jsx-a11y": "^6.8.0",
-    "eslint-plugin-n": "^17.2.0",
-    "eslint-plugin-react": "^7.34.1",
-    "eslint-plugin-react-hooks": "^4.6.0",
-    "eslint-plugin-react-refresh": "^0.4.6",
-    "globals": "^15.0.0",
-    "typescript-eslint": "^7.6.0"
+    "./biome": "./biome.json",
+    "./biome.react": "./biome.react.json",
+    "./biome.tailwind": "./biome.tailwind.json"
   },
   "devDependencies": {
-    "eslint": "^8.57.0",
-    "typescript": "^5.4.5"
-  },
-  "peerDependencies": {
-    "eslint": "^8.57.0",
+    "@biomejs/biome": "^1.8.0",
     "typescript": "^5.4.5"
   },
-  "peerDependenciesMeta": {
-    "typescript": {
-      "optional": true
-    }
-  },
-  "homepage": "https://resolid.tech",
+  "homepage": "https://www.resolid.tech",
   "repository": {
     "type": "git",
     "url": "https://github.com/huijiewei/resolid-config.git"
   },
   "scripts": {
-    "lint": "eslint ."
+    "check": "biome check --write ."
   }
 }

package/tsconfig.base.json

@@ -9,15 +9,16 @@
     "resolveJsonModule": true,
     "moduleDetection": "force",
     "isolatedModules": true,
+    "verbatimModuleSyntax": true,
 
     /* Strictness */
     "strict": true,
     "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
 
     /* If NOT transpiling with TypeScript: */
     "module": "preserve",
     "noEmit": true,
-    "verbatimModuleSyntax": true,
 
     /* If your code runs in the DOM: */
     "lib": ["es2022", "dom", "dom.iterable"]

package/src/eslint.base.js

@@ -1,41 +0,0 @@
-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,
-      "no-extra-semi": "off",
-      "no-mixed-spaces-and-tabs": "off",
-    },
-  },
-];

package/src/eslint.bowser.js

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

package/src/eslint.node.js

@@ -1,24 +0,0 @@
-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

@@ -1,74 +0,0 @@
-import jsxA11y from "eslint-plugin-jsx-a11y";
-import react from "eslint-plugin-react";
-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: ["meta", "links", "loader", "action", "Layout", "HydrateFallback", "ErrorBoundary"],
-        },
-      ],
-    },
-    languageOptions: {
-      parserOptions: {
-        ecmaVersion: 2022,
-        sourceType: "module",
-        ecmaFeatures: {
-          jsx: true,
-        },
-      },
-    },
-    settings: {
-      react: {
-        version: "detect",
-      },
-    },
-  },
-  {
-    files: ["**/*.{js,jsx,ts,tsx}"],
-    plugins: {
-      "react-hooks": reactHooks,
-    },
-    rules: {
-      ...reactHooks.configs.recommended.rules,
-      "react-hooks/exhaustive-deps": [
-        "warn",
-        {
-          additionalHooks: "(useIsomorphicEffect)",
-        },
-      ],
-    },
-  },
-  {
-    files: ["**/*.{jsx,tsx}"],
-    plugins: {
-      "jsx-a11y": jsxA11y,
-    },
-    rules: {
-      ...jsxA11y.configs.recommended.rules,
-    },
-    languageOptions: {
-      parserOptions: {
-        ecmaFeatures: {
-          jsx: true,
-        },
-      },
-    },
-  },
-];

package/src/eslint.typescript.js

@@ -1,10 +0,0 @@
-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"],
-  },
-});