@lincy/eslint-config 4.0.2 → 4.1.0

package/README.md

@@ -46,9 +46,9 @@ For example:
 }
 ```
 
-## VS Code support (auto fix)
+## VS Code support (自动修复)
 
-安装[VS Code ESLint扩展](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+安装 [VS Code ESLint扩展](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
 
 将以下设置添加到您的“settings.json”：
 
@@ -130,47 +130,75 @@ module.exports = lincy()
 import lincy from '@lincy/eslint-config'
 
 export default lincy({
-    // 是否启用 stylistic 格式化规则
-    // 默认值: true
-    // 可选: false | { indent: number | 'tab', quotes: 'single' | 'double', jsx: boolean}
+    /**
+     * 是否启用 stylistic 格式化规则
+     * @default 默认值: true
+     * @example 可选: false | { indent?: number | 'tab'; quotes?: 'single' | 'double'; jsx?: boolean; files?: string[]}
+     */
     stylistic: true,
-    // 是否启用 typescript 规则
-    // 默认值: 检测是否安装typescript依赖,
-    // 可选: false | true | { parserOptions: {} }
+    /**
+     * 是否启用 typescript 规则
+     * @default 默认值: 检测是否安装typescript依赖,
+     * @example 可选: false | true | { parserOptions: {}; files?: string[] }
+     */
     typescript: true,
-    // 是否启用 vue 规则
-    // 默认值: 检测是否安装vue依赖,
-    // 可选: false | true
+    /**
+     * 是否启用 vue 规则
+     * @default 默认值: 检测是否安装vue依赖,
+     * @example 可选: false | true | { files?: string[] }
+     */
     vue: true,
-    // 是否启用 jsx 规则
-    // 默认值: true,
-    // 可选: false
+    /**
+     * 是否启用 jsx 规则
+     * @default 默认值: true,
+     * @example 可选: false
+     */
     jsx: true,
-    // 是否启用 react 规则
-    // 默认值: 检测是否安装react依赖,
-    // 可选: false | true | { jsx: boolean, version: string }
+    /**
+     * 是否启用 react 规则
+     * @default 默认值: 检测是否安装react依赖,
+     * @example 可选: false | true | { jsx?: boolean; version?: string; files?: string[] }
+     */
     react: true,
-    // 是否启用 jsonc 规则
-    // 默认值: true,
-    // 可选: false
+    /**
+     * 是否启用 unocss 规则
+     * @default 默认值: false,
+     * @example 可选: true | { attributify?: boolean; strict?: boolean }
+     */
+    unocss: true,
+    /**
+     * 是否启用 jsonc 规则
+     * @default 默认值: true,
+     * @example 可选: false | { files?: string[] }
+     */
     jsonc: false,
-    // 是否启用 yaml 规则
-    // 默认值: true,
-    // 可选: false
+    /**
+     * 是否启用 yaml 规则
+     * @default 默认值: true,
+     * @example 可选: false | { files?: string[] }
+     */
     yaml: false,
-    // 是否启用 .gitignore 文件
-    // 默认值: true,
-    // 可选: false | { ignores: string[] }
+    /**
+     * 是否启用 .gitignore 文件
+     * @default 默认值: true,
+     * @example 可选: false | { ignores?: string[] }
+     */
     gitignore: false,
-    // 是否启用 test 规则
-    // 默认值: true,
-    // 可选: false
+    /**
+     * 是否启用 test 规则
+     * @default 默认值: true,
+     * @example 可选: false | { files?: string[] }
+     */
     test: false,
-    // 是否启用 markdown 规则
-    // 默认值: true,
-    // 可选: false
+    /**
+     * 是否启用 markdown 规则
+     * @default 默认值: true,
+     * @example 可选: false | { files?: string[] }
+     */
     markdown: false,
-    // 覆盖规则
+    /**
+     * 覆盖规则
+     */
     overrides: {},
 
     // 工厂函数第一个参数默认为各规则的开关, 但是也可以作为追加规则使用, 当包含以下键名将会自动整合到一个规则里
@@ -185,7 +213,8 @@ export default lincy({
 })
 ```
 
-`lincy` 工厂函数还接受任意数量的自定义配置覆盖：
+`lincy` 工厂函数还接受任意数量的自定义配置覆盖
+下面示例为添加`auto-import`生成的全局方法
 
 ```js
 // eslint.config.js
@@ -200,16 +229,8 @@ const autoImport = JSON.parse(
 export default lincy(
     {
         // 配置, 参考上一个代码块
-    },
-    // 启用 unocss
-    {
-        plugins: {
-            '@unocss': plugin,
-        },
-        rules: {
-            ...plugin.configs.recommended.rules,
-            '@unocss/order': 'off',
-        },
+        // 启用 unocss
+        unocss: true
     },
     // 启用 auto-import 生成的 .eslintrc-auto-import.json
     {
@@ -251,6 +272,7 @@ import {
     stylistic,
     typescript,
     unicorn,
+    unocss,
     vue,
     yaml,
 } from '@lincy/eslint-config'
@@ -268,6 +290,7 @@ export default combine(
     stylistic(/* Options */),
     vue(),
     react(/* Options */),
+    unocss(/* Options */),
     jsonc(),
     yaml(),
     markdown(),
@@ -382,6 +405,40 @@ export default lincy({
 })
 ```
 
+### 可选配置
+
+提供了一些可选配置，默认情况下不包含它们的依赖项
+
+#### React
+
+当检测到依赖安装了`react`, 则默认开启
+
+运行“npx eslint”会提示您安装所需的依赖项，当然，您也可以手动安装它们：
+
+```bash
+pnpm i -D eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-react-refresh
+```
+
+#### UnoCSS
+
+要启用 UnoCSS 支持，需要显式打开它
+
+```js
+// eslint.config.js
+import lincy from '@lincy/eslint-config'
+
+export default lincy({
+    unocss: true,
+})
+```
+
+运行“npx eslint”会提示您安装所需的依赖项，当然，您也可以手动安装它们：
+
+```bash
+pnpm i -D @unocss/eslint-plugin
+```
+
+
 #### `perfectionist` (sorting)
 
 这个插件 [`eslint-plugin-perfectionist`](https://github.com/azat-io/eslint-plugin-perfectionist) 允许你排序对象键名，导入，自动修复等。