fix: correct defineConfig usage in generated config (#161)

* fix: correct `defineConfig` usage in generated config

* fix: improve version handling

* chore: remove console.log

* chore: fix lint

* fix: update logic

* fix: update logic

* fix: correctly add defineConfig import

* fix: import defineConfig via @eslint/config-helpers

* fix: correct export

* fix: use semver package

Author: snitin315

lib/config-generator.js

@@ -12,6 +12,7 @@ import path from "node:path";
 import { spawnSync } from "node:child_process";
 import { writeFile } from "node:fs/promises";
 import enquirer from "enquirer";
+import semverSatisfies from "semver/functions/satisfies";
 import { isPackageTypeModule, installSyncSaveDev, fetchPeerDependencies, findPackageJson } from "./utils/npm-utils.js";
 import { getShorthandName } from "./utils/naming.js";
 import * as log from "./utils/logging.js";
@@ -119,7 +120,8 @@ export class ConfigGenerator {
         const languages = this.answers.languages ?? ["javascript"];
         const purpose = this.answers.purpose;
 
-        let importContent = "import { defineConfig } from \"eslint/config\";\n";
+        let isDefineConfigExported = false;
+        let importContent = "";
         let exportContent = "";
         let needCompatHelper = false;
 
@@ -245,6 +247,11 @@ export class ConfigGenerator {
 
                     this.result.devDependencies.push(...peers);
                 } else {
+                    const versionMatch = peers[eslintIndex].match(/eslint@(.+)/u);
+                    const versionRequirement = versionMatch[1]; // Complete version requirement string
+
+                    // Check if the version requirement allows for ESLint 9.22.0+
+                    isDefineConfigExported = semverSatisfies("9.22.0", versionRequirement);
 
                     // eslint is in the peer dependencies => overwrite eslint version
                     this.result.devDependencies[0] = peers[eslintIndex];
@@ -263,6 +270,15 @@ export class ConfigGenerator {
 
                 exportContent += `  compat.extends("${shorthandName}"),\n`;
             }
+        } else {
+            isDefineConfigExported = true;
+        }
+
+        if (isDefineConfigExported) {
+            importContent += "import { defineConfig } from \"eslint/config\";\n";
+        } else {
+            this.result.devDependencies.push("@eslint/config-helpers");
+            importContent += "import { defineConfig } from \"@eslint/config-helpers\";\n";
         }
 
         if (needCompatHelper) {

package.json

@@ -41,7 +41,8 @@
     },
     "dependencies": {
         "cross-spawn": "^7.0.2",
-        "enquirer": "^2.3.5"
+        "enquirer": "^2.3.5",
+        "semver": "^7.7.1"
     },
     "devDependencies": {
         "@vitest/coverage-v8": "^1.3.1",

tests/__snapshots__/config@eslint-config-airbnb

@@ -1,5 +1,5 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
+  "configContent": "import { defineConfig } from "@eslint/config-helpers";
 
 import path from "node:path";
 import { fileURLToPath } from "node:url";
@@ -22,6 +22,7 @@ export default defineConfig([
     "eslint-plugin-import@^2.25.3",
     "eslint-plugin-jsx-a11y@^6.5.1",
     "eslint-plugin-react-hooks@^4.3.0",
+    "@eslint/config-helpers",
     "@eslint/eslintrc",
     "@eslint/js",
   ],

tests/__snapshots__/config@eslint-config-airbnb-base

@@ -1,5 +1,5 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
+  "configContent": "import { defineConfig } from "@eslint/config-helpers";
 
 import path from "node:path";
 import { fileURLToPath } from "node:url";
@@ -19,6 +19,7 @@ export default defineConfig([
     "eslint@^7.32.0 || ^8.2.0",
     "eslint-config-airbnb-base",
     "eslint-plugin-import@^2.25.2",
+    "@eslint/config-helpers",
     "@eslint/eslintrc",
     "@eslint/js",
   ],

tests/__snapshots__/config@eslint-config-standard

@@ -1,5 +1,5 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
+  "configContent": "import { defineConfig } from "@eslint/config-helpers";
 
 import path from "node:path";
 import { fileURLToPath } from "node:url";
@@ -21,6 +21,7 @@ export default defineConfig([
     "eslint-plugin-import@^2.25.2",
     "eslint-plugin-n@^15.0.0 || ^16.0.0 ",
     "eslint-plugin-promise@^6.0.0",
+    "@eslint/config-helpers",
     "@eslint/eslintrc",
     "@eslint/js",
   ],

tests/__snapshots__/config@eslint-config-standard-flat

@@ -1,6 +1,6 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import config from "eslint-config-standard";
+  "configContent": "import config from "eslint-config-standard";
+import { defineConfig } from "@eslint/config-helpers";
 
 
 export default defineConfig([
@@ -13,6 +13,7 @@ export default defineConfig([
     "eslint-plugin-import@^2.25.2",
     "eslint-plugin-n@^15.0.0 || ^16.0.0 ",
     "eslint-plugin-promise@^6.0.0",
+    "@eslint/config-helpers",
   ],
   "installFlags": [
     "-D",

tests/__snapshots__/config@eslint-config-standard-flat2

@@ -1,6 +1,6 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import config from "eslint-config-standard";
+  "configContent": "import config from "eslint-config-standard";
+import { defineConfig } from "@eslint/config-helpers";
 
 
 export default defineConfig([
@@ -13,6 +13,7 @@ export default defineConfig([
     "eslint-plugin-import@^2.25.2",
     "eslint-plugin-n@^15.0.0 || ^16.0.0 ",
     "eslint-plugin-promise@^6.0.0",
+    "@eslint/config-helpers",
   ],
   "installFlags": [
     "-D",

tests/__snapshots__/config@eslint-config-xo

@@ -1,6 +1,6 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import config from "eslint-config-xo";
+  "configContent": "import config from "eslint-config-xo";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/esm-css-problems

@@ -1,6 +1,6 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import css from "@eslint/css";
+  "configContent": "import css from "@eslint/css";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/esm-css-syntax

@@ -1,6 +1,6 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import css from "@eslint/css";
+  "configContent": "import css from "@eslint/css";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/esm-javascript-json-problems

@@ -1,8 +1,8 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import js from "@eslint/js";
+  "configContent": "import js from "@eslint/js";
 import globals from "globals";
 import json from "@eslint/json";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/esm-json-problems

@@ -1,6 +1,6 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import json from "@eslint/json";
+  "configContent": "import json from "@eslint/json";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/esm-json-syntax

@@ -1,6 +1,6 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import json from "@eslint/json";
+  "configContent": "import json from "@eslint/json";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/esm-json5-problems

@@ -1,6 +1,6 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import json from "@eslint/json";
+  "configContent": "import json from "@eslint/json";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/esm-json5-syntax

@@ -1,6 +1,6 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import json from "@eslint/json";
+  "configContent": "import json from "@eslint/json";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/esm-jsonc-problems

@@ -1,6 +1,6 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import json from "@eslint/json";
+  "configContent": "import json from "@eslint/json";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/esm-jsonc-syntax

@@ -1,6 +1,6 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import json from "@eslint/json";
+  "configContent": "import json from "@eslint/json";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/esm-markdown-commonmark-problems

@@ -1,6 +1,6 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import markdown from "@eslint/markdown";
+  "configContent": "import markdown from "@eslint/markdown";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/esm-markdown-commonmark-syntax

@@ -1,6 +1,6 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import markdown from "@eslint/markdown";
+  "configContent": "import markdown from "@eslint/markdown";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/esm-markdown-gfm-problems

@@ -1,6 +1,6 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import markdown from "@eslint/markdown";
+  "configContent": "import markdown from "@eslint/markdown";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/esm-markdown-gfm-syntax

@@ -1,6 +1,6 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import markdown from "@eslint/markdown";
+  "configContent": "import markdown from "@eslint/markdown";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/problems-commonjs-none-javascript

@@ -1,7 +1,7 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import js from "@eslint/js";
+  "configContent": "import js from "@eslint/js";
 import globals from "globals";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/problems-commonjs-none-typescript

@@ -1,8 +1,8 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import js from "@eslint/js";
+  "configContent": "import js from "@eslint/js";
 import globals from "globals";
 import tseslint from "typescript-eslint";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/problems-commonjs-react-javascript

@@ -1,8 +1,8 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import js from "@eslint/js";
+  "configContent": "import js from "@eslint/js";
 import globals from "globals";
 import pluginReact from "eslint-plugin-react";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/problems-commonjs-react-typescript

@@ -1,9 +1,9 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import js from "@eslint/js";
+  "configContent": "import js from "@eslint/js";
 import globals from "globals";
 import tseslint from "typescript-eslint";
 import pluginReact from "eslint-plugin-react";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/problems-commonjs-vue-javascript

@@ -1,8 +1,8 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import js from "@eslint/js";
+  "configContent": "import js from "@eslint/js";
 import globals from "globals";
 import pluginVue from "eslint-plugin-vue";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/problems-commonjs-vue-typescript

@@ -1,9 +1,9 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import js from "@eslint/js";
+  "configContent": "import js from "@eslint/js";
 import globals from "globals";
 import tseslint from "typescript-eslint";
 import pluginVue from "eslint-plugin-vue";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/problems-esm-none-javascript

@@ -1,7 +1,7 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import js from "@eslint/js";
+  "configContent": "import js from "@eslint/js";
 import globals from "globals";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/problems-esm-none-typescript

@@ -1,8 +1,8 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import js from "@eslint/js";
+  "configContent": "import js from "@eslint/js";
 import globals from "globals";
 import tseslint from "typescript-eslint";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/problems-esm-react-javascript

@@ -1,8 +1,8 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import js from "@eslint/js";
+  "configContent": "import js from "@eslint/js";
 import globals from "globals";
 import pluginReact from "eslint-plugin-react";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/problems-esm-react-typescript

@@ -1,9 +1,9 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import js from "@eslint/js";
+  "configContent": "import js from "@eslint/js";
 import globals from "globals";
 import tseslint from "typescript-eslint";
 import pluginReact from "eslint-plugin-react";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/problems-esm-vue-javascript

@@ -1,8 +1,8 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import js from "@eslint/js";
+  "configContent": "import js from "@eslint/js";
 import globals from "globals";
 import pluginVue from "eslint-plugin-vue";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([

tests/__snapshots__/problems-esm-vue-typescript

@@ -1,9 +1,9 @@
 {
-  "configContent": "import { defineConfig } from "eslint/config";
-import js from "@eslint/js";
+  "configContent": "import js from "@eslint/js";
 import globals from "globals";
 import tseslint from "typescript-eslint";
 import pluginVue from "eslint-plugin-vue";
+import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([