@lincy/eslint-config 3.0.10 → 3.1.0

package/README.md

@@ -24,9 +24,9 @@ pnpm add -D eslint @lincy/eslint-config
 
 ```js
 // eslint.config.js
-import eslintConfig from '@lincy/eslint-config'
+import lincy from '@lincy/eslint-config'
 
-export default eslintConfig()
+export default lincy()
 ```
 
 > 通常您不需要`.eslintignore`，因为它已由预设提供。
@@ -99,46 +99,96 @@ For example:
 
 ## 定制化
 
-通常你只需要导入 `eslintConfig` 预设：
+通常你只需要导入 `lincy` 预设：
 
+#### esm
 ```js
 // eslint.config.js
-import eslintConfig from '@lincy/eslint-config'
+import lincy from '@lincy/eslint-config'
 
-export default eslintConfig()
+// or
+// import { lincy } from '@lincy/eslint-config'
+
+export default lincy()
+```
+
+#### cjs
+```js
+// eslint.config.js
+const lincy = require('@lincy/eslint-config').lincy
+
+module.exports = lincy()
 ```
 
 您可以单独配置每个功能，例如：
 
 ```js
 // eslint.config.js
-import eslintConfig from '@lincy/eslint-config'
-
-export default eslintConfig({
-    stylistic: true, // enable stylistic formatting rules
-    typescript: true,
-    vue: true,
-    jsonc: false,
-    yml: false,
+import lincy from '@lincy/eslint-config'
+
+export default lincy({
+    // 是否启用 stylistic 格式化规则
+    stylistic: true, // 默认值: true
+    // 是否启用 typescript 规则
+    typescript: true, // 默认值: 检测是否安装typescript依赖
+    // 是否启用 vue 规则
+    vue: true, // 默认值: 检测是否安装vue依赖
+    // 是否启用 jsonc 规则
+    jsonc: false, // 默认值: 检测是否安装typescript依赖
+    // 是否启用 yml 规则
+    yml: false, // 默认值: true
+    // 是否启用 .gitignore 文件
+    gitignore: false, // 默认值: true
+    // 是否启用 test 规则
+    test: false, // 默认值: true
+    // 是否启用 markdown 规则
+    markdown: false, // 默认值: true
 })
 ```
 
-`eslintConfig` 工厂函数还接受任意数量的自定义配置覆盖：
+`lincy` 工厂函数还接受任意数量的自定义配置覆盖：
 
 ```js
 // eslint.config.js
-import eslintConfig from '@lincy/eslint-config'
+import { readFile } from 'node:fs/promises'
+import lincy from '@lincy/eslint-config'
+import plugin from '@unocss/eslint-plugin'
+
+const autoImport = JSON.parse(
+    await readFile(new URL('./.eslintrc-auto-import.json', import.meta.url)),
+)
 
-export default eslintConfig(
+export default lincy(
     {
     // Configures for config
     },
-
-    // From the second arguments they are ESLint Flat Configs
-    // you can have multiple configs
+    // 启用 unocss
     {
-        rules: {},
+        plugins: {
+            '@unocss': plugin,
+        },
+        rules: {
+            ...plugin.configs.recommended.rules,
+            '@unocss/order': 'off',
+        },
+    },
+    // 启用 auto-import 生成的 .eslintrc-auto-import.json
+    {
+        languageOptions: {
+            globals: {
+                ...autoImport.globals,
+                // 其他 globals
+            },
+        },
+    },
+    // 自定义排除文件(夹)
+    {
+        ignores: [
+            '**/assets',
+            '**/static',
+        ],
     },
+    // 你还可以继续配置多个 ESLint Flat Configs
     {
         rules: {},
     },
@@ -202,7 +252,6 @@ export default [
 | `n/*` | `node` | [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n)
 | `@typescript-eslint/*` | `ts/*` | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) |
 | `@stylistic/js` | `style/*` | [@stylistic/eslint-plugin-js](https://github.com/eslint-stylistic/eslint-stylistic) |
-| `@stylistic/ts` | `style-ts/` | [@stylistic/eslint-plugin-ts](https://github.com/eslint-stylistic/eslint-stylistic) |
 
 当您想要覆盖规则或内联禁用它们时，您需要更新到新的前缀：
 
@@ -218,9 +267,9 @@ type foo = { bar: 2 }
 
 ```js
 // eslint.config.js
-import eslintConfig from '@lincy/eslint-config'
+import lincy from '@lincy/eslint-config'
 
-export default eslintConfig({
+export default lincy({
     typescript: {
         tsconfigPath: 'tsconfig.json',
     },