@nx/eslint 17.3.0-canary.20240113-1d2bfde → 17.3.0-canary.20240118-8ccf327

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/eslint",
-  "version": "17.3.0-canary.20240113-1d2bfde",
+  "version": "17.3.0-canary.20240118-8ccf327",
   "private": false,
   "description": "The ESLint plugin for Nx contains executors, generators and utilities used for linting JavaScript/TypeScript projects within an Nx workspace.",
   "repository": {
@@ -34,11 +34,11 @@
     "js-yaml": "4.1.0"
   },
   "dependencies": {
-    "@nx/devkit": "17.3.0-canary.20240113-1d2bfde",
-    "@nx/js": "17.3.0-canary.20240113-1d2bfde",
+    "@nx/devkit": "17.3.0-canary.20240118-8ccf327",
+    "@nx/js": "17.3.0-canary.20240118-8ccf327",
     "tslib": "^2.3.0",
     "typescript": "~5.2.2",
-    "@nx/linter": "17.3.0-canary.20240113-1d2bfde"
+    "@nx/linter": "17.3.0-canary.20240118-8ccf327"
   },
   "peerDependenciesMeta": {
     "eslint": {

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): void;
+export declare function migrateConfigToMonorepoStyle(projects: ProjectConfiguration[], tree: Tree, unitTestRunner: string, keepExistingVersions?: boolean): void;
 export declare function findLintTarget(project: ProjectConfiguration): TargetConfiguration;

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

@@ -8,7 +8,7 @@ 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");
-function migrateConfigToMonorepoStyle(projects, tree, unitTestRunner) {
+function migrateConfigToMonorepoStyle(projects, tree, unitTestRunner, keepExistingVersions) {
     const rootEslintConfig = (0, eslint_file_1.findEslintFile)(tree);
     let skipCleanup = false;
     if (rootEslintConfig?.match(/\.base\./) &&
@@ -23,7 +23,7 @@ function migrateConfigToMonorepoStyle(projects, tree, unitTestRunner) {
             // 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));

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

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

package/src/generators/init/init.js

@@ -4,7 +4,6 @@ exports.lintInitGenerator = void 0;
 const devkit_1 = require("@nx/devkit");
 const versions_1 = require("../../utils/versions");
 const eslint_file_1 = require("../utils/eslint-file");
-const global_eslint_config_1 = require("./global-eslint-config");
 const plugin_1 = require("../utils/plugin");
 function updateProductionFileset(tree) {
     const nxJson = (0, devkit_1.readNxJson)(tree);
@@ -48,21 +47,6 @@ function addPlugin(tree) {
     });
     (0, devkit_1.updateNxJson)(tree, nxJson);
 }
-function updateVSCodeExtensions(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;
-        });
-    }
-}
-/**
- * Initializes ESLint configuration in a workspace and adds necessary dependencies.
- */
 function initEsLint(tree, options) {
     const addPlugins = process.env.NX_PCV3 === 'true';
     const hasPlugin = (0, plugin_1.hasEslintPlugin)(tree);
@@ -74,11 +58,6 @@ function initEsLint(tree, options) {
     if (rootEslintFile) {
         return () => { };
     }
-    if (!options.skipPackageJson) {
-        (0, devkit_1.removeDependenciesFromPackageJson)(tree, ['@nx/eslint'], []);
-    }
-    (0, devkit_1.writeJson)(tree, '.eslintrc.json', (0, global_eslint_config_1.getGlobalEsLintConfiguration)(options.unitTestRunner, options.rootProject));
-    tree.write('.eslintignore', 'node_modules\n');
     updateProductionFileset(tree);
     if (addPlugins) {
         addPlugin(tree);
@@ -86,17 +65,15 @@ function initEsLint(tree, options) {
     else {
         addTargetDefaults(tree);
     }
-    updateVSCodeExtensions(tree);
-    return !options.skipPackageJson
-        ? (0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
+    const tasks = [];
+    if (!options.skipPackageJson) {
+        tasks.push((0, devkit_1.removeDependenciesFromPackageJson)(tree, ['@nx/eslint'], []));
+        tasks.push((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,
-            'eslint-config-prettier': versions_1.eslintConfigPrettierVersion,
-        })
-        : () => { };
+        }, undefined, options.keepExistingVersions));
+    }
+    return (0, devkit_1.runTasksInSerial)(...tasks);
 }
 function lintInitGenerator(tree, options) {
     return initEsLint(tree, options);

package/src/generators/init/schema.json

@@ -5,6 +5,18 @@
   "title": "Initialize ESLint Plugin",
   "description": "Set up the ESLint plugin.",
   "type": "object",
-  "properties": {},
+  "properties": {
+    "skipPackageJson": {
+      "description": "Do not add dependencies to `package.json`.",
+      "type": "boolean",
+      "default": false
+    },
+    "keepExistingVersions": {
+      "type": "boolean",
+      "x-priority": "internal",
+      "description": "Keep existing dependencies versions",
+      "default": false
+    }
+  },
   "required": []
 }

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

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

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

@@ -11,13 +11,19 @@ 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");
 async function lintProjectGenerator(tree, options) {
-    const installTask = (0, init_1.lintInitGenerator)(tree, {
-        linter: options.linter,
+    const tasks = [];
+    const initTask = (0, init_1.lintInitGenerator)(tree, {
+        skipPackageJson: options.skipPackageJson,
+    });
+    tasks.push(initTask);
+    const rootEsLintTask = (0, setup_root_eslint_1.setupRootEsLint)(tree, {
         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 === '.') {
@@ -66,7 +72,7 @@ async function lintProjectGenerator(tree, options) {
                     filteredProjects.push(project);
                 }
             });
-            (0, init_migration_1.migrateConfigToMonorepoStyle)(filteredProjects, tree, options.unitTestRunner);
+            (0, init_migration_1.migrateConfigToMonorepoStyle)(filteredProjects, tree, options.unitTestRunner, options.keepExistingVersions);
         }
     }
     // our root `.eslintrc` is already the project config, so we should not override it
@@ -89,7 +95,7 @@ async function lintProjectGenerator(tree, options) {
     if (!options.skipFormat) {
         await (0, devkit_1.formatFiles)(tree);
     }
-    return installTask;
+    return (0, devkit_1.runTasksInSerial)(...tasks);
 }
 exports.lintProjectGenerator = lintProjectGenerator;
 function createEsLintConfiguration(tree, projectConfig, setParserOptionsProject, rootProject) {

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

@@ -0,0 +1,7 @@
+import { type GeneratorCallback, type Tree } from '@nx/devkit';
+export type SetupRootEsLintOptions = {
+    unitTestRunner?: string;
+    skipPackageJson?: boolean;
+    rootProject?: boolean;
+};
+export declare function setupRootEsLint(tree: Tree, options: SetupRootEsLintOptions): GeneratorCallback;

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

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupRootEsLint = void 0;
+const devkit_1 = require("@nx/devkit");
+const versions_1 = require("../../utils/versions");
+const global_eslint_config_1 = require("../init/global-eslint-config");
+const eslint_file_1 = require("../utils/eslint-file");
+function setupRootEsLint(tree, options) {
+    const rootEslintFile = (0, eslint_file_1.findEslintFile)(tree);
+    if (rootEslintFile) {
+        return () => { };
+    }
+    (0, devkit_1.writeJson)(tree, '.eslintrc.json', (0, global_eslint_config_1.getGlobalEsLintConfiguration)(options.unitTestRunner, options.rootProject));
+    if (tree.exists('.eslintignore')) {
+        let content = tree.read('.eslintignore', 'utf-8');
+        if (!/^node_modules$/gm.test(content)) {
+            content = `${content}\nnode_modules\n`;
+            tree.write('.eslintignore', content);
+        }
+    }
+    else {
+        tree.write('.eslintignore', 'node_modules\n');
+    }
+    return !options.skipPackageJson
+        ? (0, devkit_1.addDependenciesToPackageJson)(tree, {}, {
+            '@nx/eslint-plugin': versions_1.nxVersion,
+            '@typescript-eslint/parser': versions_1.typescriptESLintVersion,
+            '@typescript-eslint/eslint-plugin': versions_1.typescriptESLintVersion,
+            'eslint-config-prettier': versions_1.eslintConfigPrettierVersion,
+        })
+        : () => { };
+}
+exports.setupRootEsLint = setupRootEsLint;