feat: automatically rename plugins in factory

Author: coderwyd

package.json

@@ -88,7 +88,7 @@
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-antfu": "^2.1.2",
     "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-i": "^2.29.1",
+    "eslint-plugin-import-x": "^0.4.1",
     "eslint-plugin-jsdoc": "^48.2.1",
     "eslint-plugin-jsonc": "^2.13.0",
     "eslint-plugin-n": "^16.6.2",

pnpm-lock.yaml

@@ -107,14 +107,11 @@ export async function typescript(
       rules: {
         ...renameRules(
           pluginTs.configs['eslint-recommended'].overrides![0].rules!,
-          '@typescript-eslint/',
-          'ts/',
-        ),
-        ...renameRules(
-          pluginTs.configs.strict.rules!,
-          '@typescript-eslint/',
-          'ts/',
+          { '@typescript-eslint': 'ts' },
         ),
+        ...renameRules(pluginTs.configs.strict.rules!, {
+          '@typescript-eslint': 'ts',
+        }),
         'no-dupe-class-members': 'off',
         'no-loss-of-precision': 'off',
         'no-redeclare': 'off',

src/configs/typescript.ts

@@ -28,6 +28,7 @@ import {
   getOverrides,
   interopDefault,
   loadPrettierConfig,
+  renamePluginInConfigs,
   resolveSubOptions,
 } from './shared'
 import {
@@ -55,6 +56,14 @@ const flatConfigProps: (keyof FlatConfigItem)[] = [
   'settings',
 ]
 
+export const defaultPluginRenaming = {
+  '@typescript-eslint': 'ts',
+  'import-x': 'import',
+  n: 'node',
+  vitest: 'test',
+  yml: 'yaml',
+}
+
 /**
  * Construct an array of ESLint flat config items.
  *
@@ -70,6 +79,7 @@ export async function defineConfig(
   ...userConfigs: Awaitable<UserConfigItem | UserConfigItem[]>[]
 ): Promise<UserConfigItem[]> {
   const {
+    autoRenamePlugins = true,
     componentExts = [],
     gitignore: enableGitignore = true,
     isInEditor = defaultIsInEditor,
@@ -222,7 +232,13 @@ export async function defineConfig(
   }, {} as FlatConfigItem)
   if (Object.keys(fusedConfig).length > 0) configs.push([fusedConfig])
 
-  const merged = combine(...configs, ...userConfigs)
+  const merged = await combine(...configs, ...userConfigs)
+
+  if (autoRenamePlugins)
+    return renamePluginInConfigs(merged, defaultPluginRenaming)
 
   return merged
 }
+
+export * from './shared'
+export * from './types'

src/index.ts

@@ -3,7 +3,7 @@
 
 export { default as pluginAntfu } from 'eslint-plugin-antfu'
 export { default as pluginComments } from 'eslint-plugin-eslint-comments'
-export * as pluginImport from 'eslint-plugin-i'
+export * as pluginImport from 'eslint-plugin-import-x'
 export { default as pluginNode } from 'eslint-plugin-n'
 export { default as pluginUnicorn } from 'eslint-plugin-unicorn'
 export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports'