feat: add option features.import.plugin to swap plugin implementation, close #587

Author: antfu

packages/eslint-config/package.json

@@ -36,11 +36,15 @@
   },
   "peerDependencies": {
     "eslint": "^9.0.0",
-    "eslint-plugin-format": "*"
+    "eslint-plugin-format": "*",
+    "eslint-plugin-import-x": "*"
   },
   "peerDependenciesMeta": {
     "eslint-plugin-format": {
       "optional": true
+    },
+    "eslint-plugin-import-x": {
+      "optional": true
     }
   },
   "dependencies": {

packages/eslint-config/src/configs/import.ts

@@ -3,15 +3,27 @@ import type { Linter } from 'eslint'
 import type { NuxtESLintConfigOptions } from '../types'
 import { resolveOptions } from '../utils'
 
-export default function imports(options: NuxtESLintConfigOptions): Linter.Config[] {
+export default async function imports(options: NuxtESLintConfigOptions): Promise<Linter.Config[]> {
   const resolved = resolveOptions(options)
 
+  if (resolved.features.import === false) {
+    return []
+  }
+
+  const importOptions = resolved.features.import === true
+    ? {}
+    : resolved.features.import || {}
+
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const plugin: any = importOptions.package === 'eslint-plugin-import-x'
+    ? (await import('eslint-plugin-import-x')).default
+    : pluginImportLite
+
   return [
     {
       name: 'nuxt/import/rules',
       plugins: {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        import: pluginImportLite as any,
+        import: plugin,
       },
       rules: {
         'import/consistent-type-specifier-style': ['error', 'top-level'],

packages/eslint-config/src/types.ts

@@ -50,6 +50,13 @@ export interface NuxtESLintFeaturesOptions {
    */
   tooling?: boolean | ToolingOptions
 
+  /**
+   * Enable the import plugin
+   *
+   * @default true
+   */
+  import?: boolean | ImportPluginOptions
+
   /**
    * Enable stylistic ESLint rules for formatting and code style check
    *
@@ -91,6 +98,18 @@ export interface NuxtESLintFeaturesOptions {
   }
 }
 
+export interface ImportPluginOptions {
+  /**
+   * The import plugin to use
+   *
+   * We did not ship `eslint-plugin-import-x` as dependency,
+   * if you want to use it, you need to install it manually.
+   *
+   * @default 'eslint-plugin-import-lite'
+   */
+  package?: 'eslint-plugin-import-lite' | 'eslint-plugin-import-x'
+}
+
 export interface NuxtESLintConfigOptions {
   features?: NuxtESLintFeaturesOptions
 

packages/eslint-config/src/utils.ts

@@ -81,6 +81,7 @@ export function resolveOptions(
       tooling: false,
       formatters: false,
       nuxt: {},
+      import: {},
       ...config.features,
     },
     dirs,