@lincy/eslint-config 3.0.11 → 3.2.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,47 +99,98 @@ 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依赖
+    // 是否启用 yaml 规则
+    yaml: 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
+    {
+        files: ['**/*.ts'],
         rules: {},
     },
 )
@@ -154,36 +205,34 @@ import {
     ignores,
     imports,
     javascript,
-    javascriptStylistic,
     jsdoc,
     jsonc,
     markdown,
     node,
     sortPackageJson,
     sortTsconfig,
+    stylistic,
     typescript,
-    typescriptStylistic,
     unicorn,
     vue,
-    yml,
+    yaml,
 } from '@lincy/eslint-config'
 
 export default [
-    ...ignores,
+    ...ignores(),
     ...javascript(),
-    ...comments,
-    ...node,
-    ...jsdoc,
-    ...imports,
-    ...unicorn,
-    ...javascriptStylistic,
+    ...comments(),
+    ...node(),
+    ...jsdoc(),
+    ...imports(),
+    ...unicorn(),
 
     ...typescript(),
-    ...typescriptStylistic,
+    ...stylistic(),
 
     ...vue(),
-    ...jsonc,
-    ...yml,
+    ...jsonc(),
+    ...yaml(),
     ...markdown(),
 ]
 ```
@@ -196,13 +245,13 @@ export default [
 
 由于平面配置支持显式提供了插件名称，因此我们重命名了一些插件以使它们更加一致并隐藏实现细节。
 
-| Original Prefix | New Prefix | Source Plugin |
-| --------------- | ---------- | ------------- |
-| `i/*` | `import/*` | [eslint-plugin-i](https://github.com/un-es/eslint-plugin-i) |
-| `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) |
+| New Prefix | Original Prefix | Source Plugin |
+| --- | --- | --- |
+| `import/*` | `i/*` | [eslint-plugin-i](https://github.com/un-es/eslint-plugin-i) |
+| `node/*` | `n/*` | [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n) |
+| `yaml/*` | `yml/*` | [eslint-plugin-yml](https://github.com/ota-meshi/eslint-plugin-yml) |
+| `ts/*` | `@typescript-eslint/*` | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) |
+| `style/*` | `@stylistic/*` | [@stylistic/eslint-plugin](https://github.com/eslint-stylistic/eslint-stylistic) |
 
 当您想要覆盖规则或内联禁用它们时，您需要更新到新的前缀：
 
@@ -212,15 +261,69 @@ export default [
 type foo = { bar: 2 }
 ```
 
+### Rules Overrides
+
+某些规则仅在特定文件中启用，例如，“ts/*”规则仅在“.ts”文件中启用，“vue/*”规则仅在“.vue”文件中启用。 如果要覆盖规则，则需要指定文件扩展名：
+
+```js
+// eslint.config.js
+import antfu from '@antfu/eslint-config'
+
+export default antfu(
+    { vue: true, typescript: true },
+    {
+        // 记得在这里指定文件 glob，否则可能会导致 vue 插件处理非 vue 文件
+        files: ['**/*.vue'],
+        rules: {
+            'vue/operator-linebreak': ['error', 'before'],
+        },
+    },
+    {
+        // 如果没有 `files`，它们是所有文件的通用规则
+        rules: {
+            'style/semi': ['error', 'never'],
+        },
+    }
+)
+```
+
+还可以使用“overrides”选项以使其更容易：
+
+```js
+// eslint.config.js
+import antfu from '@antfu/eslint-config'
+
+export default antfu({
+    overrides: {
+        vue: {
+            'vue/operator-linebreak': ['error', 'before'],
+        },
+        typescript: {
+            'ts/consistent-type-definitions': ['error', 'interface'],
+        },
+        javascript: {},
+        stylistic: {
+            'antfu/consistent-list-newline': 'off',
+        },
+        yaml: {},
+        ignores: [
+            '**/assets',
+            '**/static',
+        ]
+    // ...
+    }
+})
+```
+
 ### Type Aware Rules
 
 您可以选择通过将选项对象传递给“typescript”配置来启用[类型感知规则](https://typescript-eslint.io/linting/typed-linting/)：
 
 ```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',
     },