fix(core): don't set legacy-peer-deps by default

Changing the value of `legacy-peer-deps` causes npm to install a different graph, which can break builds and the `npm ci` command. Any users who rely on `legacy-peer-deps` should already have it set in an `.npmrc` file, so this should not affect them. It does, however, fix bugs with using `nx` in repos that _don't_ have `legacy-peer-deps` enabled, which is the vast majority of them. Fixes #22066, fixes #29537
nrwl · Jan 23, 2025 · 3dea7e2 · 3dea7e2
1 parent 123602c
commit 3dea7e2
Show file tree

Hide file tree

Showing 18 changed files with 76 additions and 53 deletions.
diff --git a/docs/shared/migration/adding-to-existing-project.md b/docs/shared/migration/adding-to-existing-project.md
@@ -358,7 +358,7 @@ jobs:
         with:
           node-version: 20
           cache: 'npm'
-      - run: npm ci --legacy-peer-deps
+      - run: npm ci
       - uses: nrwl/nx-set-shas@v4
       # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected
       - run: npx nx affected -t lint test build

diff --git a/docs/shared/migration/adding-to-monorepo.md b/docs/shared/migration/adding-to-monorepo.md
@@ -377,7 +377,7 @@ jobs:
         with:
           node-version: 20
           cache: 'npm'
-      - run: npm ci --legacy-peer-deps
+      - run: npm ci
       - uses: nrwl/nx-set-shas@v4
       # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected
       - run: npx nx affected -t lint test build

diff --git a/docs/shared/migration/migration-angular.md b/docs/shared/migration/migration-angular.md
@@ -180,7 +180,7 @@ jobs:
         with:
           node-version: 20
           cache: 'npm'
-      - run: npm ci --legacy-peer-deps
+      - run: npm ci
       - uses: nrwl/nx-set-shas@v4
       # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected
       - run: npx nx affected -t lint test build

diff --git a/docs/shared/tutorials/angular-monorepo.md b/docs/shared/tutorials/angular-monorepo.md
@@ -1303,7 +1303,7 @@ jobs:
         with:
           node-version: 20
           cache: 'npm'
-      - run: npm ci --legacy-peer-deps
+      - run: npm ci
       - uses: nrwl/nx-set-shas@v4
       # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected
       # When you enable task distribution, run the e2e-ci task instead of e2e

diff --git a/docs/shared/tutorials/angular-standalone.md b/docs/shared/tutorials/angular-standalone.md
@@ -1104,7 +1104,7 @@ jobs:
         with:
           node-version: 20
           cache: 'npm'
-      - run: npm ci --legacy-peer-deps
+      - run: npm ci
       - uses: nrwl/nx-set-shas@v4
       # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected
       # When you enable task distribution, run the e2e-ci task instead of e2e

diff --git a/docs/shared/tutorials/react-monorepo.md b/docs/shared/tutorials/react-monorepo.md
@@ -1106,7 +1106,7 @@ jobs:
         with:
           node-version: 20
           cache: 'npm'
-      - run: npm ci --legacy-peer-deps
+      - run: npm ci
       - uses: nrwl/nx-set-shas@v4
       # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected
       # When you enable task distribution, run the e2e-ci task instead of e2e

diff --git a/docs/shared/tutorials/react-standalone.md b/docs/shared/tutorials/react-standalone.md
@@ -1055,7 +1055,7 @@ jobs:
         with:
           node-version: 20
           cache: 'npm'
-      - run: npm ci --legacy-peer-deps
+      - run: npm ci
       - uses: nrwl/nx-set-shas@v4
       # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected
       # When you enable task distribution, run the e2e-ci task instead of e2e

diff --git a/docs/shared/tutorials/typescript-packages.md b/docs/shared/tutorials/typescript-packages.md
@@ -462,7 +462,7 @@ jobs:
         with:
           node-version: 20
           cache: 'npm'
-      - run: npm ci --legacy-peer-deps
+      - run: npm ci
       - uses: nrwl/nx-set-shas@v4
       # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected
       # When you enable task distribution, run the e2e-ci task instead of e2e

diff --git a/docs/shared/tutorials/vue-standalone.md b/docs/shared/tutorials/vue-standalone.md
@@ -1104,7 +1104,7 @@ jobs:
         with:
           node-version: 20
           cache: 'npm'
-      - run: npm ci --legacy-peer-deps
+      - run: npm ci
       - uses: nrwl/nx-set-shas@v4
       # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected
       # When you enable task distribution, run the e2e-ci task instead of e2e

diff --git a/e2e/release/src/lock-file-updates.test.ts b/e2e/release/src/lock-file-updates.test.ts
@@ -1,6 +1,8 @@
 import {
+  checkFilesExist,
   cleanupProject,
   newProject,
+  readJson,
   runCLI,
   runCommand,
   uniq,
@@ -154,6 +156,42 @@ describe('nx release lock file updates', () => {
     `);
   });
 
+  it('should not mess with peer dependencies when package manager is npm', async () => {
+    initializeProject('npm');
+
+    updateJson('package.json', (json) => {
+      json.workspaces = [pkg1, pkg2, pkg3];
+      return json;
+    });
+
+    updateJson(`${pkg1}/package.json`, (json) => {
+      json.peerDependencies = {
+        semver: '^7.3.2',
+      };
+      return json;
+    });
+
+    runCommand(`npm install`);
+
+    // Make sure that the peer dependency was installed, and that the lock file
+    // is up-to-date, otherwise we are testing nothing.
+    checkFilesExist('node_modules/semver/package.json');
+    runCommand('npm ci', { failOnError: true });
+
+    // workaround for NXC-143
+    runCLI('reset');
+
+    runCommand(`git add .`);
+    runCommand(`git commit -m "chore: initial commit"`);
+
+    runCLI(`release version 999.9.9`);
+
+    // Make sure that the lock file is still valid, and that the peer dependency
+    // was not removed.
+    runCommand('npm ci', { failOnError: true });
+    checkFilesExist('node_modules/semver/package.json');
+  });
+
   it('should not update lock file when package manager is yarn classic', async () => {
     initializeProject('yarn');
 

diff --git a/e2e/utils/command-utils.ts b/e2e/utils/command-utils.ts
@@ -131,8 +131,8 @@ export function getPackageManagerCommand({
       runUninstalledPackage: `npx --yes`,
       install: 'npm install',
       ciInstall: 'npm ci',
-      addProd: `npm install --legacy-peer-deps`,
-      addDev: `npm install --legacy-peer-deps -D`,
+      addProd: `npm install`,
+      addDev: `npm install -D`,
       list: 'npm ls --depth 10',
       runLerna: `npx lerna`,
     },

diff --git a/packages/angular/src/generators/ngrx-feature-store/lib/add-ngrx-to-package-json.ts b/packages/angular/src/generators/ngrx-feature-store/lib/add-ngrx-to-package-json.ts
@@ -13,8 +13,6 @@ export function addNgRxToPackageJson(
     : '~0.8.3';
   const ngrxVersion = versions(tree).ngrxVersion;
 
-  process.env.npm_config_legacy_peer_deps ??= 'true';
-
   return addDependenciesToPackageJson(
     tree,
     {

diff --git a/packages/angular/src/generators/ngrx-root-store/lib/add-ngrx-to-package-json.ts b/packages/angular/src/generators/ngrx-root-store/lib/add-ngrx-to-package-json.ts
@@ -13,8 +13,6 @@ export function addNgRxToPackageJson(
     : '~0.8.3';
   const ngrxVersion = versions(tree).ngrxVersion;
 
-  process.env.npm_config_legacy_peer_deps ??= 'true';
-
   return addDependenciesToPackageJson(
     tree,
     {

diff --git a/packages/angular/src/generators/ngrx/lib/add-ngrx-to-package-json.ts b/packages/angular/src/generators/ngrx/lib/add-ngrx-to-package-json.ts
@@ -13,8 +13,6 @@ export function addNgRxToPackageJson(
     : '~0.8.3';
   const ngrxVersion = versions(tree).ngrxVersion;
 
-  process.env.npm_config_legacy_peer_deps ??= 'true';
-
   return addDependenciesToPackageJson(
     tree,
     {

diff --git a/packages/angular/src/generators/utils/add-jest.ts b/packages/angular/src/generators/utils/add-jest.ts
@@ -18,8 +18,6 @@ export async function addJest(
   options: AddJestOptions
 ): Promise<void> {
   if (!options.skipPackageJson) {
-    process.env.npm_config_legacy_peer_deps ??= 'true';
-
     addDependenciesToPackageJson(
       tree,
       {},

diff --git a/packages/nx/src/command-line/migrate/migrate.ts b/packages/nx/src/command-line/migrate/migrate.ts
@@ -1382,10 +1382,6 @@ function showConnectToCloudMessage() {
 function runInstall() {
   const pmCommands = getPackageManagerCommand();
 
-  // TODO: remove this
-  if (detectPackageManager() === 'npm') {
-    process.env.npm_config_legacy_peer_deps ??= 'true';
-  }
   output.log({
     title: `Running '${pmCommands.install}' to make sure necessary packages are installed`,
   });

diff --git a/packages/nx/src/utils/package-manager.ts b/packages/nx/src/utils/package-manager.ts
@@ -166,12 +166,9 @@ export function getPackageManagerCommand(
       };
     },
     npm: () => {
-      // TODO: Remove this
-      process.env.npm_config_legacy_peer_deps ??= 'true';
-
       return {
         install: 'npm install',
-        ciInstall: 'npm ci --legacy-peer-deps',
+        ciInstall: 'npm ci',
         updateLockFile: 'npm install --package-lock-only',
         add: 'npm install',
         addDev: 'npm install -D',