@nx/eslint 17.0.4 → 17.0.6

package/src/generators/convert-to-flat-config/generator.js

@@ -3,29 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.convertToFlatConfigGenerator = void 0;
 const devkit_1 = require("@nx/devkit");
 const eslint_file_1 = require("../utils/eslint-file");
-const path_1 = require("path");
-const versions_1 = require("../../utils/versions");
 const json_converter_1 = require("./converters/json-converter");
-const js_yaml_1 = require("js-yaml");
 async function convertToFlatConfigGenerator(tree, options) {
     const eslintFile = (0, eslint_file_1.findEslintFile)(tree);
     if (!eslintFile) {
         throw new Error('Could not find root eslint file');
     }
-    if (eslintFile.endsWith('.js')) {
-        throw new Error('Only json and yaml eslint config files are supported for conversion');
+    if (!eslintFile.endsWith('.json')) {
+        throw new Error('Only json eslint config files are supported for conversion');
     }
-    const eslintIgnoreFiles = new Set(['.eslintignore']);
-    // convert root eslint config to eslint.config.js
+    // rename root eslint config to eslint.config.js
     convertRootToFlatConfig(tree, eslintFile);
-    // convert project eslint files to eslint.config.js
+    // rename and map files
     const projects = (0, devkit_1.getProjects)(tree);
     for (const [project, projectConfig] of projects) {
-        convertProjectToFlatConfig(tree, project, projectConfig, (0, devkit_1.readNxJson)(tree), eslintIgnoreFiles);
-    }
-    // delete all .eslintignore files
-    for (const ignoreFile of eslintIgnoreFiles) {
-        tree.delete(ignoreFile);
+        convertProjectToFlatConfig(tree, project, projectConfig, (0, devkit_1.readNxJson)(tree));
     }
     // replace references in nx.json
     updateNxJsonConfig(tree);
@@ -37,42 +29,27 @@ async function convertToFlatConfigGenerator(tree, options) {
 exports.convertToFlatConfigGenerator = convertToFlatConfigGenerator;
 exports.default = convertToFlatConfigGenerator;
 function convertRootToFlatConfig(tree, eslintFile) {
-    if (/\.base\.(js|json|yml|yaml)$/.test(eslintFile)) {
-        convertConfigToFlatConfig(tree, '', eslintFile, 'eslint.base.config.js');
+    if (eslintFile.endsWith('.base.json')) {
+        convertConfigToFlatConfig(tree, '', '.eslintrc.base.json', 'eslint.base.config.js');
     }
-    convertConfigToFlatConfig(tree, '', eslintFile.replace('.base.', '.'), 'eslint.config.js');
+    convertConfigToFlatConfig(tree, '', '.eslintrc.json', 'eslint.config.js');
 }
-function convertProjectToFlatConfig(tree, project, projectConfig, nxJson, eslintIgnoreFiles) {
-    const eslintFile = (0, eslint_file_1.findEslintFile)(tree, projectConfig.root);
-    if (eslintFile && !eslintFile.endsWith('.js')) {
+function convertProjectToFlatConfig(tree, project, projectConfig, nxJson) {
+    if (tree.exists(`${projectConfig.root}/.eslintrc.json`)) {
         if (projectConfig.targets) {
-            const eslintTargets = Object.keys(projectConfig.targets || {}).filter((t) => projectConfig.targets[t].executor === '@nx/eslint:lint' ||
-                projectConfig.targets[t].command?.includes('eslint'));
-            let ignorePath;
+            const eslintTargets = Object.keys(projectConfig.targets || {}).filter((t) => projectConfig.targets[t].executor === '@nx/eslint:lint');
             for (const target of eslintTargets) {
                 // remove any obsolete `eslintConfig` options pointing to the old config file
                 if (projectConfig.targets[target].options?.eslintConfig) {
                     delete projectConfig.targets[target].options.eslintConfig;
                 }
-                if (projectConfig.targets[target].options?.ignorePath) {
-                    ignorePath = projectConfig.targets[target].options.ignorePath;
-                    delete projectConfig.targets[target].options.ignorePath;
-                }
                 (0, devkit_1.updateProjectConfiguration)(tree, project, projectConfig);
             }
-            const nxHasEsLintTargets = Object.keys(nxJson.targetDefaults || {}).some((t) => (t === '@nx/eslint:lint' ||
-                nxJson.targetDefaults[t].executor === '@nx/eslint:lint' ||
-                nxJson.targetDefaults[t].command?.includes('eslint')) &&
+            const nxHasLintTargets = Object.keys(nxJson.targetDefaults || {}).some((t) => (t === '@nx/eslint:lint' ||
+                nxJson.targetDefaults[t].executor === '@nx/eslint:lint') &&
                 projectConfig.targets?.[t]);
-            const nxHasEsLintPlugin = (nxJson.plugins || []).some((p) => typeof p === 'string'
-                ? p === '@nx/eslint/plugin'
-                : p.plugin === '@nx/eslint/plugin');
-            if (nxHasEsLintTargets || nxHasEsLintPlugin || eslintTargets.length > 0) {
-                convertConfigToFlatConfig(tree, projectConfig.root, eslintFile, 'eslint.config.js', ignorePath);
-                eslintIgnoreFiles.add(`${projectConfig.root}/.eslintignore`);
-                if (ignorePath) {
-                    eslintIgnoreFiles.add(ignorePath);
-                }
+            if (nxHasLintTargets || eslintTargets.length > 0) {
+                convertConfigToFlatConfig(tree, projectConfig.root, '.eslintrc.json', 'eslint.config.js');
             }
         }
     }
@@ -101,39 +78,6 @@ function updateNxJsonConfig(tree) {
         });
     }
 }
-function convertConfigToFlatConfig(tree, root, source, target, ignorePath) {
-    const ignorePaths = ignorePath
-        ? [ignorePath, `${root}/.eslintignore`]
-        : [`${root}/.eslintignore`];
-    if (source.endsWith('.json')) {
-        const config = (0, devkit_1.readJson)(tree, `${root}/${source}`);
-        const conversionResult = (0, json_converter_1.convertEslintJsonToFlatConfig)(tree, root, config, ignorePaths);
-        return processConvertedConfig(tree, root, source, target, conversionResult);
-    }
-    if (source.endsWith('.yaml') || source.endsWith('.yml')) {
-        const originalContent = tree.read(`${root}/${source}`, 'utf-8');
-        const config = (0, js_yaml_1.load)(originalContent, {
-            json: true,
-            filename: source,
-        });
-        const conversionResult = (0, json_converter_1.convertEslintJsonToFlatConfig)(tree, root, config, ignorePaths);
-        return processConvertedConfig(tree, root, source, target, conversionResult);
-    }
-}
-function processConvertedConfig(tree, root, source, target, { content, addESLintRC, addESLintJS, }) {
-    // remove original config file
-    tree.delete((0, path_1.join)(root, source));
-    // save new
-    tree.write((0, path_1.join)(root, target), content);
-    // add missing packages
-    if (addESLintRC) {
-        (0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
-            '@eslint/eslintrc': versions_1.eslintrcVersion,
-        });
-    }
-    if (addESLintJS) {
-        (0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
-            '@eslint/js': versions_1.eslintVersion,
-        });
-    }
+function convertConfigToFlatConfig(tree, root, source, target) {
+    (0, json_converter_1.convertEslintJsonToFlatConfig)(tree, root, source, target);
 }

package/src/generators/convert-to-flat-config/schema.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://json-schema.org/schema",
+  "$schema": "http://json-schema.org/schema",
   "$id": "ConvertToFlatConfig",
   "cli": "nx",
   "description": "Convert an Nx workspace's ESLint configs to use Flat Config.",

package/src/generators/init/global-eslint-config.js

@@ -80,23 +80,19 @@ const getGlobalEsLintConfiguration = (unitTestRunner, rootProject) => {
 exports.getGlobalEsLintConfiguration = getGlobalEsLintConfiguration;
 const getGlobalFlatEslintConfiguration = (unitTestRunner, rootProject) => {
     const nodeList = (0, ast_utils_1.createNodeList)(new Map(), [], true);
-    let content = (0, ast_utils_1.stringifyNodeList)(nodeList);
+    let content = (0, ast_utils_1.stringifyNodeList)(nodeList, '', 'eslint.config.js');
     content = (0, ast_utils_1.addImportToFlatConfig)(content, 'nxPlugin', '@nx/eslint-plugin');
     content = (0, ast_utils_1.addPluginsToExportsBlock)(content, [
         { name: '@nx', varName: 'nxPlugin', imp: '@nx/eslint-plugin' },
     ]);
     if (!rootProject) {
-        content = (0, ast_utils_1.addBlockToFlatConfigExport)(content, (0, ast_utils_1.generateFlatOverride)(moduleBoundariesOverride));
+        content = (0, ast_utils_1.addBlockToFlatConfigExport)(content, (0, ast_utils_1.generateFlatOverride)(moduleBoundariesOverride, ''));
     }
-    content = (0, ast_utils_1.addBlockToFlatConfigExport)(content, (0, ast_utils_1.generateFlatOverride)(exports.typeScriptOverride));
-    content = (0, ast_utils_1.addBlockToFlatConfigExport)(content, (0, ast_utils_1.generateFlatOverride)(exports.javaScriptOverride));
+    content = (0, ast_utils_1.addBlockToFlatConfigExport)(content, (0, ast_utils_1.generateFlatOverride)(exports.typeScriptOverride, ''));
+    content = (0, ast_utils_1.addBlockToFlatConfigExport)(content, (0, ast_utils_1.generateFlatOverride)(exports.javaScriptOverride, ''));
     if (unitTestRunner === 'jest') {
-        content = (0, ast_utils_1.addBlockToFlatConfigExport)(content, (0, ast_utils_1.generateFlatOverride)(jestOverride));
+        content = (0, ast_utils_1.addBlockToFlatConfigExport)(content, (0, ast_utils_1.generateFlatOverride)(jestOverride, ''));
     }
-    // add ignore for .nx folder
-    content = (0, ast_utils_1.addBlockToFlatConfigExport)(content, (0, ast_utils_1.generateAst)({
-        ignores: ['.nx'],
-    }));
     return content;
 };
 exports.getGlobalFlatEslintConfiguration = getGlobalFlatEslintConfiguration;

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

@@ -1,3 +1,3 @@
 import { ProjectConfiguration, TargetConfiguration, Tree } from '@nx/devkit';
-export declare function migrateConfigToMonorepoStyle(projects: ProjectConfiguration[], tree: Tree, unitTestRunner: string, keepExistingVersions?: boolean): void;
+export declare function migrateConfigToMonorepoStyle(projects: ProjectConfiguration[], tree: Tree, unitTestRunner: string): void;
 export declare function findLintTarget(project: ProjectConfiguration): TargetConfiguration;

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

@@ -8,58 +8,24 @@ const global_eslint_config_1 = require("./global-eslint-config");
 const flat_config_1 = require("../../utils/flat-config");
 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, keepExistingVersions) {
-    const rootEslintConfig = (0, eslint_file_1.findEslintFile)(tree);
-    let skipCleanup = false;
-    if (rootEslintConfig?.match(/\.base\./) &&
-        !projects.some((p) => p.root === '.')) {
-        // if the migration has been run already, we need to rename the base config
-        // and only update the extends paths
-        tree.rename(rootEslintConfig, rootEslintConfig.replace('.base.', '.'));
-        skipCleanup = true;
+function migrateConfigToMonorepoStyle(projects, tree, unitTestRunner) {
+    if ((0, flat_config_1.useFlatConfig)(tree)) {
+        // we need this for the compat
+        (0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
+            '@eslint/js': versions_1.eslintVersion,
+        });
+        tree.write('eslint.base.config.js', (0, global_eslint_config_1.getGlobalFlatEslintConfiguration)(unitTestRunner));
     }
     else {
-        if ((0, flat_config_1.useFlatConfig)(tree)) {
-            // we need this for the compat
-            (0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
-                '@eslint/js': versions_1.eslintVersion,
-            }, undefined, keepExistingVersions);
-            tree.write(tree.exists('eslint.config.js')
-                ? 'eslint.base.config.js'
-                : 'eslint.config.js', (0, global_eslint_config_1.getGlobalFlatEslintConfiguration)(unitTestRunner));
-        }
-        else {
-            const eslintFile = (0, eslint_file_1.findEslintFile)(tree, '.');
-            (0, devkit_1.writeJson)(tree, eslintFile ? '.eslintrc.base.json' : '.eslintrc.json', (0, global_eslint_config_1.getGlobalEsLintConfiguration)(unitTestRunner));
-        }
+        (0, devkit_1.writeJson)(tree, '.eslintrc.base.json', (0, global_eslint_config_1.getGlobalEsLintConfiguration)(unitTestRunner));
     }
-    // update extends in all projects' eslint configs
+    // update extens in all projects' eslint configs
     projects.forEach((project) => {
-        let eslintFile;
         const lintTarget = findLintTarget(project);
         if (lintTarget) {
-            // If target is configured in project.json, read file from target options.
-            eslintFile =
-                lintTarget.options?.eslintConfig || (0, eslint_file_1.findEslintFile)(tree, project.root);
-        }
-        else if ((0, plugin_1.hasEslintPlugin)(tree)) {
-            // Otherwise, if `@nx/eslint/plugin` is used, match any of the known config files.
-            for (const f of config_file_1.ESLINT_CONFIG_FILENAMES) {
-                if (tree.exists((0, devkit_1.joinPathFragments)(project.root, f))) {
-                    eslintFile = f;
-                    break;
-                }
-            }
-        }
-        if (eslintFile) {
-            const projectEslintPath = (0, devkit_1.joinPathFragments)(project.root, eslintFile);
-            if (skipCleanup) {
-                const content = tree.read(projectEslintPath, 'utf-8');
-                tree.write(projectEslintPath, content.replace(rootEslintConfig, rootEslintConfig.replace('.base.', '.')));
-            }
-            else {
+            const eslintFile = lintTarget.options.eslintConfig || (0, eslint_file_1.findEslintFile)(tree, project.root);
+            if (eslintFile) {
+                const projectEslintPath = (0, devkit_1.joinPathFragments)(project.root, eslintFile);
                 migrateEslintFile(projectEslintPath, tree);
             }
         }
@@ -73,14 +39,13 @@ function findLintTarget(project) {
 }
 exports.findLintTarget = findLintTarget;
 function migrateEslintFile(projectEslintPath, tree) {
-    const baseFile = (0, eslint_file_1.findEslintFile)(tree);
     if ((0, eslint_file_1.isEslintConfigSupported)(tree)) {
         if ((0, flat_config_1.useFlatConfig)(tree)) {
             let config = tree.read(projectEslintPath, 'utf-8');
             // remove @nx plugin
             config = (0, ast_utils_1.removePlugin)(config, '@nx', '@nx/eslint-plugin-nx');
             // 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.addImportToFlatConfig)(config, 'baseConfig', `${(0, devkit_1.offsetFromRoot)((0, path_1.dirname)(projectEslintPath))}eslint.base.config.js`);
             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, [
@@ -104,11 +69,7 @@ function migrateEslintFile(projectEslintPath, tree) {
                 }
                 // add extends
                 json.extends = json.extends || [];
-                // ensure extends is an array
-                if (typeof json.extends === 'string') {
-                    json.extends = [json.extends];
-                }
-                const pathToRootConfig = `${(0, devkit_1.offsetFromRoot)((0, path_1.dirname)(projectEslintPath))}${baseFile}`;
+                const pathToRootConfig = `${(0, devkit_1.offsetFromRoot)((0, path_1.dirname)(projectEslintPath))}.eslintrc.base.json`;
                 if (json.extends.indexOf(pathToRootConfig) === -1) {
                     json.extends.push(pathToRootConfig);
                 }

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

@@ -1,9 +1,9 @@
 import type { GeneratorCallback, Tree } from '@nx/devkit';
+import { Linter } from '../utils/linter';
 export interface LinterInitOptions {
+    linter?: Linter;
+    unitTestRunner?: string;
     skipPackageJson?: boolean;
-    keepExistingVersions?: boolean;
-    updatePackageScripts?: boolean;
-    addPlugin?: boolean;
+    rootProject?: boolean;
 }
-export declare function initEsLint(tree: Tree, options: LinterInitOptions): Promise<GeneratorCallback>;
-export declare function lintInitGenerator(tree: Tree, options: LinterInitOptions): Promise<GeneratorCallback>;
+export declare function lintInitGenerator(tree: Tree, options: LinterInitOptions): GeneratorCallback;

package/src/generators/init/init.js

@@ -1,29 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.lintInitGenerator = exports.initEsLint = void 0;
+exports.lintInitGenerator = void 0;
 const devkit_1 = require("@nx/devkit");
-const update_package_scripts_1 = require("@nx/devkit/src/utils/update-package-scripts");
 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");
-function updateProductionFileset(tree) {
+const global_eslint_config_1 = require("./global-eslint-config");
+function addTargetDefaults(tree) {
     const nxJson = (0, devkit_1.readNxJson)(tree);
     const productionFileSet = nxJson.namedInputs?.production;
     if (productionFileSet) {
+        // Remove .eslintrc.json
         productionFileSet.push('!{projectRoot}/.eslintrc.json');
         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) {
-    const nxJson = (0, devkit_1.readNxJson)(tree);
     nxJson.targetDefaults ??= {};
-    nxJson.targetDefaults['@nx/eslint:lint'] ??= {};
-    nxJson.targetDefaults['@nx/eslint:lint'].cache ??= true;
-    nxJson.targetDefaults['@nx/eslint:lint'].inputs ??= [
+    nxJson.targetDefaults.lint ??= {};
+    nxJson.targetDefaults.lint.inputs ??= [
         'default',
         `{workspaceRoot}/.eslintrc.json`,
         `{workspaceRoot}/.eslintignore`,
@@ -31,63 +25,41 @@ function addTargetDefaults(tree) {
     ];
     (0, devkit_1.updateNxJson)(tree, nxJson);
 }
-function addPlugin(tree) {
-    const nxJson = (0, devkit_1.readNxJson)(tree);
-    nxJson.plugins ??= [];
-    for (const plugin of nxJson.plugins) {
-        if (typeof plugin === 'string'
-            ? plugin === '@nx/eslint/plugin'
-            : plugin.plugin === '@nx/eslint/plugin') {
-            return;
-        }
-    }
-    nxJson.plugins.push({
-        plugin: '@nx/eslint/plugin',
-        options: {
-            targetName: 'lint',
-        },
-    });
-    (0, devkit_1.updateNxJson)(tree, nxJson);
-}
-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;
-    const hasPlugin = (0, plugin_2.hasEslintPlugin)(tree);
-    const rootEslintFile = (0, eslint_file_1.findEslintFile)(tree);
-    if (rootEslintFile && options.addPlugin && !hasPlugin) {
-        addPlugin(tree);
-        if (options.updatePackageScripts) {
-            await (0, update_package_scripts_1.updatePackageScripts)(tree, plugin_1.createNodes);
-        }
-        return () => { };
-    }
-    if (rootEslintFile) {
+/**
+ * Initializes ESLint configuration in a workspace and adds necessary dependencies.
+ */
+function initEsLint(tree, options) {
+    if ((0, eslint_file_1.findEslintFile)(tree)) {
         return () => { };
     }
-    updateProductionFileset(tree);
-    if (options.addPlugin) {
-        addPlugin(tree);
+    if (!options.skipPackageJson) {
+        (0, devkit_1.removeDependenciesFromPackageJson)(tree, ['@nx/eslint'], []);
     }
-    else {
-        addTargetDefaults(tree);
+    (0, devkit_1.writeJson)(tree, '.eslintrc.json', (0, global_eslint_config_1.getGlobalEsLintConfiguration)(options.unitTestRunner, options.rootProject));
+    tree.write('.eslintignore', 'node_modules\n');
+    addTargetDefaults(tree);
+    if (tree.exists('.vscode/extensions.json')) {
+        (0, devkit_1.updateJson)(tree, '.vscode/extensions.json', (json) => {
+            json.recommendations ||= [];
+            const extension = 'dbaeumer.vscode-eslint';
+            if (!json.recommendations.includes(extension)) {
+                json.recommendations.push(extension);
+            }
+            return json;
+        });
     }
-    const tasks = [];
-    if (!options.skipPackageJson) {
-        tasks.push((0, devkit_1.removeDependenciesFromPackageJson)(tree, ['@nx/eslint'], []));
-        tasks.push((0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
+    return !options.skipPackageJson
+        ? (0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
             '@nx/eslint': versions_1.nxVersion,
+            '@nx/eslint-plugin': versions_1.nxVersion,
+            '@typescript-eslint/parser': versions_1.typescriptESLintVersion,
+            '@typescript-eslint/eslint-plugin': versions_1.typescriptESLintVersion,
             eslint: versions_1.eslintVersion,
-        }, undefined, options.keepExistingVersions));
-    }
-    if (options.updatePackageScripts) {
-        await (0, update_package_scripts_1.updatePackageScripts)(tree, plugin_1.createNodes);
-    }
-    return (0, devkit_1.runTasksInSerial)(...tasks);
+            'eslint-config-prettier': versions_1.eslintConfigPrettierVersion,
+        })
+        : () => { };
 }
-exports.initEsLint = initEsLint;
-async function lintInitGenerator(tree, options) {
-    return await initEsLint(tree, { addPlugin: false, ...options });
+function lintInitGenerator(tree, options) {
+    return initEsLint(tree, options);
 }
 exports.lintInitGenerator = lintInitGenerator;

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

@@ -1,4 +1,4 @@
-import type { GeneratorCallback, Tree } from '@nx/devkit';
+import type { Tree } from '@nx/devkit';
 import { Linter as LinterEnum } from '../utils/linter';
 interface LintProjectOptions {
     project: string;
@@ -10,13 +10,7 @@ interface LintProjectOptions {
     skipPackageJson?: boolean;
     unitTestRunner?: string;
     rootProject?: boolean;
-    keepExistingVersions?: boolean;
-    addPlugin?: boolean;
-    /**
-     * @internal
-     */
-    addExplicitTargets?: boolean;
 }
-export declare function lintProjectGenerator(tree: Tree, options: LintProjectOptions): Promise<GeneratorCallback>;
-export declare function lintProjectGeneratorInternal(tree: Tree, options: LintProjectOptions): Promise<GeneratorCallback>;
+export declare function mapLintPattern(projectRoot: string, extension: string, rootProject?: boolean): string;
+export declare function lintProjectGenerator(tree: Tree, options: LintProjectOptions): Promise<import("@nx/devkit").GeneratorCallback>;
 export {};

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.lintProjectGeneratorInternal = exports.lintProjectGenerator = void 0;
+exports.lintProjectGenerator = exports.mapLintPattern = void 0;
 const devkit_1 = require("@nx/devkit");
 const eslint_file_1 = require("../utils/eslint-file");
 const path_1 = require("path");
@@ -9,64 +9,34 @@ const init_migration_1 = require("../init/init-migration");
 const project_configuration_1 = require("nx/src/generators/utils/project-configuration");
 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 setup_root_eslint_1 = require("./setup-root-eslint");
-function lintProjectGenerator(tree, options) {
-    return lintProjectGeneratorInternal(tree, { addPlugin: false, ...options });
+function mapLintPattern(projectRoot, extension, rootProject) {
+    if (rootProject && (projectRoot === '.' || projectRoot === '')) {
+        return `${projectRoot}/src/**/*.${extension}`;
+    }
+    else {
+        return `${projectRoot}/**/*.${extension}`;
+    }
 }
-exports.lintProjectGenerator = lintProjectGenerator;
-async function lintProjectGeneratorInternal(tree, options) {
-    const nxJson = (0, devkit_1.readNxJson)(tree);
-    const addPluginDefault = process.env.NX_ADD_PLUGINS !== 'false' &&
-        nxJson.useInferencePlugins !== false;
-    options.addPlugin ??= addPluginDefault;
-    const tasks = [];
-    const initTask = await (0, init_1.lintInitGenerator)(tree, {
-        skipPackageJson: options.skipPackageJson,
-        addPlugin: options.addPlugin,
-    });
-    tasks.push(initTask);
-    const rootEsLintTask = (0, setup_root_eslint_1.setupRootEsLint)(tree, {
+exports.mapLintPattern = mapLintPattern;
+async function lintProjectGenerator(tree, options) {
+    const installTask = (0, init_1.lintInitGenerator)(tree, {
+        linter: options.linter,
         unitTestRunner: options.unitTestRunner,
         skipPackageJson: options.skipPackageJson,
         rootProject: options.rootProject,
     });
-    tasks.push(rootEsLintTask);
     const projectConfig = (0, devkit_1.readProjectConfiguration)(tree, options.project);
-    let lintFilePatterns = options.eslintFilePatterns;
-    if (!lintFilePatterns && options.rootProject && projectConfig.root === '.') {
-        lintFilePatterns = ['./src'];
-    }
-    if (lintFilePatterns &&
-        lintFilePatterns.length &&
-        !lintFilePatterns.includes('{projectRoot}') &&
-        isBuildableLibraryProject(projectConfig)) {
-        lintFilePatterns.push(`{projectRoot}/package.json`);
-    }
-    const hasPlugin = (0, plugin_1.hasEslintPlugin)(tree);
-    if (hasPlugin && !options.addExplicitTargets) {
-        if (lintFilePatterns &&
-            lintFilePatterns.length &&
-            lintFilePatterns.some((p) => !['./src', '{projectRoot}', projectConfig.root].includes(p))) {
-            projectConfig.targets['lint'] = {
-                command: `eslint ${lintFilePatterns
-                    .join(' ')
-                    .replace('{projectRoot}', projectConfig.root)}`,
-            };
-        }
-    }
-    else {
-        projectConfig.targets['lint'] = {
-            executor: '@nx/eslint:lint',
-        };
-        if (lintFilePatterns && lintFilePatterns.length) {
-            // only add lintFilePatterns if they are explicitly defined
-            projectConfig.targets['lint'].options = {
-                lintFilePatterns,
-            };
-        }
+    const lintFilePatterns = options.eslintFilePatterns ?? [];
+    if (isBuildableLibraryProject(projectConfig)) {
+        lintFilePatterns.push(`${projectConfig.root}/package.json`);
     }
+    projectConfig.targets['lint'] = {
+        executor: '@nx/eslint:lint',
+        outputs: ['{options.outputFile}'],
+        options: {
+            lintFilePatterns: lintFilePatterns,
+        },
+    };
     // we are adding new project which is not the root project or
     // companion e2e app so we should check if migration to
     // monorepo style is needed
@@ -81,14 +51,14 @@ async function lintProjectGeneratorInternal(tree, options) {
                     filteredProjects.push(project);
                 }
             });
-            (0, init_migration_1.migrateConfigToMonorepoStyle)(filteredProjects, tree, options.unitTestRunner, options.keepExistingVersions);
+            (0, init_migration_1.migrateConfigToMonorepoStyle)(filteredProjects, tree, options.unitTestRunner);
         }
     }
     // our root `.eslintrc` is already the project config, so we should not override it
     // 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 !== '.') {
-        createEsLintConfiguration(tree, projectConfig, options.setParserOptionsProject, options.rootProject);
+        createEsLintConfiguration(tree, projectConfig, options.setParserOptionsProject);
     }
     // Buildable libs need source analysis enabled for linting `package.json`.
     if (isBuildableLibraryProject(projectConfig) &&
@@ -104,14 +74,13 @@ async function lintProjectGeneratorInternal(tree, options) {
     if (!options.skipFormat) {
         await (0, devkit_1.formatFiles)(tree);
     }
-    return (0, devkit_1.runTasksInSerial)(...tasks);
+    return installTask;
 }
-exports.lintProjectGeneratorInternal = lintProjectGeneratorInternal;
-function createEsLintConfiguration(tree, 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}`
+exports.lintProjectGenerator = lintProjectGenerator;
+function createEsLintConfiguration(tree, projectConfig, setParserOptionsProject) {
+    const eslintConfig = (0, eslint_file_1.findEslintFile)(tree);
+    const pathToRootConfig = eslintConfig
+        ? `${(0, devkit_1.offsetFromRoot)(projectConfig.root)}${eslintConfig}`
         : undefined;
     const addDependencyChecks = isBuildableLibraryProject(projectConfig);
     const overrides = [
@@ -163,20 +132,20 @@ function createEsLintConfiguration(tree, projectConfig, setParserOptionsProject,
         const isCompatNeeded = addDependencyChecks;
         const nodes = [];
         const importMap = new Map();
-        if (extendedRootConfig) {
+        if (eslintConfig) {
             importMap.set(pathToRootConfig, 'baseConfig');
             nodes.push((0, ast_utils_1.generateSpreadElement)('baseConfig'));
         }
         overrides.forEach((override) => {
-            nodes.push((0, ast_utils_1.generateFlatOverride)(override));
+            nodes.push((0, ast_utils_1.generateFlatOverride)(override, projectConfig.root));
         });
         const nodeList = (0, ast_utils_1.createNodeList)(importMap, nodes, isCompatNeeded);
-        const content = (0, ast_utils_1.stringifyNodeList)(nodeList);
+        const content = (0, ast_utils_1.stringifyNodeList)(nodeList, projectConfig.root, 'eslint.config.js');
         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`), {
-            extends: extendedRootConfig ? [pathToRootConfig] : undefined,
+            extends: eslintConfig ? [pathToRootConfig] : undefined,
             // Include project files to be linted since the global one excludes all files.
             ignorePatterns: ['!**/*'],
             overrides,
@@ -200,8 +169,8 @@ function isBuildableLibraryProject(projectConfig) {
  */
 function isMigrationToMonorepoNeeded(projects, tree) {
     // the base config is already created, migration has been done
-    if (tree.exists(config_file_1.baseEsLintConfigFile) ||
-        tree.exists(config_file_1.baseEsLintFlatConfigFile)) {
+    if (tree.exists(eslint_file_1.baseEsLintConfigFile) ||
+        tree.exists(eslint_file_1.baseEsLintFlatConfigFile)) {
         return false;
     }
     const configs = Object.values(projects);
@@ -213,15 +182,10 @@ function isMigrationToMonorepoNeeded(projects, tree) {
     if (!rootProject || !rootProject.targets) {
         return false;
     }
-    // check if we're inferring lint target from `@nx/eslint/plugin`
-    if ((0, plugin_1.hasEslintPlugin)(tree)) {
-        for (const f of config_file_1.ESLINT_CONFIG_FILENAMES) {
-            if (tree.exists(f)) {
-                return true;
-            }
-        }
-    }
     // find if root project has lint target
     const lintTarget = (0, init_migration_1.findLintTarget)(rootProject);
-    return !!lintTarget;
+    if (!lintTarget) {
+        return false;
+    }
+    return true;
 }

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

@@ -1,5 +1,8 @@
-import type { Tree } from '@nx/devkit';
-import type { Linter } from 'eslint';
+import { Tree } from '@nx/devkit';
+import { Linter } from 'eslint';
+export declare const eslintConfigFileWhitelist: string[];
+export declare const baseEsLintConfigFile = ".eslintrc.base.json";
+export declare const baseEsLintFlatConfigFile = "eslint.base.config.js";
 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;