Move onlyBuiltDependencies to package.json instead of pnpm-workspace.yaml

Copilot · iclanton · Copilot · commit e861ea4c9929 · 2025-12-28T19:29:08.000Z
Co-authored-by: iclanton &lt;5010588+iclanton@users.noreply.github.com&gt;
diff --git a/libraries/rush-lib/src/logic/installManager/InstallHelpers.ts b/libraries/rush-lib/src/logic/installManager/InstallHelpers.ts
@@ -31,6 +31,7 @@ interface ICommonPackageJson extends IPackageJson {
     packageExtensions?: typeof PnpmOptionsConfiguration.prototype.globalPackageExtensions;
     peerDependencyRules?: typeof PnpmOptionsConfiguration.prototype.globalPeerDependencyRules;
     neverBuiltDependencies?: typeof PnpmOptionsConfiguration.prototype.globalNeverBuiltDependencies;
+    onlyBuiltDependencies?: typeof PnpmOptionsConfiguration.prototype.globalOnlyBuiltDependencies;
     ignoredOptionalDependencies?: typeof PnpmOptionsConfiguration.prototype.globalIgnoredOptionalDependencies;
     allowedDeprecatedVersions?: typeof PnpmOptionsConfiguration.prototype.globalAllowedDeprecatedVersions;
     patchedDependencies?: typeof PnpmOptionsConfiguration.prototype.globalPatchedDependencies;
@@ -76,6 +77,24 @@ export class InstallHelpers {
         commonPackageJson.pnpm.neverBuiltDependencies = pnpmOptions.globalNeverBuiltDependencies;
       }
 
+      if (pnpmOptions.globalOnlyBuiltDependencies) {
+        if (
+          rushConfiguration.rushConfigurationJson.pnpmVersion !== undefined &&
+          semver.lt(rushConfiguration.rushConfigurationJson.pnpmVersion, '10.1.0')
+        ) {
+          terminal.writeWarningLine(
+            Colorize.yellow(
+              `Your version of pnpm (${rushConfiguration.rushConfigurationJson.pnpmVersion}) ` +
+                `doesn't support the "globalOnlyBuiltDependencies" field in ` +
+                `${rushConfiguration.commonRushConfigFolder}/${RushConstants.pnpmConfigFilename}. ` +
+                'Remove this field or upgrade to pnpm 10.1.0 or newer.'
+            )
+          );
+        }
+
+        commonPackageJson.pnpm.onlyBuiltDependencies = pnpmOptions.globalOnlyBuiltDependencies;
+      }
+
       if (pnpmOptions.globalIgnoredOptionalDependencies) {
         if (
           rushConfiguration.rushConfigurationJson.pnpmVersion !== undefined &&
diff --git a/libraries/rush-lib/src/logic/installManager/WorkspaceInstallManager.ts b/libraries/rush-lib/src/logic/installManager/WorkspaceInstallManager.ts
@@ -468,25 +468,6 @@ export class WorkspaceInstallManager extends BaseInstallManager {
       workspaceFile.setCatalogs(catalogs);
     }
 
-    // Set onlyBuiltDependencies in the workspace file if specified
-    if (pnpmOptions.globalOnlyBuiltDependencies) {
-      if (
-        this.rushConfiguration.rushConfigurationJson.pnpmVersion !== undefined &&
-        semver.lt(this.rushConfiguration.rushConfigurationJson.pnpmVersion, '10.1.0')
-      ) {
-        this._terminal.writeWarningLine(
-          Colorize.yellow(
-            `Your version of pnpm (${this.rushConfiguration.rushConfigurationJson.pnpmVersion}) ` +
-              `doesn't support the "globalOnlyBuiltDependencies" field in ` +
-              `${this.rushConfiguration.commonRushConfigFolder}/${RushConstants.pnpmConfigFilename}. ` +
-              'Remove this field or upgrade to pnpm 10.1.0 or newer.'
-          )
-        );
-      }
-
-      workspaceFile.setOnlyBuiltDependencies(pnpmOptions.globalOnlyBuiltDependencies);
-    }
-
     // Save the generated workspace file. Don't update the file timestamp unless the content has changed,
     // since "rush install" will consider this timestamp
     workspaceFile.save(workspaceFile.workspaceFilename, { onlyIfChanged: true });
diff --git a/libraries/rush-lib/src/logic/pnpm/PnpmOptionsConfiguration.ts b/libraries/rush-lib/src/logic/pnpm/PnpmOptionsConfiguration.ts
@@ -374,12 +374,12 @@ export class PnpmOptionsConfiguration extends PackageManagerOptionsConfiguration
    * to run build scripts (`preinstall`, `install`, and `postinstall` lifecycle events). This is the inverse
    * of `globalNeverBuiltDependencies`. In PNPM 10.x, build scripts are disabled by default for security,
    * so this setting is required to explicitly permit specific packages to run their build scripts.
-   * The settings are written to the `onlyBuiltDependencies` field of the `pnpm-workspace.yaml` file
-   * that is generated by Rush during installation.
+   * The settings are copied into the `pnpm.onlyBuiltDependencies` field of the `common/temp/package.json`
+   * file that is generated by Rush during installation.
    *
    * (SUPPORTED ONLY IN PNPM 10.1.0 AND NEWER)
    *
-   * PNPM documentation: https://pnpm.io/settings#onlybuiltdependencies
+   * PNPM documentation: https://pnpm.io/package_json#pnpmonlybuiltdependencies
    */
   public readonly globalOnlyBuiltDependencies: string[] | undefined;
 
diff --git a/libraries/rush-lib/src/logic/pnpm/PnpmWorkspaceFile.ts b/libraries/rush-lib/src/logic/pnpm/PnpmWorkspaceFile.ts
@@ -23,20 +23,14 @@ const globEscape: (unescaped: string) => string = require('glob-escape'); // No
  *      "default": {
  *        "react": "^18.0.0"
  *      }
- *    },
- *    "onlyBuiltDependencies": [
- *      "esbuild",
- *      "playwright"
- *    ]
+ *    }
  *  }
  */
 interface IPnpmWorkspaceYaml {
   /** The list of local package directories */
   packages: string[];
   /** Catalog definitions for centralized version management */
   catalogs?: Record<string, Record<string, string>>;
-  /** Allowlist of dependencies permitted to run build scripts (PNPM 10.1.0+) */
-  onlyBuiltDependencies?: string[];
 }
 
 export class PnpmWorkspaceFile extends BaseWorkspaceFile {
@@ -47,7 +41,6 @@ export class PnpmWorkspaceFile extends BaseWorkspaceFile {
 
   private _workspacePackages: Set<string>;
   private _catalogs: Record<string, Record<string, string>> | undefined;
-  private _onlyBuiltDependencies: string[] | undefined;
 
   /**
    * The PNPM workspace file is used to specify the location of workspaces relative to the root
@@ -61,7 +54,6 @@ export class PnpmWorkspaceFile extends BaseWorkspaceFile {
     // If we need to support manual customization, that should be an additional parameter for "base file"
     this._workspacePackages = new Set<string>();
     this._catalogs = undefined;
-    this._onlyBuiltDependencies = undefined;
   }
 
   /**
@@ -72,15 +64,6 @@ export class PnpmWorkspaceFile extends BaseWorkspaceFile {
     this._catalogs = catalogs;
   }
 
-  /**
-   * Sets the onlyBuiltDependencies list for the workspace.
-   * This specifies which dependencies are allowed to run build scripts in PNPM 10.1.0+.
-   * @param deps - An array of package names allowed to run build scripts
-   */
-  public setOnlyBuiltDependencies(deps: string[] | undefined): void {
-    this._onlyBuiltDependencies = deps;
-  }
-
   /** @override */
   public addPackage(packagePath: string): void {
     // Ensure the path is relative to the pnpm-workspace.yaml file
@@ -106,10 +89,6 @@ export class PnpmWorkspaceFile extends BaseWorkspaceFile {
       workspaceYaml.catalogs = this._catalogs;
     }
 
-    if (this._onlyBuiltDependencies && this._onlyBuiltDependencies.length > 0) {
-      workspaceYaml.onlyBuiltDependencies = this._onlyBuiltDependencies;
-    }
-
     return yamlModule.dump(workspaceYaml, PNPM_SHRINKWRAP_YAML_FORMAT);
   }
 }
diff --git a/libraries/rush-lib/src/logic/pnpm/test/PnpmWorkspaceFile.test.ts b/libraries/rush-lib/src/logic/pnpm/test/PnpmWorkspaceFile.test.ts
@@ -180,61 +180,4 @@ describe(PnpmWorkspaceFile.name, () => {
       expect(content).toMatchSnapshot();
     });
   });
-
-  describe('onlyBuiltDependencies functionality', () => {
-    it('generates workspace file with onlyBuiltDependencies', () => {
-      const workspaceFile: PnpmWorkspaceFile = new PnpmWorkspaceFile(workspaceFilePath);
-      workspaceFile.addPackage(path.join(projectsDir, 'app1'));
-
-      workspaceFile.setOnlyBuiltDependencies(['esbuild', 'playwright', '@swc/core']);
-
-      workspaceFile.save(workspaceFilePath, { onlyIfChanged: true });
-
-      const content: string = FileSystem.readFile(workspaceFilePath);
-      expect(content).toMatchSnapshot();
-    });
-
-    it('handles empty onlyBuiltDependencies array', () => {
-      const workspaceFile: PnpmWorkspaceFile = new PnpmWorkspaceFile(workspaceFilePath);
-      workspaceFile.addPackage(path.join(projectsDir, 'app1'));
-
-      workspaceFile.setOnlyBuiltDependencies([]);
-
-      workspaceFile.save(workspaceFilePath, { onlyIfChanged: true });
-
-      const content: string = FileSystem.readFile(workspaceFilePath);
-      expect(content).toMatchSnapshot();
-    });
-
-    it('handles undefined onlyBuiltDependencies', () => {
-      const workspaceFile: PnpmWorkspaceFile = new PnpmWorkspaceFile(workspaceFilePath);
-      workspaceFile.addPackage(path.join(projectsDir, 'app1'));
-
-      workspaceFile.setOnlyBuiltDependencies(undefined);
-
-      workspaceFile.save(workspaceFilePath, { onlyIfChanged: true });
-
-      const content: string = FileSystem.readFile(workspaceFilePath);
-      expect(content).toMatchSnapshot();
-    });
-
-    it('generates workspace file with both catalogs and onlyBuiltDependencies', () => {
-      const workspaceFile: PnpmWorkspaceFile = new PnpmWorkspaceFile(workspaceFilePath);
-      workspaceFile.addPackage(path.join(projectsDir, 'app1'));
-
-      workspaceFile.setCatalogs({
-        default: {
-          react: '^18.0.0',
-          'react-dom': '^18.0.0'
-        }
-      });
-
-      workspaceFile.setOnlyBuiltDependencies(['esbuild', 'playwright']);
-
-      workspaceFile.save(workspaceFilePath, { onlyIfChanged: true });
-
-      const content: string = FileSystem.readFile(workspaceFilePath);
-      expect(content).toMatchSnapshot();
-    });
-  });
 });
diff --git a/libraries/rush-lib/src/logic/pnpm/test/__snapshots__/PnpmWorkspaceFile.test.ts.snap b/libraries/rush-lib/src/logic/pnpm/test/__snapshots__/PnpmWorkspaceFile.test.ts.snap
@@ -65,38 +65,3 @@ exports[`PnpmWorkspaceFile catalog functionality handles undefined catalog 1`] =
   - projects/app1
 "
 `;
-
-exports[`PnpmWorkspaceFile onlyBuiltDependencies functionality generates workspace file with both catalogs and onlyBuiltDependencies 1`] = `
-"catalogs:
-  default:
-    react: ^18.0.0
-    react-dom: ^18.0.0
-onlyBuiltDependencies:
-  - esbuild
-  - playwright
-packages:
-  - projects/app1
-"
-`;
-
-exports[`PnpmWorkspaceFile onlyBuiltDependencies functionality generates workspace file with onlyBuiltDependencies 1`] = `
-"onlyBuiltDependencies:
-  - esbuild
-  - playwright
-  - '@swc/core'
-packages:
-  - projects/app1
-"
-`;
-
-exports[`PnpmWorkspaceFile onlyBuiltDependencies functionality handles empty onlyBuiltDependencies array 1`] = `
-"packages:
-  - projects/app1
-"
-`;
-
-exports[`PnpmWorkspaceFile onlyBuiltDependencies functionality handles undefined onlyBuiltDependencies 1`] = `
-"packages:
-  - projects/app1
-"
-`;
diff --git a/libraries/rush-lib/src/logic/test/InstallHelpers.test.ts b/libraries/rush-lib/src/logic/test/InstallHelpers.test.ts
@@ -67,6 +67,7 @@ describe('InstallHelpers', () => {
               }
             },
             neverBuiltDependencies: ['fsevents', 'level'],
+            onlyBuiltDependencies: ['esbuild', 'playwright'],
             pnpmFutureFeature: true
           }
         })
diff --git a/libraries/rush-lib/src/logic/test/pnpmConfig/common/config/rush/pnpm-config.json b/libraries/rush-lib/src/logic/test/pnpmConfig/common/config/rush/pnpm-config.json
@@ -13,6 +13,7 @@
     }
   },
   "globalNeverBuiltDependencies": ["fsevents", "level"],
+  "globalOnlyBuiltDependencies": ["esbuild", "playwright"],
   "globalCatalogs": {
     "default": {
       "react": "^18.0.0",

Original file line number	Diff line number	Diff line change
`@@ -67,6 +67,7 @@ describe('InstallHelpers', () => {`
`67`	`67`	`}`
`68`	`68`	`},`
`69`	`69`	`neverBuiltDependencies: ['fsevents', 'level'],`
	`70`	`+ onlyBuiltDependencies: ['esbuild', 'playwright'],`
`70`	`71`	`pnpmFutureFeature: true`
`71`	`72`	`}`
`72`	`73`	`})`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`	`}`
`14`	`14`	`},`
`15`	`15`	`"globalNeverBuiltDependencies": ["fsevents", "level"],`
	`16`	`+ "globalOnlyBuiltDependencies": ["esbuild", "playwright"],`
`16`	`17`	`"globalCatalogs": {`
`17`	`18`	`"default": {`
`18`	`19`	`"react": "^18.0.0",`