@lincy/eslint-config 4.2.2 → 4.2.4

package/README.md

@@ -70,6 +70,7 @@ For example:
   // 在 IDE 中静默样式规则，但仍会自动修复它们
   "eslint.rules.customizations": [
     { "rule": "style/*", "severity": "off" },
+    { "rule": "format/*", "severity": "off" },
     { "rule": "*-indent", "severity": "off" },
     { "rule": "*-spacing", "severity": "off" },
     { "rule": "*-spaces", "severity": "off" },
@@ -91,7 +92,8 @@ For example:
     "markdown",
     "json",
     "jsonc",
-    "yaml"
+    "yaml",
+    "toml"
   ]
 }
 ```
@@ -135,7 +137,7 @@ export default lincy({
     /**
      * 是否启用 stylistic 格式化规则
      * @default 默认值: true
-     * @example 可选: false | { indent?: number | 'tab'; quotes?: 'single' | 'double'; jsx?: boolean; semi?: boolean}
+     * @example 可选: false | { indent?: number | 'tab'; quotes?: 'single' | 'double'; jsx?: boolean; semi?: boolean }
      */
     stylistic: true,
     /**
@@ -147,7 +149,7 @@ export default lincy({
     /**
      * 是否启用 vue 规则
      * @default 默认值: 检测是否安装vue依赖,
-     * @example 可选: false | true | { files?: string[] }
+     * @example 可选: false | true | { files?: string[]; sfcBlocks: boolean }
      */
     vue: true,
     /**
@@ -180,6 +182,12 @@ export default lincy({
      * @example 可选: false | { files?: string[] }
      */
     yaml: false,
+    /**
+     * 是否启用 toml 规则
+     * @default 默认值: false,
+     * @example 可选: true
+     */
+    toml: false,
     /**
      * 是否启用 .gitignore 文件
      * @default 默认值: true,
@@ -201,13 +209,50 @@ export default lincy({
     /**
      * 是否启用 formatters 规则
      * @default 默认值: false,
-     * @example 可选: true | { css?: 'prettier' | boolean; html?: 'prettier' | boolean; toml?: 'dprint' | boolean; markdown?: 'prettier' | 'dprint' | boolean }
+     * @example 可选: true | { css?: 'prettier' | boolean; html?: 'prettier' | boolean; markdown?: 'prettier' | 'dprint' | boolean }
      */
     formatters: false,
     /**
      * 覆盖规则
      */
-    overrides: {},
+    overrides: {
+        ignores: [
+            // 忽略的路径/文件
+        ],
+        javascript: {
+            // javascript 规则
+        },
+        typescript: {
+            // typescript 规则
+        },
+        stylistic: {
+            // stylistic 规则
+        },
+        test: {
+            // test 规则
+        },
+        vue: {
+            // vue 规则
+        },
+        react: {
+            // react 规则
+        },
+        jsonc: {
+            // jsonc 规则
+        },
+        yaml: {
+            // yaml 规则
+        },
+        toml: {
+            // toml 规则
+        },
+        markdown: {
+            // markdown 规则
+        },
+        unocss: {
+            // unocss 规则
+        }
+    },
 
     // 工厂函数第一个参数默认为各规则的开关, 但是也可以作为追加规则使用, 当包含以下键名将会自动整合到一个规则里
     files: [],
@@ -261,6 +306,9 @@ export default lincy(
 
 您还可以导入非常细粒度的配置并根据需要组合它们：
 
+<details>
+<summary>点击展开例子</summary>
+
 ```js
 // eslint.config.js
 import {
@@ -278,6 +326,7 @@ import {
     sortPackageJson,
     sortTsconfig,
     stylistic,
+    toml,
     typescript,
     unicorn,
     unocss,
@@ -301,10 +350,13 @@ export default combine(
     unocss(/* Options */),
     jsonc(),
     yaml(),
+    toml(),
     markdown(),
 )
 ```
 
+</details>
+
 查看 [configs](https://github.com/lincenying/eslint-config/blob/main/src/configs) 和 [factory](https://github.com/lincenying/eslint-config/blob/main/src/factory.ts）了解更多详细信息。
 
 ### 插件重命名
@@ -337,7 +389,6 @@ import lincy from '@lincy/eslint-config'
 
 export default lincy(
     {
-        isInEditor: true,
         vue: true,
         jsx: true,
         react: true,
@@ -416,11 +467,47 @@ export default lincy({
 
 提供了一些可选配置，默认情况下不包含它们的依赖项
 
+#### Formatters
+
+使用外部格式化程序来格式化 ESLint 无法处理的文件（.css、.html 等）。 由 [eslint-plugin-format](https://github.com/antfu/eslint-plugin-format) 提供支持
+
+```js
+// eslint.config.js
+import lincy from '@lincy/eslint-config'
+
+export default lincy({
+    formatters: {
+        /**
+         * 格式化 CSS、LESS、SCSS 文件，以及 Vue 中的 `<style>` 块
+         * 默认使用 Prettier
+         */
+        css: true,
+        /**
+         * 格式化 HTML 文件
+         * 默认使用 Prettier
+         */
+        html: true,
+        /**
+         * 格式化 Markdown 文件
+         * 支持 Prettier 和 dprint
+         * 默认使用 Prettier
+         */
+        markdown: 'prettier'
+    }
+})
+```
+
+运行“npx eslint”会提示您安装所需的依赖项，当然，也可以手动安装它们：
+
+```bash
+pnpm add eslint-plugin-format -D
+```
+
 #### React
 
 当检测到依赖安装了`react`, 则默认开启
 
-运行“npx eslint”会提示您安装所需的依赖项，当然，您也可以手动安装它们：
+运行“npx eslint”会提示您安装所需的依赖项，当然，也可以手动安装它们：
 
 ```bash
 pnpm i -D eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-react-refresh
@@ -439,12 +526,14 @@ export default lincy({
 })
 ```
 
-运行“npx eslint”会提示您安装所需的依赖项，当然，您也可以手动安装它们：
+运行“npx eslint”会提示您安装所需的依赖项，当然，也可以手动安装它们：
 
 ```bash
 pnpm i -D @unocss/eslint-plugin
 ```
 
+### 可选规则
+
 #### `perfectionist` (sorting)
 
 这个插件 [`eslint-plugin-perfectionist`](https://github.com/azat-io/eslint-plugin-perfectionist) 允许你排序对象键名，导入，自动修复等。

package/dist/index.cjs

@@ -48,7 +48,9 @@ __export(src_exports, {
   GLOB_SRC: () => GLOB_SRC,
   GLOB_SRC_EXT: () => GLOB_SRC_EXT,
   GLOB_STYLE: () => GLOB_STYLE,
+  GLOB_SVELTE: () => GLOB_SVELTE,
   GLOB_TESTS: () => GLOB_TESTS,
+  GLOB_TOML: () => GLOB_TOML,
   GLOB_TS: () => GLOB_TS,
   GLOB_TSX: () => GLOB_TSX,
   GLOB_VUE: () => GLOB_VUE,
@@ -76,6 +78,7 @@ __export(src_exports, {
   stylistic: () => stylistic,
   test: () => test,
   toArray: () => toArray,
+  toml: () => toml,
   typescript: () => typescript,
   unicorn: () => unicorn,
   unocss: () => unocss,
@@ -133,8 +136,10 @@ var GLOB_JSON5 = "**/*.json5";
 var GLOB_JSONC = "**/*.jsonc";
 var GLOB_MARKDOWN = "**/*.md";
 var GLOB_MARKDOWN_IN_MARKDOWN = "**/*.md/*.md";
+var GLOB_SVELTE = "**/*.svelte";
 var GLOB_VUE = "**/*.vue";
 var GLOB_YAML = "**/*.y?(a)ml";
+var GLOB_TOML = "**/*.toml";
 var GLOB_HTML = "**/*.htm?(l)";
 var GLOB_MARKDOWN_CODE = `${GLOB_MARKDOWN}/${GLOB_SRC}`;
 var GLOB_TESTS = [
@@ -148,6 +153,7 @@ var GLOB_ALL_SRC = [
   GLOB_JSON,
   GLOB_JSON5,
   GLOB_MARKDOWN,
+  GLOB_SVELTE,
   GLOB_VUE,
   GLOB_YAML,
   GLOB_HTML
@@ -210,6 +216,7 @@ async function imports(options = {}) {
       },
       rules: {
         "antfu/import-dedupe": "error",
+        "antfu/no-import-dist": "error",
         "antfu/no-import-node-modules-by-path": "error",
         "import/first": "error",
         "import/no-duplicates": "error",
@@ -600,44 +607,15 @@ async function jsonc(options = {}) {
 }
 
 // src/configs/markdown.ts
-async function markdown(options = {}, formatMarkdown = false) {
+var parserPlain = __toESM(require("eslint-parser-plain"), 1);
+var import_eslint_merge_processors = require("eslint-merge-processors");
+async function markdown(options = {}) {
   const {
     componentExts = [],
     files = [GLOB_MARKDOWN],
     overrides = {}
   } = options;
   const markdown2 = await interopDefault(import("eslint-plugin-markdown"));
-  const baseProcessor = markdown2.processors.markdown;
-  const processor = !formatMarkdown ? {
-    meta: {
-      name: "markdown-processor"
-    },
-    supportsAutofix: true,
-    ...baseProcessor
-  } : {
-    meta: {
-      name: "markdown-processor-with-content"
-    },
-    postprocess(messages, filename) {
-      const markdownContent = messages.pop();
-      const codeSnippets = baseProcessor.postprocess(messages, filename);
-      return [
-        ...markdownContent || [],
-        ...codeSnippets || []
-      ];
-    },
-    preprocess(text, filename) {
-      const result = baseProcessor.preprocess(text, filename);
-      return [
-        ...result,
-        {
-          filename: ".__markdown_content__",
-          text
-        }
-      ];
-    },
-    supportsAutofix: true
-  };
   return [
     {
       name: "eslint:markdown:setup",
@@ -649,7 +627,17 @@ async function markdown(options = {}, formatMarkdown = false) {
       files,
       ignores: [GLOB_MARKDOWN_IN_MARKDOWN],
       name: "eslint:markdown:processor",
-      processor
+      processor: (0, import_eslint_merge_processors.mergeProcessors)([
+        markdown2.processors.markdown,
+        import_eslint_merge_processors.processorPassThrough
+      ])
+    },
+    {
+      files,
+      languageOptions: {
+        parser: parserPlain
+      },
+      name: "eslint:markdown:parser"
     },
     {
       files: [
@@ -725,6 +713,9 @@ async function perfectionist() {
   ];
 }
 
+// src/configs/formatters.ts
+var parserPlain2 = __toESM(require("eslint-parser-plain"), 1);
+
 // src/configs/stylistic.ts
 var StylisticConfigDefaults = {
   indent: 4,
@@ -781,11 +772,10 @@ async function formatters(options = {}, stylistic2 = {}) {
   ]);
   if (options === true) {
     options = {
-      css: true,
-      graphql: false,
+      css: false,
+      graphql: true,
       html: true,
-      markdown: true,
-      toml: true
+      markdown: true
     };
   }
   const {
@@ -798,9 +788,10 @@ async function formatters(options = {}, stylistic2 = {}) {
   };
   const prettierOptions = Object.assign(
     {
+      endOfLine: "lf",
       semi,
       singleQuote: quotes === "single",
-      tabWidth: typeof indent === "number" ? indent : 2,
+      tabWidth: typeof indent === "number" ? indent : 4,
       trailingComma: "all",
       useTabs: indent === "tab"
     },
@@ -808,7 +799,7 @@ async function formatters(options = {}, stylistic2 = {}) {
   );
   const dprintOptions = Object.assign(
     {
-      indentWidth: typeof indent === "number" ? indent : 2,
+      indentWidth: typeof indent === "number" ? indent : 4,
       quoteStyle: quotes === "single" ? "preferSingle" : "preferDouble",
       useTabs: indent === "tab"
     },
@@ -828,7 +819,7 @@ async function formatters(options = {}, stylistic2 = {}) {
       {
         files: [GLOB_CSS, GLOB_POSTCSS],
         languageOptions: {
-          parser: pluginFormat.parserPlain
+          parser: parserPlain2
         },
         name: "eslint:formatter:css",
         rules: {
@@ -844,7 +835,7 @@ async function formatters(options = {}, stylistic2 = {}) {
       {
         files: [GLOB_SCSS],
         languageOptions: {
-          parser: pluginFormat.parserPlain
+          parser: parserPlain2
         },
         name: "eslint:formatter:scss",
         rules: {
@@ -860,7 +851,7 @@ async function formatters(options = {}, stylistic2 = {}) {
       {
         files: [GLOB_LESS],
         languageOptions: {
-          parser: pluginFormat.parserPlain
+          parser: parserPlain2
         },
         name: "eslint:formatter:less",
         rules: {
@@ -879,7 +870,7 @@ async function formatters(options = {}, stylistic2 = {}) {
     configs.push({
       files: ["**/*.html"],
       languageOptions: {
-        parser: pluginFormat.parserPlain
+        parser: parserPlain2
       },
       name: "eslint:formatter:html",
       rules: {
@@ -893,36 +884,19 @@ async function formatters(options = {}, stylistic2 = {}) {
       }
     });
   }
-  if (options.toml) {
-    configs.push({
-      files: ["**/*.toml"],
-      languageOptions: {
-        parser: pluginFormat.parserPlain
-      },
-      name: "eslint:formatter:toml",
-      rules: {
-        "format/dprint": [
-          "error",
-          {
-            ...dprintOptions,
-            language: "toml"
-          }
-        ]
-      }
-    });
-  }
   if (options.markdown) {
     const formater = options.markdown === true ? "prettier" : options.markdown;
     configs.push({
-      files: ["**/*.__markdown_content__"],
+      files: [GLOB_MARKDOWN],
       languageOptions: {
-        parser: pluginFormat.parserPlain
+        parser: parserPlain2
       },
       name: "eslint:formatter:markdown",
       rules: {
         [`format/${formater}`]: [
           "error",
           formater === "prettier" ? {
+            printWidth: 200,
             ...prettierOptions,
             embeddedLanguageFormatting: "off",
             parser: "markdown"
@@ -938,7 +912,7 @@ async function formatters(options = {}, stylistic2 = {}) {
     configs.push({
       files: ["**/*.graphql"],
       languageOptions: {
-        parser: pluginFormat.parserPlain
+        parser: parserPlain2
       },
       name: "eslint:formatter:graphql",
       rules: {
@@ -1213,15 +1187,11 @@ async function sortPackageJson() {
           },
           {
             order: { type: "asc" },
-            pathPattern: "^(?:dev|peer|optional|bundled)?[Dd]ependencies$"
+            pathPattern: "^(?:dev|peer|optional|bundled)?[Dd]ependencies(Meta)?$"
           },
           {
             order: { type: "asc" },
-            pathPattern: "^resolutions$"
-          },
-          {
-            order: { type: "asc" },
-            pathPattern: "^pnpm.overrides$"
+            pathPattern: "^(?:resolutions|overrides|pnpm.overrides)$"
           },
           {
             order: [
@@ -1399,6 +1369,7 @@ async function test(options = {}) {
         "node/prefer-global/process": "off",
         "test/consistent-test-it": ["error", { fn: "it", withinDescribe: "it" }],
         "test/no-identical-title": "error",
+        "test/no-import-node-test": "error",
         "test/no-only-tests": isInEditor ? "off" : "error",
         "test/prefer-hooks-in-order": "error",
         "test/prefer-lowercase-title": "error",
@@ -1420,6 +1391,7 @@ async function typescript(options = {}) {
     GLOB_SRC,
     ...componentExts.map((ext) => `**/*.${ext}`)
   ];
+  const filesTypeAware = options.filesTypeAware ?? [GLOB_TS, GLOB_TSX];
   const typeAwareRules = {
     "dot-notation": "off",
     "no-implied-eval": "off",
@@ -1509,6 +1481,13 @@ async function typescript(options = {}) {
         "ts/prefer-ts-expect-error": "error",
         "ts/triple-slash-reference": "off",
         "ts/unified-signatures": "off",
+        ...overrides
+      }
+    },
+    {
+      files: filesTypeAware,
+      name: "eslint:typescript:rules-type-aware",
+      rules: {
         ...tsconfigPath ? typeAwareRules : {},
         ...overrides
       }
@@ -1587,6 +1566,7 @@ async function unicorn() {
 async function unocss(options = {}) {
   const {
     attributify = true,
+    overrides = {},
     strict = false
   } = options;
   await ensurePackages([
@@ -1610,13 +1590,15 @@ async function unocss(options = {}) {
         } : {},
         ...strict ? {
           "unocss/blocklist": "error"
-        } : {}
+        } : {},
+        ...overrides
       }
     }
   ];
 }
 
 // src/configs/vue.ts
+var import_eslint_merge_processors2 = require("eslint-merge-processors");
 var import_local_pkg3 = require("local-pkg");
 var pkg = (0, import_local_pkg3.getPackageInfoSync)("vue");
 var vueVersion = pkg && pkg.version;
@@ -1628,16 +1610,19 @@ async function vue(options = {}) {
     overrides = {},
     stylistic: stylistic2 = true
   } = options;
+  const sfcBlocks = options.sfcBlocks === true ? {} : options.sfcBlocks ?? {};
   const {
     indent = 4
   } = typeof stylistic2 === "boolean" ? {} : stylistic2;
   const [
     pluginVue,
-    parserVue
+    parserVue,
+    processorVueBlocks
   ] = await Promise.all([
     // @ts-expect-error missing types
     interopDefault(import("eslint-plugin-vue")),
-    interopDefault(import("vue-eslint-parser"))
+    interopDefault(import("vue-eslint-parser")),
+    interopDefault(import("eslint-processor-vue-blocks"))
   ]);
   return [
     {
@@ -1660,7 +1645,16 @@ async function vue(options = {}) {
         }
       },
       name: "eslint:vue:rules",
-      processor: pluginVue.processors[".vue"],
+      processor: sfcBlocks === false ? pluginVue.processors[".vue"] : (0, import_eslint_merge_processors2.mergeProcessors)([
+        pluginVue.processors[".vue"],
+        processorVueBlocks({
+          ...sfcBlocks,
+          blocks: {
+            ...sfcBlocks.blocks,
+            styles: true
+          }
+        })
+      ]),
       rules: {
         ...pluginVue.configs.base.rules,
         ...vueVersion === "3" ? {
@@ -1818,6 +1812,65 @@ async function yaml(options = {}) {
   ];
 }
 
+// src/configs/toml.ts
+async function toml(options = {}) {
+  const {
+    files = [GLOB_TOML],
+    overrides = {},
+    stylistic: stylistic2 = true
+  } = options;
+  const {
+    indent = 4
+  } = typeof stylistic2 === "boolean" ? {} : stylistic2;
+  const [
+    pluginToml,
+    parserToml
+  ] = await Promise.all([
+    interopDefault(import("eslint-plugin-toml")),
+    interopDefault(import("toml-eslint-parser"))
+  ]);
+  return [
+    {
+      name: "antfu:toml:setup",
+      plugins: {
+        toml: pluginToml
+      }
+    },
+    {
+      files,
+      languageOptions: {
+        parser: parserToml
+      },
+      name: "antfu:toml:rules",
+      rules: {
+        "style/spaced-comment": "off",
+        "toml/comma-style": "error",
+        "toml/keys-order": "error",
+        "toml/no-space-dots": "error",
+        "toml/no-unreadable-number-separator": "error",
+        "toml/precision-of-fractional-seconds": "error",
+        "toml/precision-of-integer": "error",
+        "toml/tables-order": "error",
+        "toml/vue-custom-block/no-parsing-error": "error",
+        ...stylistic2 ? {
+          "toml/array-bracket-newline": "error",
+          "toml/array-bracket-spacing": "error",
+          "toml/array-element-newline": "error",
+          "toml/indent": ["error", indent === "tab" ? 4 : indent],
+          "toml/inline-table-curly-spacing": "error",
+          "toml/key-spacing": "error",
+          "toml/padding-line-between-pairs": "error",
+          "toml/padding-line-between-tables": "error",
+          "toml/quoted-keys": "error",
+          "toml/spaced-comment": "error",
+          "toml/table-bracket-spacing": "error"
+        } : {},
+        ...overrides
+      }
+    }
+  ];
+}
+
 // src/factory.ts
 var flatConfigProps = [
   "files",
@@ -1843,7 +1896,7 @@ async function lincy(options = {}, ...userConfigs) {
   const {
     componentExts = [],
     gitignore: enableGitignore = true,
-    isInEditor = !!((import_node_process3.default.env.VSCODE_PID || import_node_process3.default.env.JETBRAINS_IDE) && !import_node_process3.default.env.CI),
+    isInEditor = !!((import_node_process3.default.env.VSCODE_PID || import_node_process3.default.env.JETBRAINS_IDE || import_node_process3.default.env.VIM) && !import_node_process3.default.env.CI),
     overrides = {},
     react: enableReact = ReactPackages.some((i) => (0, import_local_pkg4.isPackageExists)(i)),
     typescript: enableTypeScript = (0, import_local_pkg4.isPackageExists)("typescript"),
@@ -1922,9 +1975,10 @@ async function lincy(options = {}, ...userConfigs) {
     }));
   }
   if (enableUnoCSS) {
-    configs.push(unocss(
-      typeof enableUnoCSS === "boolean" ? {} : enableUnoCSS
-    ));
+    configs.push(unocss({
+      ...typeof enableUnoCSS === "boolean" ? {} : enableUnoCSS,
+      overrides: overrides.unocss
+    }));
   }
   if (options.jsonc ?? true) {
     configs.push(
@@ -1944,15 +1998,18 @@ async function lincy(options = {}, ...userConfigs) {
       stylistic: stylisticOptions
     }));
   }
+  if (options.toml) {
+    configs.push(toml({
+      overrides: overrides.toml,
+      stylistic: stylisticOptions
+    }));
+  }
   if (options.markdown ?? true) {
-    configs.push(markdown(
-      {
-        ...typeof options.markdown !== "boolean" ? options.markdown : {},
-        componentExts,
-        overrides: overrides.markdown
-      },
-      options.formatters === true || !!(options.formatters || {})?.markdown
-    ));
+    configs.push(markdown({
+      ...typeof options.markdown !== "boolean" ? options.markdown : {},
+      componentExts,
+      overrides: overrides.markdown
+    }));
   }
   if (options.formatters) {
     configs.push(formatters(
@@ -1996,7 +2053,9 @@ var src_default = lincy;
   GLOB_SRC,
   GLOB_SRC_EXT,
   GLOB_STYLE,
+  GLOB_SVELTE,
   GLOB_TESTS,
+  GLOB_TOML,
   GLOB_TS,
   GLOB_TSX,
   GLOB_VUE,
@@ -2023,6 +2082,7 @@ var src_default = lincy;
   stylistic,
   test,
   toArray,
+  toml,
   typescript,
   unicorn,
   unocss,