Create a pnpmWorkspaceFileName constant.

Author: iclanton

common/reviews/api/rush-lib.api.md

@@ -1574,6 +1574,7 @@ export class RushConstants {
     static readonly pnpmSyncFilename: '.pnpm-sync.json';
     static readonly pnpmV3ShrinkwrapFilename: 'pnpm-lock.yaml';
     static readonly pnpmVirtualStoreFolderName: '.pnpm';
+    static readonly pnpmWorkspaceFileName: 'pnpm-workspace.yaml';
     static readonly projectImpactGraphFilename: 'project-impact-graph.yaml';
     static readonly projectRushFolderName: '.rush';
     static readonly projectShrinkwrapFilename: 'shrinkwrap-deps.json';

libraries/rush-lib/src/cli/RushPnpmCommandLineParser.ts

@@ -166,7 +166,7 @@ export class RushPnpmCommandLineParser {
     this._subspace = subspace;
 
     const workspaceFolder: string = subspace.getSubspaceTempFolderPath();
-    const workspaceFilePath: string = path.join(workspaceFolder, 'pnpm-workspace.yaml');
+    const workspaceFilePath: string = `${workspaceFolder}/${RushConstants.pnpmWorkspaceFileName}`;
 
     if (!FileSystem.exists(workspaceFilePath)) {
       this._terminal.writeErrorLine('Error: The PNPM workspace file has not been generated:');
@@ -546,7 +546,7 @@ export class RushPnpmCommandLineParser {
         if (semver.gte(pnpmVersion, '11.0.0')) {
           // PNPM 11+ stores patchedDependencies in pnpm-workspace.yaml instead of the package.json "pnpm" field
           newGlobalPatchedDependencies = await PnpmWorkspaceFile.loadPatchedDependenciesAsync(
-            `${subspaceTempFolder}/pnpm-workspace.yaml`
+            `${subspaceTempFolder}/${RushConstants.pnpmWorkspaceFileName}`
           );
         } else {
           // PNPM 10.x and earlier store patchedDependencies in the package.json "pnpm" field
@@ -612,7 +612,7 @@ export class RushPnpmCommandLineParser {
 
         if (semver.gte(pnpmVersion, '11.0.0')) {
           // PNPM 11+ uses allowBuilds in pnpm-workspace.yaml instead of onlyBuiltDependencies in package.json
-          const workspaceYamlFilename: string = `${subspaceTempFolder}/pnpm-workspace.yaml`;
+          const workspaceYamlFilename: string = `${subspaceTempFolder}/${RushConstants.pnpmWorkspaceFileName}`;
           const yamlModule: typeof import('js-yaml') = await import('js-yaml');
           const workspaceYamlContent: string = await FileSystem.readFileAsync(workspaceYamlFilename);
           const workspaceYaml: { allowBuilds?: Record<string, boolean> } = (yamlModule.load(

libraries/rush-lib/src/logic/RushConstants.ts

@@ -369,4 +369,9 @@ export class RushConstants {
    * The filename ("pnpm-sync.json") used to store the state of the pnpm sync command.
    */
   public static readonly pnpmSyncFilename: '.pnpm-sync.json' = '.pnpm-sync.json';
+
+  /**
+   * The filename ("pnpm-workspace.yaml") used to store the state of the pnpm workspace configuration.
+   */
+  public static readonly pnpmWorkspaceFileName: 'pnpm-workspace.yaml' = 'pnpm-workspace.yaml';
 }

libraries/rush-lib/src/logic/installManager/InstallHelpers.ts

@@ -316,7 +316,7 @@ export class InstallHelpers {
     // Populate a PnpmWorkspaceFile with the workspace settings. The caller adds the workspace
     // packages to this file and saves it; here we only set the pnpm settings.
     const workspaceFile: PnpmWorkspaceFile = new PnpmWorkspaceFile(
-      `${subspace.getSubspaceTempFolderPath()}/pnpm-workspace.yaml`
+      `${subspace.getSubspaceTempFolderPath()}/${RushConstants.pnpmWorkspaceFileName}`
     );
     workspaceFile.catalogs = globalCatalogs;
     workspaceFile.allowBuilds = allowBuilds;

libraries/rush-lib/src/logic/installManager/WorkspaceInstallManager.ts

@@ -465,10 +465,7 @@ export class WorkspaceInstallManager extends BaseInstallManager {
 
     if (this.rushConfiguration.isPnpm) {
       // Add workspace file. This file is only modified when workspace packages change.
-      const pnpmWorkspaceFilename: string = path.join(
-        subspace.getSubspaceTempFolderPath(),
-        'pnpm-workspace.yaml'
-      );
+      const pnpmWorkspaceFilename: string = `${subspace.getSubspaceTempFolderPath()}/${RushConstants.pnpmWorkspaceFileName}`;
 
       if (FileSystem.exists(pnpmWorkspaceFilename)) {
         potentiallyChangedFiles.push(pnpmWorkspaceFilename);