@nx/eslint 0.0.0-pr-30715-a5f5e3b → 0.0.0-pr-31222-862e973

package/src/generators/init/init-migration.js

@@ -11,19 +11,9 @@ const versions_1 = require("../../utils/versions");
 const ast_utils_1 = require("../utils/flat-config/ast-utils");
 const plugin_1 = require("../utils/plugin");
 const config_file_1 = require("../../utils/config-file");
-function migrateConfigToMonorepoStyle(projects, tree, unitTestRunner, eslintConfigFormat, keepExistingVersions) {
+function migrateConfigToMonorepoStyle(projects, tree, unitTestRunner, keepExistingVersions) {
     const rootEslintConfig = (0, eslint_file_1.findEslintFile)(tree);
     let skipCleanup = false;
-    if (rootEslintConfig) {
-        // We do not want to mix the formats
-        const fileExtension = (0, path_1.extname)(rootEslintConfig);
-        if (fileExtension === '.mjs' || fileExtension === '.cjs') {
-            eslintConfigFormat = fileExtension.slice(1);
-        }
-        else {
-            eslintConfigFormat = (0, eslint_file_1.determineEslintConfigFormat)(tree.read(rootEslintConfig, 'utf-8'));
-        }
-    }
     if (rootEslintConfig?.match(/\.base\./) &&
         !projects.some((p) => p.root === '.')) {
         // if the migration has been run already, we need to rename the base config
@@ -37,9 +27,9 @@ function migrateConfigToMonorepoStyle(projects, tree, unitTestRunner, eslintConf
             (0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
                 '@eslint/js': versions_1.eslintVersion,
             }, undefined, keepExistingVersions);
-            tree.write(tree.exists(`eslint.config.${eslintConfigFormat}`)
-                ? `eslint.base.config.${eslintConfigFormat}`
-                : `eslint.config.${eslintConfigFormat}`, (0, global_eslint_config_1.getGlobalFlatEslintConfiguration)(eslintConfigFormat));
+            tree.write(tree.exists('eslint.config.js')
+                ? 'eslint.base.config.js'
+                : 'eslint.config.js', (0, global_eslint_config_1.getGlobalFlatEslintConfiguration)());
         }
         else {
             const eslintFile = (0, eslint_file_1.findEslintFile)(tree, '.');
@@ -81,7 +71,8 @@ function migrateConfigToMonorepoStyle(projects, tree, unitTestRunner, eslintConf
 }
 function findLintTarget(project) {
     return Object.values(project.targets ?? {}).find((target) => target.executor === '@nx/eslint:lint' ||
-        target.executor === '@nx/linter:eslint');
+        target.executor === '@nx/linter:eslint' ||
+        target.executor === '@nrwl/linter:eslint');
 }
 function migrateEslintFile(projectEslintPath, tree) {
     const baseFile = (0, eslint_file_1.findEslintFile)(tree);
@@ -90,13 +81,15 @@ function migrateEslintFile(projectEslintPath, tree) {
             let config = tree.read(projectEslintPath, 'utf-8');
             // remove @nx plugin
             config = (0, ast_utils_1.removePlugin)(config, '@nx', '@nx/eslint-plugin-nx');
-            // if base config is cjs, we will need to import it using async import
+            // extend eslint.base.config.js
             config = (0, ast_utils_1.addImportToFlatConfig)(config, 'baseConfig', `${(0, devkit_1.offsetFromRoot)((0, path_1.dirname)(projectEslintPath))}${baseFile}`);
             config = (0, ast_utils_1.addBlockToFlatConfigExport)(config, (0, ast_utils_1.generateSpreadElement)('baseConfig'), { insertAtTheEnd: false });
             // cleanup file extends
             config = (0, ast_utils_1.removeCompatExtends)(config, [
                 'plugin:@nx/typescript',
                 'plugin:@nx/javascript',
+                'plugin:@nrwl/typescript',
+                'plugin:@nrwl/javascript',
             ]);
             config = (0, ast_utils_1.removePredefinedConfigs)(config, '@nx/eslint-plugin', 'nx', [
                 'flat/base',
@@ -111,7 +104,7 @@ function migrateEslintFile(projectEslintPath, tree) {
                 delete json.root;
                 // remove nrwl/nx plugins
                 if (json.plugins) {
-                    json.plugins = json.plugins.filter((p) => p !== '@nx');
+                    json.plugins = json.plugins.filter((p) => p !== '@nx' && p !== '@nrwl/nx');
                     if (json.plugins.length === 0) {
                         delete json.plugins;
                     }
@@ -131,7 +124,9 @@ function migrateEslintFile(projectEslintPath, tree) {
                     json.overrides.forEach((override) => {
                         if (override.extends) {
                             override.extends = override.extends.filter((ext) => ext !== 'plugin:@nx/typescript' &&
-                                ext !== 'plugin:@nx/javascript');
+                                ext !== 'plugin:@nrwl/nx/typescript' &&
+                                ext !== 'plugin:@nx/javascript' &&
+                                ext !== 'plugin:@nrwl/nx/javascript');
                             if (override.extends.length === 0) {
                                 delete override.extends;
                             }

package/src/generators/init/init.d.ts

@@ -4,7 +4,6 @@ export interface LinterInitOptions {
     keepExistingVersions?: boolean;
     updatePackageScripts?: boolean;
     addPlugin?: boolean;
-    eslintConfigFormat?: 'mjs' | 'cjs';
 }
 export declare function initEsLint(tree: Tree, options: LinterInitOptions): Promise<GeneratorCallback>;
 export declare function lintInitGenerator(tree: Tree, options: LinterInitOptions): Promise<GeneratorCallback>;

package/src/generators/init/init.js

@@ -8,19 +8,18 @@ const versions_1 = require("../../utils/versions");
 const eslint_file_1 = require("../utils/eslint-file");
 const plugin_1 = require("../../plugins/plugin");
 const plugin_2 = require("../utils/plugin");
-const path_1 = require("path");
-function updateProductionFileset(tree, format = 'mjs') {
+function updateProductionFileset(tree) {
     const nxJson = (0, devkit_1.readNxJson)(tree);
     const productionFileSet = nxJson.namedInputs?.production;
     if (productionFileSet) {
         productionFileSet.push('!{projectRoot}/.eslintrc.json');
-        productionFileSet.push(`!{projectRoot}/eslint.config.${format}`);
+        productionFileSet.push('!{projectRoot}/eslint.config.js');
         // Dedupe and set
         nxJson.namedInputs.production = Array.from(new Set(productionFileSet));
     }
     (0, devkit_1.updateNxJson)(tree, nxJson);
 }
-function addTargetDefaults(tree, format) {
+function addTargetDefaults(tree) {
     const nxJson = (0, devkit_1.readNxJson)(tree);
     nxJson.targetDefaults ??= {};
     nxJson.targetDefaults['@nx/eslint:lint'] ??= {};
@@ -29,40 +28,17 @@ function addTargetDefaults(tree, format) {
         'default',
         `{workspaceRoot}/.eslintrc.json`,
         `{workspaceRoot}/.eslintignore`,
-        `{workspaceRoot}/eslint.config.${format}`,
+        `{workspaceRoot}/eslint.config.js`,
     ];
     (0, devkit_1.updateNxJson)(tree, nxJson);
 }
-function updateVsCodeRecommendedExtensions(host) {
-    if (!host.exists('.vscode/extensions.json')) {
-        return;
-    }
-    (0, devkit_1.updateJson)(host, '.vscode/extensions.json', (json) => {
-        json.recommendations = json.recommendations || [];
-        const extension = 'dbaeumer.vscode-eslint';
-        if (!json.recommendations.includes(extension)) {
-            json.recommendations.push(extension);
-        }
-        return json;
-    });
-}
 async function initEsLint(tree, options) {
     const nxJson = (0, devkit_1.readNxJson)(tree);
     const addPluginDefault = process.env.NX_ADD_PLUGINS !== 'false' &&
         nxJson.useInferencePlugins !== false;
     options.addPlugin ??= addPluginDefault;
-    options.eslintConfigFormat ??= 'mjs';
     const hasPlugin = (0, plugin_2.hasEslintPlugin)(tree);
     const rootEslintFile = (0, eslint_file_1.findEslintFile)(tree);
-    if (rootEslintFile) {
-        const fileExtension = (0, path_1.extname)(rootEslintFile);
-        if (fileExtension === '.mjs' || fileExtension === '.cjs') {
-            options.eslintConfigFormat = fileExtension.slice(1);
-        }
-        else {
-            options.eslintConfigFormat = (0, eslint_file_1.determineEslintConfigFormat)(tree.read(rootEslintFile, 'utf-8'));
-        }
-    }
     const graph = await (0, devkit_1.createProjectGraphAsync)();
     const lintTargetNames = [
         'lint',
@@ -81,15 +57,14 @@ async function initEsLint(tree, options) {
     if (rootEslintFile) {
         return () => { };
     }
-    updateProductionFileset(tree, options.eslintConfigFormat);
-    updateVsCodeRecommendedExtensions(tree);
+    updateProductionFileset(tree);
     if (options.addPlugin) {
         await (0, add_plugin_1.addPlugin)(tree, graph, '@nx/eslint/plugin', plugin_1.createNodesV2, {
             targetName: lintTargetNames,
         }, options.updatePackageScripts);
     }
     else {
-        addTargetDefaults(tree, options.eslintConfigFormat);
+        addTargetDefaults(tree);
     }
     const tasks = [];
     if (!options.skipPackageJson) {

package/src/generators/lint-project/lint-project.d.ts

@@ -12,7 +12,6 @@ interface LintProjectOptions {
     rootProject?: boolean;
     keepExistingVersions?: boolean;
     addPlugin?: boolean;
-    eslintConfigFormat?: 'mjs' | 'cjs';
     /**
      * @internal
      */

package/src/generators/lint-project/lint-project.js

@@ -12,15 +12,12 @@ const flat_config_1 = require("../../utils/flat-config");
 const ast_utils_1 = require("../utils/flat-config/ast-utils");
 const config_file_1 = require("../../utils/config-file");
 const plugin_1 = require("../utils/plugin");
-const versions_1 = require("../../utils/versions");
 const setup_root_eslint_1 = require("./setup-root-eslint");
-const ts_solution_setup_1 = require("@nx/js/src/utils/typescript/ts-solution-setup");
 function lintProjectGenerator(tree, options) {
     return lintProjectGeneratorInternal(tree, { addPlugin: false, ...options });
 }
 async function lintProjectGeneratorInternal(tree, options) {
     const nxJson = (0, devkit_1.readNxJson)(tree);
-    options.eslintConfigFormat ??= 'mjs';
     const addPluginDefault = process.env.NX_ADD_PLUGINS !== 'false' &&
         nxJson.useInferencePlugins !== false;
     options.addPlugin ??= addPluginDefault;
@@ -28,14 +25,12 @@ async function lintProjectGeneratorInternal(tree, options) {
     const initTask = await (0, init_1.lintInitGenerator)(tree, {
         skipPackageJson: options.skipPackageJson,
         addPlugin: options.addPlugin,
-        eslintConfigFormat: options.eslintConfigFormat,
     });
     tasks.push(initTask);
     const rootEsLintTask = (0, setup_root_eslint_1.setupRootEsLint)(tree, {
         unitTestRunner: options.unitTestRunner,
         skipPackageJson: options.skipPackageJson,
         rootProject: options.rootProject,
-        eslintConfigFormat: options.eslintConfigFormat,
     });
     tasks.push(rootEsLintTask);
     const projectConfig = (0, devkit_1.readProjectConfiguration)(tree, options.project);
@@ -46,7 +41,7 @@ async function lintProjectGeneratorInternal(tree, options) {
     if (lintFilePatterns &&
         lintFilePatterns.length &&
         !lintFilePatterns.includes('{projectRoot}') &&
-        isBuildableLibraryProject(tree, projectConfig)) {
+        isBuildableLibraryProject(projectConfig)) {
         lintFilePatterns.push(`{projectRoot}/package.json`);
     }
     const hasPlugin = (0, plugin_1.hasEslintPlugin)(tree);
@@ -54,7 +49,6 @@ async function lintProjectGeneratorInternal(tree, options) {
         if (lintFilePatterns &&
             lintFilePatterns.length &&
             lintFilePatterns.some((p) => !['./src', '{projectRoot}', projectConfig.root].includes(p))) {
-            projectConfig.targets ??= {};
             projectConfig.targets['lint'] = {
                 command: `eslint ${lintFilePatterns
                     .join(' ')
@@ -63,7 +57,6 @@ async function lintProjectGeneratorInternal(tree, options) {
         }
     }
     else {
-        projectConfig.targets ??= {};
         projectConfig.targets['lint'] = {
             executor: '@nx/eslint:lint',
         };
@@ -89,7 +82,7 @@ async function lintProjectGeneratorInternal(tree, options) {
                     filteredProjects.push(project);
                 }
             });
-            const migrateTask = (0, init_migration_1.migrateConfigToMonorepoStyle)(filteredProjects, tree, options.unitTestRunner, options.eslintConfigFormat, options.keepExistingVersions);
+            const migrateTask = (0, init_migration_1.migrateConfigToMonorepoStyle)(filteredProjects, tree, options.unitTestRunner, options.keepExistingVersions);
             tasks.push(migrateTask);
         }
     }
@@ -97,15 +90,10 @@ async function lintProjectGeneratorInternal(tree, options) {
     // additionally, the companion e2e app would have `rootProject: true`
     // so we need to check for the root path as well
     if (!options.rootProject || projectConfig.root !== '.') {
-        const addDependencyChecks = options.addPackageJsonDependencyChecks ||
-            isBuildableLibraryProject(tree, projectConfig);
-        createEsLintConfiguration(tree, options, projectConfig, options.setParserOptionsProject, options.rootProject, addDependencyChecks);
-        if (addDependencyChecks) {
-            tasks.push((0, devkit_1.addDependenciesToPackageJson)(tree, {}, { 'jsonc-eslint-parser': versions_1.jsoncEslintParserVersion }, undefined, true));
-        }
+        createEsLintConfiguration(tree, options, projectConfig, options.setParserOptionsProject, options.rootProject);
     }
     // Buildable libs need source analysis enabled for linting `package.json`.
-    if (isBuildableLibraryProject(tree, projectConfig) &&
+    if (isBuildableLibraryProject(projectConfig) &&
         !isJsAnalyzeSourceFilesEnabled(tree)) {
         (0, devkit_1.updateJson)(tree, 'nx.json', (json) => {
             json.pluginsConfig ??= {};
@@ -120,24 +108,14 @@ async function lintProjectGeneratorInternal(tree, options) {
     }
     return (0, devkit_1.runTasksInSerial)(...tasks);
 }
-function createEsLintConfiguration(tree, options, projectConfig, setParserOptionsProject, rootProject, addDependencyChecks) {
+function createEsLintConfiguration(tree, options, projectConfig, setParserOptionsProject, rootProject) {
     // we are only extending root for non-standalone projects or their complementary e2e apps
     const extendedRootConfig = rootProject ? undefined : (0, eslint_file_1.findEslintFile)(tree);
     const pathToRootConfig = extendedRootConfig
         ? `${(0, devkit_1.offsetFromRoot)(projectConfig.root)}${extendedRootConfig}`
         : undefined;
-    if (extendedRootConfig) {
-        // We do not want to mix the formats
-        // if the base file extension is `.mjs` we should use `mjs` for the new file
-        // or if base the file extension is `.cjs` then the format should be `cjs`
-        const fileExtension = (0, path_1.extname)(extendedRootConfig);
-        if (fileExtension === '.mjs' || fileExtension === '.cjs') {
-            options.eslintConfigFormat = fileExtension.slice(1);
-        }
-        else {
-            options.eslintConfigFormat = (0, eslint_file_1.determineEslintConfigFormat)(tree.read(extendedRootConfig, 'utf-8'));
-        }
-    }
+    const addDependencyChecks = options.addPackageJsonDependencyChecks ||
+        isBuildableLibraryProject(projectConfig);
     const overrides = (0, flat_config_1.useFlatConfig)(tree)
         ? // For flat configs, we don't need to generate different overrides for each file. Users should add their own overrides as needed.
             []
@@ -200,11 +178,11 @@ function createEsLintConfiguration(tree, options, projectConfig, setParserOption
             nodes.push((0, ast_utils_1.generateSpreadElement)('baseConfig'));
         }
         overrides.forEach((override) => {
-            nodes.push((0, ast_utils_1.generateFlatOverride)(override, options.eslintConfigFormat));
+            nodes.push((0, ast_utils_1.generateFlatOverride)(override));
         });
-        const nodeList = (0, ast_utils_1.createNodeList)(importMap, nodes, options.eslintConfigFormat);
+        const nodeList = (0, ast_utils_1.createNodeList)(importMap, nodes);
         const content = (0, ast_utils_1.stringifyNodeList)(nodeList);
-        tree.write((0, path_1.join)(projectConfig.root, `eslint.config.${options.eslintConfigFormat}`), content);
+        tree.write((0, path_1.join)(projectConfig.root, 'eslint.config.js'), content);
     }
     else {
         (0, devkit_1.writeJson)(tree, (0, path_1.join)(projectConfig.root, `.eslintrc.json`), {
@@ -221,9 +199,8 @@ function isJsAnalyzeSourceFilesEnabled(tree) {
     return (jsPluginConfig?.analyzeSourceFiles ??
         nxJson.extends !== 'nx/presets/npm.json');
 }
-function isBuildableLibraryProject(tree, projectConfig) {
-    return ((0, ts_solution_setup_1.getProjectType)(tree, projectConfig.root, projectConfig.projectType) ===
-        'library' &&
+function isBuildableLibraryProject(projectConfig) {
+    return (projectConfig.projectType === 'library' &&
         projectConfig.targets?.build &&
         !!projectConfig.targets.build);
 }
@@ -233,7 +210,8 @@ function isBuildableLibraryProject(tree, projectConfig) {
  */
 function isMigrationToMonorepoNeeded(tree, graph) {
     // the base config is already created, migration has been done
-    if ([config_file_1.baseEsLintConfigFile, ...config_file_1.BASE_ESLINT_CONFIG_FILENAMES].some((f) => tree.exists(f))) {
+    if (tree.exists(config_file_1.baseEsLintConfigFile) ||
+        tree.exists(config_file_1.baseEsLintFlatConfigFile)) {
         return false;
     }
     const nodes = Object.values(graph.nodes);
@@ -243,7 +221,7 @@ function isMigrationToMonorepoNeeded(tree, graph) {
         return false;
     }
     for (const targetConfig of Object.values(rootProject.data.targets ?? {})) {
-        if (['@nx/eslint:lint', '@nx/linter:eslint'].includes(targetConfig.executor) ||
+        if (['@nx/eslint:lint', '@nrwl/linter:eslint', '@nx/linter:eslint'].includes(targetConfig.executor) ||
             (targetConfig.executor === 'nx:run-commands' &&
                 targetConfig.options?.command &&
                 targetConfig.options?.command.startsWith('eslint '))) {

package/src/generators/lint-project/setup-root-eslint.d.ts

@@ -3,6 +3,5 @@ export type SetupRootEsLintOptions = {
     unitTestRunner?: string;
     skipPackageJson?: boolean;
     rootProject?: boolean;
-    eslintConfigFormat?: 'mjs' | 'cjs';
 };
 export declare function setupRootEsLint(tree: Tree, options: SetupRootEsLintOptions): GeneratorCallback;

package/src/generators/lint-project/setup-root-eslint.js

@@ -11,7 +11,6 @@ function setupRootEsLint(tree, options) {
     if (rootEslintFile) {
         return () => { };
     }
-    options.eslintConfigFormat ??= 'mjs';
     if (!(0, flat_config_1.useFlatConfig)(tree)) {
         return setUpLegacyRootEslintRc(tree, options);
     }
@@ -39,7 +38,7 @@ function setUpLegacyRootEslintRc(tree, options) {
         : () => { };
 }
 function setUpRootFlatConfig(tree, options) {
-    tree.write(`eslint.config.${options.eslintConfigFormat}`, (0, global_eslint_config_1.getGlobalFlatEslintConfiguration)(options.eslintConfigFormat, options.rootProject));
+    tree.write('eslint.config.js', (0, global_eslint_config_1.getGlobalFlatEslintConfiguration)(options.rootProject));
     return !options.skipPackageJson
         ? (0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
             '@eslint/js': versions_1.eslint9__eslintVersion,

package/src/generators/utils/eslint-file.d.ts

@@ -3,13 +3,12 @@ import type { Linter } from 'eslint';
 export declare function findEslintFile(tree: Tree, projectRoot?: string): string | null;
 export declare function isEslintConfigSupported(tree: Tree, projectRoot?: string): boolean;
 export declare function updateRelativePathsInConfig(tree: Tree, sourcePath: string, destinationPath: string): void;
-export declare function determineEslintConfigFormat(content: string): 'mjs' | 'cjs';
 export declare function addOverrideToLintConfig(tree: Tree, root: string, override: Partial<Linter.ConfigOverride<Linter.RulesRecord>>, options?: {
     insertAtTheEnd?: boolean;
     checkBaseConfig?: boolean;
 }): void;
-export declare function updateOverrideInLintConfig(tree: Tree, rootOrFile: string, lookup: (override: Linter.ConfigOverride<Linter.RulesRecord>) => boolean, update: (override: Linter.ConfigOverride<Linter.RulesRecord>) => Linter.ConfigOverride<Linter.RulesRecord>): void;
-export declare function lintConfigHasOverride(tree: Tree, rootOrFile: string, lookup: (override: Linter.ConfigOverride<Linter.RulesRecord>) => boolean, checkBaseConfig?: boolean): boolean;
+export declare function updateOverrideInLintConfig(tree: Tree, root: string, lookup: (override: Linter.ConfigOverride<Linter.RulesRecord>) => boolean, update: (override: Linter.ConfigOverride<Linter.RulesRecord>) => Linter.ConfigOverride<Linter.RulesRecord>): void;
+export declare function lintConfigHasOverride(tree: Tree, root: string, lookup: (override: Linter.ConfigOverride<Linter.RulesRecord>) => boolean, checkBaseConfig?: boolean): boolean;
 export declare function replaceOverridesInLintConfig(tree: Tree, root: string, overrides: Linter.ConfigOverride<Linter.RulesRecord>[]): void;
 export declare function addExtendsToLintConfig(tree: Tree, root: string, plugin: string | {
     name: string;