refactor: combine environment config with base config (#176)

Author: xbinaryx

lib/config-generator.js

@@ -60,6 +60,31 @@ const __dirname = path.dirname(__filename);
 const compat = new FlatCompat({baseDirectory: __dirname, recommendedConfig: js.configs.recommended});
 `;
 
+/**
+ * Adds environment configuration to the ESLint config.
+ * @param {Object} options The options for adding environment config.
+ * @param {string[]} options.env The environment types to add.
+ * @param {string[]} options.devDependencies The dev dependencies array to modify.
+ * @returns {{config: string, importContent: string}} The environment configuration content and import statement.
+ */
+function addEnvironmentConfig({ env, devDependencies }) {
+    if (!env?.length) {
+        return { config: "", importContent: "" };
+    }
+
+    devDependencies.push("globals");
+    const envContent = {
+        browser: "globals: globals.browser",
+        node: "globals: globals.node",
+        "browser,node": "globals: {...globals.browser, ...globals.node}"
+    };
+
+    return {
+        config: `languageOptions: { ${envContent[env.join(",")]} }`,
+        importContent: "import globals from \"globals\";\n"
+    };
+}
+
 //-----------------------------------------------------------------------------
 // Exports
 //-----------------------------------------------------------------------------
@@ -133,23 +158,34 @@ export class ConfigGenerator {
             if (purpose === "problems") {
                 this.result.devDependencies.push("@eslint/js");
                 importContent += "import js from \"@eslint/js\";\n";
-                exportContent += `  { files: ["${extensions}"], plugins: { js }, extends: ["js/recommended"] },\n`;
+                let configContent = `  { files: ["${extensions}"], plugins: { js }, extends: ["js/recommended"]`;
+
+                const { config, importContent: envImport } = addEnvironmentConfig({
+                    env: this.answers.env,
+                    devDependencies: this.result.devDependencies
+                });
+
+                importContent += envImport;
+                if (config) {
+                    configContent += `, ${config}`;
+                }
+
+                exportContent += `${configContent} },\n`;
             }
 
             if (this.answers.moduleType === "commonjs" || this.answers.moduleType === "script") {
                 exportContent += `  { files: ["**/*.js"], languageOptions: { sourceType: "${this.answers.moduleType}" } },\n`;
             }
 
-            if (this.answers.env?.length > 0) {
-                this.result.devDependencies.push("globals");
-                importContent += "import globals from \"globals\";\n";
-                const envContent = {
-                    browser: "globals: globals.browser",
-                    node: "globals: globals.node",
-                    "browser,node": "globals: {...globals.browser, ...globals.node}"
-                };
+            if (this.answers.env?.length > 0 && purpose !== "problems") {
+                const { config, importContent: envImport } = addEnvironmentConfig({
+                    env: this.answers.env,
+                    devDependencies: this.result.devDependencies
+                });
+
+                importContent += envImport;
 
-                exportContent += `  { files: ["${extensions}"], languageOptions: { ${envContent[this.answers.env.join(",")]} } },\n`;
+                exportContent += `  { files: ["${extensions}"], ${config} },\n`;
             }
             if (useTs) {
                 this.result.devDependencies.push("typescript-eslint");

tests/__snapshots__/esm-javascript-json-problems

@@ -6,8 +6,7 @@ import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([
-  { files: ["**/*.{js,mjs,cjs}"], plugins: { js }, extends: ["js/recommended"] },
-  { files: ["**/*.{js,mjs,cjs}"], languageOptions: { globals: globals.node } },
+  { files: ["**/*.{js,mjs,cjs}"], plugins: { js }, extends: ["js/recommended"], languageOptions: { globals: globals.node } },
   { files: ["**/*.json"], plugins: { json }, language: "json/json", extends: ["json/recommended"] },
 ]);
 ",

tests/__snapshots__/problems-commonjs-none-javascript

@@ -5,9 +5,8 @@ import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([
-  { files: ["**/*.{js,mjs,cjs}"], plugins: { js }, extends: ["js/recommended"] },
+  { files: ["**/*.{js,mjs,cjs}"], plugins: { js }, extends: ["js/recommended"], languageOptions: { globals: {...globals.browser, ...globals.node} } },
   { files: ["**/*.js"], languageOptions: { sourceType: "commonjs" } },
-  { files: ["**/*.{js,mjs,cjs}"], languageOptions: { globals: {...globals.browser, ...globals.node} } },
 ]);
 ",
   "configFilename": "eslint.config.js",

tests/__snapshots__/problems-commonjs-none-typescript

@@ -6,9 +6,8 @@ import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([
-  { files: ["**/*.{js,mjs,cjs,ts,mts,cts}"], plugins: { js }, extends: ["js/recommended"] },
+  { files: ["**/*.{js,mjs,cjs,ts,mts,cts}"], plugins: { js }, extends: ["js/recommended"], languageOptions: { globals: {...globals.browser, ...globals.node} } },
   { files: ["**/*.js"], languageOptions: { sourceType: "commonjs" } },
-  { files: ["**/*.{js,mjs,cjs,ts,mts,cts}"], languageOptions: { globals: {...globals.browser, ...globals.node} } },
   tseslint.configs.recommended,
 ]);
 ",

tests/__snapshots__/problems-commonjs-react-javascript

@@ -6,9 +6,8 @@ import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([
-  { files: ["**/*.{js,mjs,cjs,jsx}"], plugins: { js }, extends: ["js/recommended"] },
+  { files: ["**/*.{js,mjs,cjs,jsx}"], plugins: { js }, extends: ["js/recommended"], languageOptions: { globals: {...globals.browser, ...globals.node} } },
   { files: ["**/*.js"], languageOptions: { sourceType: "commonjs" } },
-  { files: ["**/*.{js,mjs,cjs,jsx}"], languageOptions: { globals: {...globals.browser, ...globals.node} } },
   pluginReact.configs.flat.recommended,
 ]);
 ",

tests/__snapshots__/problems-commonjs-react-typescript

@@ -7,9 +7,8 @@ import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([
-  { files: ["**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"], plugins: { js }, extends: ["js/recommended"] },
+  { files: ["**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"], plugins: { js }, extends: ["js/recommended"], languageOptions: { globals: {...globals.browser, ...globals.node} } },
   { files: ["**/*.js"], languageOptions: { sourceType: "commonjs" } },
-  { files: ["**/*.{js,mjs,cjs,ts,mts,cts,jsx,tsx}"], languageOptions: { globals: {...globals.browser, ...globals.node} } },
   tseslint.configs.recommended,
   pluginReact.configs.flat.recommended,
 ]);

tests/__snapshots__/problems-commonjs-vue-javascript

@@ -6,9 +6,8 @@ import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([
-  { files: ["**/*.{js,mjs,cjs,vue}"], plugins: { js }, extends: ["js/recommended"] },
+  { files: ["**/*.{js,mjs,cjs,vue}"], plugins: { js }, extends: ["js/recommended"], languageOptions: { globals: {...globals.browser, ...globals.node} } },
   { files: ["**/*.js"], languageOptions: { sourceType: "commonjs" } },
-  { files: ["**/*.{js,mjs,cjs,vue}"], languageOptions: { globals: {...globals.browser, ...globals.node} } },
   pluginVue.configs["flat/essential"],
 ]);
 ",

tests/__snapshots__/problems-commonjs-vue-typescript

@@ -7,9 +7,8 @@ import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([
-  { files: ["**/*.{js,mjs,cjs,ts,mts,cts,vue}"], plugins: { js }, extends: ["js/recommended"] },
+  { files: ["**/*.{js,mjs,cjs,ts,mts,cts,vue}"], plugins: { js }, extends: ["js/recommended"], languageOptions: { globals: {...globals.browser, ...globals.node} } },
   { files: ["**/*.js"], languageOptions: { sourceType: "commonjs" } },
-  { files: ["**/*.{js,mjs,cjs,ts,mts,cts,vue}"], languageOptions: { globals: {...globals.browser, ...globals.node} } },
   tseslint.configs.recommended,
   pluginVue.configs["flat/essential"],
   { files: ["**/*.vue"], languageOptions: { parserOptions: { parser: tseslint.parser } } },

tests/__snapshots__/problems-esm-none-javascript

@@ -5,8 +5,7 @@ import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([
-  { files: ["**/*.{js,mjs,cjs}"], plugins: { js }, extends: ["js/recommended"] },
-  { files: ["**/*.{js,mjs,cjs}"], languageOptions: { globals: {...globals.browser, ...globals.node} } },
+  { files: ["**/*.{js,mjs,cjs}"], plugins: { js }, extends: ["js/recommended"], languageOptions: { globals: {...globals.browser, ...globals.node} } },
 ]);
 ",
   "configFilename": "eslint.config.js",

tests/__snapshots__/problems-esm-none-typescript

@@ -6,8 +6,7 @@ import { defineConfig } from "eslint/config";
 
 
 export default defineConfig([
-  { files: ["**/*.{js,mjs,cjs,ts,mts,cts}"], plugins: { js }, extends: ["js/recommended"] },
-  { files: ["**/*.{js,mjs,cjs,ts,mts,cts}"], languageOptions: { globals: {...globals.browser, ...globals.node} } },
+  { files: ["**/*.{js,mjs,cjs,ts,mts,cts}"], plugins: { js }, extends: ["js/recommended"], languageOptions: { globals: {...globals.browser, ...globals.node} } },
   tseslint.configs.recommended,
 ]);
 ",