@lincy/eslint-config 5.2.6 → 5.3.0

package/dist/index.cjs

@@ -66,6 +66,7 @@ __export(src_exports, {
   disables: () => disables,
   ensurePackages: () => ensurePackages,
   formatters: () => formatters,
+  getOverrides: () => getOverrides,
   ignores: () => ignores,
   imports: () => imports,
   interopDefault: () => interopDefault,
@@ -85,6 +86,7 @@ __export(src_exports, {
   regexp: () => regexp,
   renamePluginInConfigs: () => renamePluginInConfigs,
   renameRules: () => renameRules,
+  resolveSubOptions: () => resolveSubOptions,
   sortPackageJson: () => sortPackageJson,
   sortTsconfig: () => sortTsconfig,
   stylistic: () => stylistic,
@@ -99,7 +101,7 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
-// node_modules/.pnpm/tsup@8.3.0_jiti@2.3.3_postcss@8.4.47_tsx@4.19.1_typescript@5.6.3_yaml@2.6.0/node_modules/tsup/assets/cjs_shims.js
+// node_modules/.pnpm/tsup@8.3.5_jiti@2.3.3_postcss@8.4.47_tsx@4.19.2_typescript@5.6.3_yaml@2.6.0/node_modules/tsup/assets/cjs_shims.js
 var getImportMetaUrl = () => typeof document === "undefined" ? new URL(`file:${__filename}`).href : document.currentScript && document.currentScript.src || new URL("main.js", document.baseURI).href;
 var importMetaUrl = /* @__PURE__ */ getImportMetaUrl();
 
@@ -347,7 +349,8 @@ async function ensurePackages(packages) {
     return;
   const p = await import("@clack/prompts");
   const result = await p.confirm({
-    message: `${nonExistingPackages.length === 1 ? "Package is" : "Packages are"} required for this config: ${nonExistingPackages.join(", ")}. Do you want to install them?`
+    // message: `${nonExistingPackages.length === 1 ? 'Package is' : 'Packages are'} required for this config: ${nonExistingPackages.join(', ')}. Do you want to install them?`,
+    message: `\u6B64\u914D\u7F6E\u9700\u8981\u8F6F\u4EF6\u5305: ${nonExistingPackages.join(", ")}. \u4F60\u60F3\u5B89\u88C5\u5B83\u4EEC\u5417?`
   });
   if (result)
     await import("@antfu/install-pkg").then((i) => i.installPackage(nonExistingPackages, { dev: true }));
@@ -412,7 +415,6 @@ async function stylistic(options = {}) {
         },
         // 覆盖`stylistic`默认规则
         "style/brace-style": ["error", "stroustrup"],
-        "style/member-delimiter-style": ["error", { multiline: { delimiter: "none" } }],
         "style/multiline-ternary": ["error", "never"],
         ...overrides
       }
@@ -433,13 +435,23 @@ function mergePrettierOptions(options, overrides = {}) {
 }
 async function formatters(options = {}, stylistic2 = {}) {
   const defaultIndent = 4;
+  const isPrettierPluginXmlInScope = isPackageInScope("@prettier/plugin-xml");
   if (options === true) {
-    const isPrettierPluginXmlInScope = isPackageInScope("@prettier/plugin-xml");
+    const isPrettierPluginXmlInScope2 = isPackageInScope("@prettier/plugin-xml");
     options = {
       css: false,
       graphql: true,
       html: true,
       markdown: true,
+      svg: isPrettierPluginXmlInScope2,
+      xml: isPrettierPluginXmlInScope2
+    };
+  } else {
+    options = {
+      css: options.css ?? false,
+      graphql: options.graphql ?? true,
+      html: options.html ?? true,
+      markdown: options.markdown ?? true,
       svg: isPrettierPluginXmlInScope,
       xml: isPrettierPluginXmlInScope
     };
@@ -485,7 +497,7 @@ async function formatters(options = {}, stylistic2 = {}) {
   const pluginFormat = await interopDefault(import("eslint-plugin-format"));
   const configs2 = [
     {
-      name: "eslint/formatters/setup",
+      name: "eslint/formatter/setup",
       plugins: {
         format: pluginFormat
       }
@@ -498,12 +510,11 @@ async function formatters(options = {}, stylistic2 = {}) {
         languageOptions: {
           parser: parserPlain
         },
-        name: "eslint/formatters/css",
+        name: "eslint/formatter/css",
         rules: {
           "format/prettier": [
             "error",
             mergePrettierOptions(prettierOptions, {
-              ...prettierOptions,
               parser: "css"
             })
           ]
@@ -514,12 +525,11 @@ async function formatters(options = {}, stylistic2 = {}) {
         languageOptions: {
           parser: parserPlain
         },
-        name: "eslint/formatters/scss",
+        name: "eslint/formatter/scss",
         rules: {
           "format/prettier": [
             "error",
             mergePrettierOptions(prettierOptions, {
-              ...prettierOptions,
               parser: "scss"
             })
           ]
@@ -530,12 +540,11 @@ async function formatters(options = {}, stylistic2 = {}) {
         languageOptions: {
           parser: parserPlain
         },
-        name: "eslint/formatters/less",
+        name: "eslint/formatter/less",
         rules: {
           "format/prettier": [
             "error",
             mergePrettierOptions(prettierOptions, {
-              ...prettierOptions,
               parser: "less"
             })
           ]
@@ -549,12 +558,11 @@ async function formatters(options = {}, stylistic2 = {}) {
       languageOptions: {
         parser: parserPlain
       },
-      name: "eslint/formatters/html",
+      name: "eslint/formatter/html",
       rules: {
         "format/prettier": [
           "error",
           mergePrettierOptions(prettierOptions, {
-            ...prettierOptions,
             parser: "html"
           })
         ]
@@ -587,7 +595,7 @@ async function formatters(options = {}, stylistic2 = {}) {
       languageOptions: {
         parser: parserPlain
       },
-      name: "eslint/formatters/svg",
+      name: "eslint/formatter/svg",
       rules: {
         "format/prettier": [
           "error",
@@ -605,10 +613,11 @@ async function formatters(options = {}, stylistic2 = {}) {
     const formater = options.markdown === true ? "prettier" : options.markdown;
     configs2.push({
       files: [GLOB_MARKDOWN],
+      ignores: [],
       languageOptions: {
         parser: parserPlain
       },
-      name: "eslint/formatters/markdown",
+      name: "eslint/formatter/markdown",
       rules: {
         [`format/${formater}`]: [
           "error",
@@ -629,7 +638,7 @@ async function formatters(options = {}, stylistic2 = {}) {
       languageOptions: {
         parser: parserPlain
       },
-      name: "eslint/formatters/graphql",
+      name: "eslint/formatter/graphql",
       rules: {
         "format/prettier": [
           "error",
@@ -1173,7 +1182,7 @@ async function perfectionist(options = {}) {
             "object",
             "unknown"
           ],
-          internalPattern: ["~/**", "@/**"],
+          internalPattern: ["^~/.*", "^@/.*"],
           newlinesBetween: "ignore",
           order: "asc",
           type: "natural"
@@ -1193,13 +1202,18 @@ var ReactRefreshAllowConstantExportPackages = [
 ];
 async function react(options = {}) {
   const {
-    files = [GLOB_JSX, GLOB_TSX],
-    jsx: jsx2 = true,
+    files = [GLOB_SRC],
+    filesTypeAware = [GLOB_TS, GLOB_TSX],
+    ignoresTypeAware = [
+      `${GLOB_MARKDOWN}/**`
+    ],
     overrides = {},
-    version = "detect"
+    tsconfigPath
   } = options;
-  const tsconfigPath = options?.tsconfigPath ? toArray(options.tsconfigPath) : void 0;
   const isTypeAware = !!tsconfigPath;
+  const typeAwareRules = {
+    "react/no-leaked-conditional-rendering": "warn"
+  };
   await ensurePackages([
     "@eslint-react/eslint-plugin",
     "eslint-plugin-react-hooks",
@@ -1208,15 +1222,13 @@ async function react(options = {}) {
   const [
     pluginReact,
     pluginReactHooks,
-    pluginReactRefresh,
-    parserTs
+    pluginReactRefresh
   ] = await Promise.all([
     interopDefault(import("@eslint-react/eslint-plugin")),
     // @ts-expect-error missing types
     interopDefault(import("eslint-plugin-react-hooks")),
     // @ts-expect-error missing types
-    interopDefault(import("eslint-plugin-react-refresh")),
-    interopDefault(import("@typescript-eslint/parser"))
+    interopDefault(import("eslint-plugin-react-refresh"))
   ]);
   const _isAllowConstantExport = ReactRefreshAllowConstantExportPackages.some(
     (i) => (0, import_local_pkg2.isPackageExists)(i)
@@ -1237,13 +1249,12 @@ async function react(options = {}) {
     {
       files,
       languageOptions: {
-        parser: parserTs,
         parserOptions: {
           ecmaFeatures: {
-            jsx: jsx2
-          },
-          ...isTypeAware ? { project: tsconfigPath } : {}
-        }
+            jsx: true
+          }
+        },
+        sourceType: "module"
       },
       name: "eslint/react/rules",
       rules: {
@@ -1303,18 +1314,18 @@ async function react(options = {}) {
         "react/prefer-destructuring-assignment": "warn",
         "react/prefer-shorthand-boolean": "warn",
         "react/prefer-shorthand-fragment": "warn",
-        ...isTypeAware ? {
-          "react/no-leaked-conditional-rendering": "warn"
-        } : {},
         // overrides
         ...overrides
-      },
-      settings: {
-        react: {
-          version
-        }
       }
-    }
+    },
+    ...isTypeAware ? [{
+      files: filesTypeAware,
+      ignores: ignoresTypeAware,
+      name: "eslint/react/type-aware-rules",
+      rules: {
+        ...typeAwareRules
+      }
+    }] : []
   ];
 }
 
@@ -1948,6 +1959,8 @@ async function vue(options = {}) {
   ]);
   return [
     {
+      // This allows Vue plugin to work with auto imports
+      // https://github.com/vuejs/eslint-plugin-vue/pull/2422
       languageOptions: {
         globals: {
           computed: "readonly",
@@ -1990,21 +2003,21 @@ async function vue(options = {}) {
         processorVueBlocks({
           ...sfcBlocks,
           blocks: {
-            ...sfcBlocks.blocks,
-            styles: true
+            styles: true,
+            ...sfcBlocks.blocks
           }
         })
       ]),
       rules: {
         ...pluginVue.configs.base.rules,
-        ...vueVersion === "3" ? {
-          ...pluginVue.configs["vue3-essential"].rules,
-          ...pluginVue.configs["vue3-strongly-recommended"].rules,
-          ...pluginVue.configs["vue3-recommended"].rules
-        } : {
+        ...vueVersion === "2" ? {
           ...pluginVue.configs.essential.rules,
           ...pluginVue.configs["strongly-recommended"].rules,
           ...pluginVue.configs.recommended.rules
+        } : {
+          ...pluginVue.configs["vue3-essential"].rules,
+          ...pluginVue.configs["vue3-strongly-recommended"].rules,
+          ...pluginVue.configs["vue3-recommended"].rules
         },
         "antfu/no-top-level-await": "off",
         "node/prefer-global/process": "off",
@@ -2069,12 +2082,17 @@ async function vue(options = {}) {
         "vue/no-useless-v-bind": "error",
         "vue/no-v-html": "off",
         "vue/no-v-text-v-html-on-component": "off",
-        "vue/object-shorthand": ["error", "always", {
-          avoidQuotes: true,
-          ignoreConstructors: false
-        }],
+        "vue/object-shorthand": [
+          "error",
+          "always",
+          {
+            avoidQuotes: true,
+            ignoreConstructors: false
+          }
+        ],
         "vue/prefer-separate-static-class": "error",
         "vue/prefer-template": "error",
+        "vue/prop-name-casing": ["error", "camelCase"],
         "vue/require-default-prop": "off",
         "vue/require-prop-types": "off",
         "vue/singleline-html-element-content-newline": "off",
@@ -2084,12 +2102,17 @@ async function vue(options = {}) {
           "vue/array-bracket-spacing": ["error", "never"],
           "vue/arrow-spacing": ["error", { after: true, before: true }],
           "vue/block-spacing": ["error", "always"],
-          "vue/block-tag-newline": ["error", { multiline: "always", singleline: "always" }],
+          "vue/block-tag-newline": ["error", {
+            multiline: "always",
+            singleline: "always"
+          }],
           "vue/brace-style": ["error", "stroustrup", { allowSingleLine: false }],
           "vue/comma-dangle": ["error", "always-multiline"],
           "vue/comma-spacing": ["error", { after: true, before: false }],
           "vue/comma-style": ["error", "last"],
-          "vue/html-comment-content-spacing": ["error", "always", { exceptions: ["-"] }],
+          "vue/html-comment-content-spacing": ["error", "always", {
+            exceptions: ["-"]
+          }],
           "vue/key-spacing": ["error", { afterColon: true, beforeColon: false }],
           "vue/keyword-spacing": ["error", { after: true, before: true }],
           "vue/object-curly-newline": "off",
@@ -2114,6 +2137,9 @@ async function yaml(options = {}) {
     overrides = {},
     stylistic: stylistic2 = true
   } = options;
+  const {
+    quotes = "single"
+  } = typeof stylistic2 === "boolean" ? {} : stylistic2;
   const [
     pluginYaml,
     parserYaml
@@ -2153,7 +2179,7 @@ async function yaml(options = {}) {
           "yaml/indent": ["error", 2],
           "yaml/key-spacing": "error",
           "yaml/no-tab-indent": "error",
-          "yaml/quotes": ["error", { avoidEscape: false, prefer: "single" }],
+          "yaml/quotes": ["error", { avoidEscape: true, prefer: quotes === "backtick" ? "single" : quotes }],
           "yaml/spaced-comment": "error"
         } : {},
         ...overrides
@@ -2190,10 +2216,6 @@ var defaultPluginRenaming = {
   "vitest": "test",
   "yml": "yaml"
 };
-var ReactPackages = [
-  "react",
-  "next"
-];
 function lincy(options = {}, ...userConfigs) {
   const {
     autoRenamePlugins = true,
@@ -2202,7 +2224,7 @@ function lincy(options = {}, ...userConfigs) {
     ignores: ignoresList = [],
     jsx: enableJsx = true,
     overrides = {},
-    react: enableReact = ReactPackages.some((i) => (0, import_local_pkg4.isPackageExists)(i)),
+    react: enableReact = false,
     regexp: enableRegexp = true,
     typescript: enableTypeScript = (0, import_local_pkg4.isPackageExists)("typescript"),
     unicorn: enableUnicorn = true,
@@ -2216,12 +2238,8 @@ function lincy(options = {}, ...userConfigs) {
       console.log("[@lincy/eslint-config] Detected running in editor, some rules are disabled.");
   }
   const stylisticOptions = options.stylistic === false ? false : typeof options.stylistic === "object" ? options.stylistic : {};
-  const tsconfigPath = typeof enableTypeScript !== "boolean" && "tsconfigPath" in enableTypeScript ? enableTypeScript.tsconfigPath : void 0;
-  if (stylisticOptions) {
-    if (!("jsx" in stylisticOptions)) {
-      stylisticOptions.jsx = enableJsx;
-    }
-  }
+  if (stylisticOptions && !("jsx" in stylisticOptions))
+    stylisticOptions.jsx = enableJsx;
   const configs2 = [];
   if (enableGitignore) {
     if (typeof enableGitignore !== "boolean") {
@@ -2236,6 +2254,8 @@ function lincy(options = {}, ...userConfigs) {
       })]));
     }
   }
+  const typescriptOptions = resolveSubOptions(options, "typescript");
+  const tsconfigPath = "tsconfigPath" in typescriptOptions ? typescriptOptions.tsconfigPath : void 0;
   configs2.push(
     ignores({
       ignores: [
@@ -2245,7 +2265,7 @@ function lincy(options = {}, ...userConfigs) {
     }),
     javascript({
       isInEditor,
-      overrides: overrides.javascript
+      overrides: getOverrides(options, "javascript")
     }),
     comments({
       overrides: overrides.comments
@@ -2275,63 +2295,64 @@ function lincy(options = {}, ...userConfigs) {
   if (enableVue) {
     componentExts.push("vue");
   }
+  if (enableJsx) {
+    configs2.push(jsx());
+  }
   if (enableTypeScript) {
     configs2.push(typescript({
-      ...typeof enableTypeScript !== "boolean" ? enableTypeScript : {},
+      ...typescriptOptions,
       componentExts,
-      overrides: overrides.typescript,
+      overrides: getOverrides(options, "typescript"),
       tsconfigPath,
       type: options.type
     }));
   }
-  if (enableJsx) {
-    configs2.push(jsx());
-  }
   if (stylisticOptions) {
     configs2.push(stylistic({
-      overrides: overrides.stylistic,
+      overrides: getOverrides(options, "stylistic"),
       stylistic: stylisticOptions
     }));
   }
   if (enableRegexp) {
     configs2.push(regexp({
-      ...typeof enableRegexp === "boolean" ? {} : enableRegexp,
-      overrides: overrides.regexp
+      ...resolveSubOptions(options, "regexp"),
+      ...getOverrides(options, "regexp")
     }));
   }
   if (options.test ?? true) {
     configs2.push(test({
-      ...typeof options.test !== "boolean" ? options.test : {},
+      ...resolveSubOptions(options, "test"),
       isInEditor,
-      overrides: overrides.test
+      overrides: getOverrides(options, "test")
     }));
   }
   if (enableVue) {
     configs2.push(vue({
-      ...typeof options.vue !== "boolean" ? options.vue : {},
-      overrides: overrides.vue,
+      ...resolveSubOptions(options, "vue"),
+      overrides: getOverrides(options, "vue"),
       stylistic: stylisticOptions,
       typescript: !!enableTypeScript
     }));
   }
   if (enableReact) {
     configs2.push(react({
-      tsconfigPath,
-      ...typeof enableReact !== "boolean" ? enableReact : {},
-      overrides: overrides.react
+      ...typescriptOptions,
+      ...resolveSubOptions(options, "react"),
+      overrides: getOverrides(options, "react"),
+      tsconfigPath
     }));
   }
   if (enableUnoCSS) {
     configs2.push(unocss({
-      ...typeof enableUnoCSS === "boolean" ? {} : enableUnoCSS,
-      overrides: overrides.unocss
+      ...resolveSubOptions(options, "unocss"),
+      overrides: getOverrides(options, "unocss")
     }));
   }
   if (options.jsonc ?? true) {
     configs2.push(
       jsonc({
-        ...typeof options.jsonc !== "boolean" ? options.jsonc : {},
-        overrides: overrides.jsonc,
+        ...resolveSubOptions(options, "jsonc"),
+        overrides: getOverrides(options, "jsonc"),
         stylistic: stylisticOptions
       }),
       sortPackageJson(),
@@ -2340,23 +2361,27 @@ function lincy(options = {}, ...userConfigs) {
   }
   if (options.yaml ?? true) {
     configs2.push(yaml({
-      ...typeof options.yaml !== "boolean" ? options.yaml : {},
-      overrides: overrides.yaml,
+      ...resolveSubOptions(options, "yaml"),
+      overrides: getOverrides(options, "yaml"),
       stylistic: stylisticOptions
     }));
   }
-  if (options.toml) {
+  if (options.toml ?? true) {
     configs2.push(toml({
-      overrides: overrides.toml,
+      overrides: getOverrides(options, "toml"),
       stylistic: stylisticOptions
     }));
   }
   if (options.markdown ?? true) {
-    configs2.push(markdown({
-      ...typeof options.markdown !== "boolean" ? options.markdown : {},
-      componentExts,
-      overrides: overrides.markdown
-    }));
+    configs2.push(
+      markdown(
+        {
+          ...resolveSubOptions(options, "markdown"),
+          componentExts,
+          overrides: getOverrides(options, "markdown")
+        }
+      )
+    );
   }
   if (options.formatters) {
     configs2.push(formatters(
@@ -2371,14 +2396,12 @@ function lincy(options = {}, ...userConfigs) {
     throw new Error("[@lincy/eslint-config] \u7B2C\u4E00\u4E2A\u53C2\u6570\u4E0D\u5E94\u5305\u542B\u201Cfiles\u201D\u5C5E\u6027\uFF0C\u56E0\u4E3A\u9009\u9879\u5E94\u8BE5\u662F\u5168\u5C40\u7684\u3002\u8BF7\u5C06\u5176\u653E\u5728\u7B2C\u4E8C\u4E2A\u6216\u66F4\u540E\u9762\u7684\u914D\u7F6E\u4E2D\u3002");
   }
   const fusedConfig = flatConfigProps.reduce((acc, key) => {
-    if (key in options) {
+    if (key in options)
       acc[key] = options[key];
-    }
     return acc;
   }, {});
-  if (Object.keys(fusedConfig).length) {
+  if (Object.keys(fusedConfig).length)
     configs2.push([fusedConfig]);
-  }
   let composer = new import_eslint_flat_config_utils.FlatConfigComposer();
   composer = composer.append(
     ...configs2,
@@ -2389,6 +2412,16 @@ function lincy(options = {}, ...userConfigs) {
   }
   return composer;
 }
+function resolveSubOptions(options, key) {
+  return typeof options[key] === "boolean" ? {} : options[key] || {};
+}
+function getOverrides(options, key) {
+  const sub = resolveSubOptions(options, key);
+  return {
+    ...options.overrides?.[key],
+    ..."overrides" in sub ? sub.overrides : {}
+  };
+}
 
 // src/index.ts
 var src_default = lincy;
@@ -2429,6 +2462,7 @@ var src_default = lincy;
   disables,
   ensurePackages,
   formatters,
+  getOverrides,
   ignores,
   imports,
   interopDefault,
@@ -2448,6 +2482,7 @@ var src_default = lincy;
   regexp,
   renamePluginInConfigs,
   renameRules,
+  resolveSubOptions,
   sortPackageJson,
   sortTsconfig,
   stylistic,