@lincy/eslint-config 4.2.5 → 4.3.0

package/README.md

@@ -33,9 +33,7 @@ export default lincy()
 
 > 通常您不需要`.eslintignore`，因为它已由预设提供。
 
-### Add script for package.json
-
-For example:
+### 在 package.json 中添加脚本
 
 ```json
 {
@@ -46,7 +44,7 @@ For example:
 }
 ```
 
-## VS Code support (自动修复)
+## VS Code support (保存时自动修复)
 
 安装 [VS Code ESLint扩展](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
 
@@ -365,7 +363,7 @@ export default combine(
 
 | New Prefix | Original Prefix        | Source Plugin                                                                              |
 | ---------- | ---------------------- | ------------------------------------------------------------------------------------------ |
-| `import/*` | `i/*`                  | [eslint-plugin-i](https://github.com/un-es/eslint-plugin-i)                                |
+| `import/*` | `import-x/*`           | [eslint-plugin-import-x](https://github.com/un-es/eslint-plugin-import-x)                  |
 | `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) |
@@ -478,7 +476,7 @@ import lincy from '@lincy/eslint-config'
 export default lincy({
     formatters: {
         /**
-         * 格式化 CSS、LESS、SCSS 文件，以及 Vue 中的 `<style>` 块
+         * 格式化 CSS、LESS、SCSS 文件，以及 Vue 中的 `<style>` 模块
          * 默认使用 Prettier
          */
         css: true,

package/dist/index.cjs

@@ -59,6 +59,7 @@ __export(src_exports, {
   combine: () => combine,
   comments: () => comments,
   default: () => src_default,
+  defaultPluginRenaming: () => defaultPluginRenaming,
   ensurePackages: () => ensurePackages,
   formatters: () => formatters,
   ignores: () => ignores,
@@ -72,6 +73,7 @@ __export(src_exports, {
   node: () => node,
   perfectionist: () => perfectionist,
   react: () => react,
+  renamePluginInConfigs: () => renamePluginInConfigs,
   renameRules: () => renameRules,
   sortPackageJson: () => sortPackageJson,
   sortTsconfig: () => sortTsconfig,
@@ -91,11 +93,12 @@ module.exports = __toCommonJS(src_exports);
 var import_node_process3 = __toESM(require("process"), 1);
 var import_node_fs = __toESM(require("fs"), 1);
 var import_local_pkg4 = require("local-pkg");
+var import_eslint_flat_config_utils = require("eslint-flat-config-utils");
 
 // src/plugins.ts
 var import_eslint_plugin_antfu = __toESM(require("eslint-plugin-antfu"), 1);
 var import_eslint_plugin_eslint_comments = __toESM(require("eslint-plugin-eslint-comments"), 1);
-var pluginImport = __toESM(require("eslint-plugin-i"), 1);
+var pluginImport = __toESM(require("eslint-plugin-import-x"), 1);
 var import_eslint_plugin_n = __toESM(require("eslint-plugin-n"), 1);
 var import_eslint_plugin_unicorn = __toESM(require("eslint-plugin-unicorn"), 1);
 var import_eslint_plugin_unused_imports = __toESM(require("eslint-plugin-unused-imports"), 1);
@@ -179,6 +182,7 @@ var GLOB_EXCLUDE = [
   "**/.idea",
   "**/.output",
   "**/.vite-inspect",
+  "**/.yarn",
   "**/CHANGELOG*.md",
   "**/*.min.*",
   "**/LICENSE*",
@@ -462,15 +466,34 @@ async function combine(...configs) {
   const resolved = await Promise.all(configs);
   return resolved.flat();
 }
-function renameRules(rules, from, to) {
+function renameRules(rules, map) {
   return Object.fromEntries(
     Object.entries(rules).map(([key, value]) => {
-      if (key.startsWith(from))
-        return [to + key.slice(from.length), value];
+      for (const [from, to] of Object.entries(map)) {
+        if (key.startsWith(`${from}/`))
+          return [to + key.slice(from.length), value];
+      }
       return [key, value];
     })
   );
 }
+function renamePluginInConfigs(configs, map) {
+  return configs.map((i) => {
+    const clone = { ...i };
+    if (clone.rules)
+      clone.rules = renameRules(clone.rules, map);
+    if (clone.plugins) {
+      clone.plugins = Object.fromEntries(
+        Object.entries(clone.plugins).map(([key, value]) => {
+          if (key in map)
+            return [map[key], value];
+          return [key, value];
+        })
+      );
+    }
+    return clone;
+  });
+}
 function toArray(value) {
   return Array.isArray(value) ? value : [value];
 }
@@ -1047,7 +1070,6 @@ async function react(options = {}) {
         "react/jsx-no-target-blank": "error",
         "react/jsx-no-undef": "error",
         "react/jsx-no-useless-fragment": "error",
-        "react/jsx-pascal-case": "error",
         "react/jsx-props-no-spreading": "off",
         // 强制任何 JSX 属性都不会传播
         "react/jsx-uses-react": "error",
@@ -1104,6 +1126,7 @@ async function react(options = {}) {
         "react/static-property-placement": "error",
         "react/style-prop-object": "error",
         "react/void-dom-elements-no-children": "error",
+        "style/jsx-pascal-case": "error",
         ...typescript2 ? {
           "react/jsx-no-undef": "off",
           "react/prop-type": "off"
@@ -1199,6 +1222,22 @@ async function sortPackageJson() {
               "default"
             ],
             pathPattern: "^exports.*$"
+          },
+          {
+            order: [
+              // client hooks only
+              "pre-commit",
+              "prepare-commit-msg",
+              "commit-msg",
+              "post-commit",
+              "pre-rebase",
+              "post-rewrite",
+              "post-checkout",
+              "post-merge",
+              "pre-push",
+              "pre-auto-gc"
+            ],
+            pathPattern: "^(?:gitHooks|husky|simple-git-hooks)$"
           }
         ]
       }
@@ -1461,13 +1500,11 @@ async function typescript(options = {}) {
       rules: {
         ...renameRules(
           pluginTs.configs["eslint-recommended"].overrides[0].rules,
-          "@typescript-eslint/",
-          "ts/"
+          { "@typescript-eslint": "ts" }
         ),
         ...renameRules(
           pluginTs.configs.strict.rules,
-          "@typescript-eslint/",
-          "ts/"
+          { "@typescript-eslint": "ts" }
         ),
         "no-dupe-class-members": "off",
         "no-loss-of-precision": "off",
@@ -1478,6 +1515,7 @@ async function typescript(options = {}) {
         "ts/ban-types": ["error", { types: { Function: false } }],
         "ts/consistent-type-definitions": ["error", "interface"],
         "ts/consistent-type-imports": ["error", { disallowTypeAnnotations: false, prefer: "type-imports" }],
+        "ts/method-signature-style": ["error", "property"],
         "ts/no-dupe-class-members": "error",
         "ts/no-dynamic-delete": "off",
         "ts/no-explicit-any": "off",
@@ -1639,6 +1677,24 @@ async function vue(options = {}) {
   ]);
   return [
     {
+      languageOptions: {
+        globals: {
+          computed: "readonly",
+          defineEmits: "readonly",
+          defineExpose: "readonly",
+          defineProps: "readonly",
+          onMounted: "readonly",
+          onUnmounted: "readonly",
+          reactive: "readonly",
+          ref: "readonly",
+          shallowReactive: "readonly",
+          shallowRef: "readonly",
+          toRef: "readonly",
+          toRefs: "readonly",
+          watch: "readonly",
+          watchEffect: "readonly"
+        }
+      },
       name: "eslint:vue:setup",
       plugins: {
         vue: pluginVue
@@ -1887,6 +1943,7 @@ async function toml(options = {}) {
 
 // src/factory.ts
 var flatConfigProps = [
+  "name",
   "files",
   "ignores",
   "languageOptions",
@@ -1902,12 +1959,21 @@ var VuePackages = [
   "vitepress",
   "@slidev/cli"
 ];
+var defaultPluginRenaming = {
+  "@stylistic": "style",
+  "@typescript-eslint": "ts",
+  "import-x": "import",
+  "n": "node",
+  "vitest": "test",
+  "yml": "yaml"
+};
 var ReactPackages = [
   "react",
   "next"
 ];
-async function lincy(options = {}, ...userConfigs) {
+function lincy(options = {}, ...userConfigs) {
   const {
+    autoRenamePlugins = true,
     componentExts = [],
     gitignore: enableGitignore = true,
     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),
@@ -2038,11 +2104,14 @@ async function lincy(options = {}, ...userConfigs) {
   }, {});
   if (Object.keys(fusedConfig).length)
     configs.push([fusedConfig]);
-  const merged = combine(
+  let pipeline = new import_eslint_flat_config_utils.FlatConfigPipeline();
+  pipeline = pipeline.append(
     ...configs,
     ...userConfigs
   );
-  return merged;
+  if (autoRenamePlugins)
+    pipeline = pipeline.renamePlugins(defaultPluginRenaming);
+  return pipeline;
 }
 
 // src/index.ts
@@ -2077,6 +2146,7 @@ var src_default = lincy;
   StylisticConfigDefaults,
   combine,
   comments,
+  defaultPluginRenaming,
   ensurePackages,
   formatters,
   ignores,
@@ -2090,6 +2160,7 @@ var src_default = lincy;
   node,
   perfectionist,
   react,
+  renamePluginInConfigs,
   renameRules,
   sortPackageJson,
   sortTsconfig,