feat: improve error messages for plugin conflicts, close #450, close #…

…474
nuxt · Aug 19, 2024 · bc0559e · bc0559e
1 parent e1471fc
commit bc0559e
Show file tree

Hide file tree

Showing 5 changed files with 100 additions and 654 deletions.
diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json
@@ -58,7 +58,7 @@
     "@typescript-eslint/eslint-plugin": "^8.1.0",
     "@typescript-eslint/parser": "^8.1.0",
     "eslint-config-flat-gitignore": "^0.1.8",
-    "eslint-flat-config-utils": "^0.3.0",
+    "eslint-flat-config-utils": "^0.3.1",
     "eslint-plugin-import-x": "^3.1.0",
     "eslint-plugin-jsdoc": "^50.2.2",
     "eslint-plugin-regexp": "^2.6.0",

diff --git a/packages/eslint-config/src/flat/index.ts b/packages/eslint-config/src/flat/index.ts
@@ -85,6 +85,16 @@ export function createConfigForNuxt(
     c.append(...userConfigs)
   }
 
+  c
+    .setPluginConflictsError()
+    .setPluginConflictsError('import', [
+      'Different instances of plugin "{{pluginName}}" found in multiple configs:',
+      '{{configNames}}.',
+      'You might forget to set `standalone: false`.',
+      'Please refer to https://eslint.nuxt.com/packages/module#custom-config-presets.',
+      '',
+    ].join('\n'))
+
   return c
 }
 

diff --git a/packages/module/package.json b/packages/module/package.json
@@ -54,7 +54,7 @@
     "@nuxt/eslint-plugin": "workspace:*",
     "@nuxt/kit": "^3.12.4",
     "chokidar": "^3.6.0",
-    "eslint-flat-config-utils": "^0.3.0",
+    "eslint-flat-config-utils": "^0.3.1",
     "eslint-typegen": "^0.3.1",
     "find-up": "^7.0.0",
     "get-port-please": "^3.1.2",

diff --git a/packages/module/src/modules/config/generate.ts b/packages/module/src/modules/config/generate.ts
@@ -23,10 +23,6 @@ export async function generateESLintConfig(options: ModuleOptions, nuxt: Nuxt, a
   }
 
   importLines.push(
-    {
-      from: 'eslint-flat-config-utils',
-      name: 'composer',
-    },
     {
       from: 'eslint-typegen',
       name: 'default',
@@ -51,8 +47,6 @@ export async function generateESLintConfig(options: ModuleOptions, nuxt: Nuxt, a
     dirs: getDirs(nuxt),
   }
 
-  configItems.push(`// Nuxt Configs\ncreateConfigForNuxt(options)`)
-
   for (const addon of addons) {
     const resolved = await addon.getConfigs()
     if (resolved?.imports)
@@ -83,14 +77,20 @@ export async function generateESLintConfig(options: ModuleOptions, nuxt: Nuxt, a
     '',
     'export { defineFlatConfigs }',
     '',
-    `export const configs = composer()`,
-    '',
     `export const options = resolveOptions(${JSON.stringify(basicOptions, null, 2)})`,
-    ``,
-    `configs.append(`,
-    configItems.join(',\n\n'),
-    `)`,
     '',
+    `export const configs = createConfigForNuxt(options)`,
+
+    ...(configItems.length
+      ? [
+          '',
+          `configs.append(`,
+          configItems.join(',\n\n'),
+          `)`,
+          '',
+        ]
+      : []),
+
     'export function withNuxt(...customs) {',
     '  return configs',
     '    .clone()',