@lincy/eslint-config 5.2.7 → 5.3.1

package/README.md

@@ -4,15 +4,15 @@
 
 > Thanks to [sxzz/eslint-config](https://github.com/sxzz/eslint-config) and [antfu/eslint-config](https://github.com/antfu/eslint-config) for the inspiration and reference.
 
--   单引号，无结尾分号
--   自动格式化
--   专为与 TypeScript、Vue(2/3)、React 一起使用而设计，开箱即用
--   也适用于 json、yaml、markdown
--   import导入排序, 对象字⾯量项尾逗号
--   合理的默认值，最佳实践，只需一行配置
--   [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new)
--   使用 [ESLint Stylistic](https://github.com/eslint-stylistic/eslint-stylistic)
--   **风格原则**: 读取最小，差异稳定
+- 单引号，无结尾分号
+- 自动格式化
+- 专为与 TypeScript、Vue(2/3)、React 一起使用而设计，开箱即用
+- 也适用于 json、yaml、markdown
+- import导入排序, 对象字⾯量项尾逗号
+- 合理的默认值，最佳实践，只需一行配置
+- [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new)
+- 使用 [ESLint Stylistic](https://github.com/eslint-stylistic/eslint-stylistic)
+- **风格原则**: 读取最小，差异稳定
 
 ## Usage
 
@@ -44,7 +44,7 @@ export default lincy()
 }
 ```
 
-## VS Code support (保存时自动修复)
+### VS Code support (保存时自动修复)
 
 安装 [VS Code ESLint扩展](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
 
@@ -101,6 +101,16 @@ export default lincy()
 }
 ```
 
+### 使用.ts文件作为配置文件
+
+1. 将`eslint`更新至最新版本
+2. 在`package.json`中的`eslint .`后面添加参数`--flag unstable_ts_config`, 包括`scripts`、`lint-staged`中
+3. 在`.vscode/settings.json`文件添加`"eslint.options": {
+  "flags": [
+    "unstable_ts_config"
+  ]
+}`
+
 ## 定制化
 
 通常你只需要导入 `lincy` 预设：
@@ -140,19 +150,41 @@ export default lincy({
     /**
      * 是否启用 stylistic 格式化规则
      * @default 默认值: true
-     * @example 可选: false | { indent?: number | 'tab'; quotes?: 'single' | 'double'; jsx?: boolean; semi?: boolean; lessOpinionated?: boolean; }
+     * @example 可选: false |
+     * {
+     *   indent?: number | 'tab';
+     *   quotes?: 'single' | 'double';
+     *   jsx?: boolean;
+     *   semi?: boolean;
+     *   lessOpinionated?: boolean;
+     * }
      */
     stylistic: true,
     /**
      * 是否启用 typescript 规则
      * @default 默认值: 检测是否安装typescript依赖,
-     * @example 可选: false | true | { parserOptions: {}; files?: string[] }
+     * @example 可选: false | true |
+     * {
+     *   files?: string[], // 自定义 glob 覆盖 “files” 选项
+     *   componentExts: string[], // 组件的附加扩展
+     *   parserOptions: {};
+     *   filesTypeAware: string[],
+     *   ignoresTypeAware?: string[],
+     *   tsconfigPath?: string,
+     *   type: 'app' | 'lib'
+     * }
      */
     typescript: true,
     /**
      * 是否启用 vue 规则
      * @default 默认值: 检测是否安装vue依赖,
-     * @example 可选: false | true | { files?: string[]; sfcBlocks: boolean }
+     * @example 可选: false | true |
+     * {
+     *   files?: string[]; // 自定义 glob 覆盖 “files” 选项
+     *   stylistic: boolean; // 是否开启 stylistic
+     *   sfcBlocks: boolean; // 为 Vue SFC 创建虚拟文件以启用 linting
+     *   typescript: boolean; // 是否开启 typescript
+     * }
      */
     vue: true,
     /**
@@ -164,31 +196,53 @@ export default lincy({
     /**
      * 是否启用 react 规则
      * @default 默认值: 检测是否安装react依赖,
-     * @example 可选: false | true | { jsx?: boolean; version?: string; files?: string[] }
+     * @example 可选: false | true |
+     * {
+     *   files?: string[], // 自定义 glob 覆盖 “files” 选项
+     *   filesTypeAware?: string[], // 应该识别类型的文件的全局模式.
+     *   ignoresTypeAware?: string[], // 不应具有类型感知的文件的 Glob 模式
+     *   tsconfigPath?: string, // 提供此选项后，将启用类型感知规则
+     * }
      */
     react: true,
     /**
      * 是否启用 unocss 规则
      * @default 默认值: false,
-     * @example 可选: true | { attributify?: boolean; strict?: boolean }
+     * @example 可选: true |
+     * {
+     *   attributify?: boolean; // 启用 attributify 支持.
+     *   strict?: boolean; // 启用严格模式，抛出有关阻止列表类的错误
+     * }
      */
     unocss: true,
     /**
      * 是否启用 jsonc 规则
      * @default 默认值: true,
-     * @example 可选: false | { files?: string[] }
+     * @example 可选: false |
+     * {
+     *   files?: string[]; // 自定义 glob 覆盖 “files” 选项
+     *   stylistic: boolean; // 是否开启 stylistic
+     * }
      */
     jsonc: false,
     /**
      * 是否启用 yaml 规则
      * @default 默认值: true,
-     * @example 可选: false | { files?: string[] }
+     * @example 可选: false |
+     * {
+     *   files?: string[]; // 自定义 glob 覆盖 “files” 选项
+     *   stylistic: boolean; // 是否开启 stylistic
+     * }
      */
     yaml: false,
     /**
      * 是否启用 toml 规则
      * @default 默认值: false,
-     * @example 可选: true
+     * @example 可选: true |
+     * {
+     *   files?: string[]; // 自定义 glob 覆盖 “files” 选项
+     *   stylistic: boolean; // 是否开启 stylistic
+     * }
      */
     toml: false,
     /**
@@ -218,7 +272,13 @@ export default lincy({
     /**
      * 是否启用 formatters 规则
      * @default 默认值: false,
-     * @example 可选: true | { css?: 'prettier' | boolean; html?: 'prettier' | boolean; markdown?: 'prettier' | 'dprint' | boolean }
+     * @example 可选: true |
+     * {
+     *   css?: 'prettier' | boolean;
+     *   html?: 'prettier' | boolean;
+     *   graphql?: 'prettier' | boolean;
+     *   markdown?: 'prettier' | 'dprint' | boolean
+     * }
      */
     formatters: false,
     /**
@@ -524,6 +584,11 @@ export default lincy({
          * 默认使用 Prettier
          */
         css: true,
+        /**
+         * 格式化 graphql 文件
+         * 默认使用 Prettier
+         */
+        graphql: true,
         /**
          * 格式化 HTML 文件
          * 默认使用 Prettier
@@ -534,7 +599,19 @@ export default lincy({
          * 支持 Prettier 和 dprint
          * 默认使用 Prettier
          */
-        markdown: 'prettier'
+        markdown: 'prettier',
+        /**
+         * 格式化 svg 文件
+         * 需要安装 @prettier/plugin-xml 插件
+         * 默认使用 Prettier
+         */
+        svg: 'prettier',
+        /**
+         * 格式化 xml 文件
+         * 需要安装 @prettier/plugin-xml 插件
+         * 默认使用 Prettier
+         */
+        xml: 'prettier'
     }
 })
 ```