Support fallback syntax in .npmrc file (#5030)

* Support fallback syntax in .npmrc file

* Simplify diff.

* Simplify tests.

* More minor cleanup.

* fixup! More minor cleanup.

* Add isPnpm property.

* Only support fallback for pnpm.

* Rush change.

---------

Co-authored-by: Ian Clanton-Thuon <[email protected]>

Author: fzxen

common/changes/@microsoft/rush/feature-support_fallback_syntax_in_npmrc_2024-12-04-13-22.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "Support fallback syntax in `.npmrc` files if the package manager is PNPM. See https://pnpm.io/npmrc",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush"
+}

common/changes/@microsoft/rush/feature-support_fallback_syntax_in_npmrc_2024-12-10-20-47.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "Add an `.isPnpm` property to `RushConfiguration` that is set to true if the package manager for the Rush repo is PNPM.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush"
+}

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

@@ -1222,6 +1222,7 @@ export class RushConfiguration {
     readonly gitTagSeparator: string | undefined;
     readonly gitVersionBumpCommitMessage: string | undefined;
     readonly hotfixChangeEnabled: boolean;
+    readonly isPnpm: boolean;
     static loadFromConfigurationFile(rushJsonFilename: string): RushConfiguration;
     // (undocumented)
     static loadFromDefaultLocation(options?: ITryFindRushJsonLocationOptions): RushConfiguration;

libraries/rush-lib/src/api/RushConfiguration.ts

@@ -251,6 +251,11 @@ export class RushConfiguration {
    */
   public readonly packageManager!: PackageManagerName;
 
+  /**
+   * If true, the repository is using PNPM as its package manager.
+   */
+  public readonly isPnpm!: boolean;
+
   /**
    * {@inheritdoc PackageManager}
    *
@@ -698,16 +703,20 @@ export class RushConfiguration {
     // TODO: Add an actual "packageManager" field in rush.json
     const packageManagerFields: string[] = [];
 
+    this.isPnpm = false;
     if (rushConfigurationJson.npmVersion) {
       this.packageManager = 'npm';
       this.packageManagerOptions = this.npmOptions;
       packageManagerFields.push('npmVersion');
     }
+
     if (rushConfigurationJson.pnpmVersion) {
       this.packageManager = 'pnpm';
+      this.isPnpm = true;
       this.packageManagerOptions = this.pnpmOptions;
       packageManagerFields.push('pnpmVersion');
     }
+
     if (rushConfigurationJson.yarnVersion) {
       this.packageManager = 'yarn';
       this.packageManagerOptions = this.yarnOptions;

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

@@ -224,7 +224,7 @@ export class RushXCommandLine {
     });
     const terminal: ITerminal = new Terminal(terminalProvider);
 
-    if (rushConfiguration?.packageManager === 'pnpm' && rushConfiguration?.experimentsConfiguration) {
+    if (rushConfiguration?.isPnpm && rushConfiguration?.experimentsConfiguration) {
       const { configuration: experiments } = rushConfiguration?.experimentsConfiguration;
 
       if (experiments?.usePnpmSyncForInjectedDependencies) {

libraries/rush-lib/src/cli/actions/DeployAction.ts

@@ -159,7 +159,7 @@ export class DeployAction extends BaseRushAction {
     }
 
     const projects: RushConfigurationProject[] = this.rushConfiguration.projects;
-    if (this.rushConfiguration.packageManager === 'pnpm') {
+    if (this.rushConfiguration.isPnpm) {
       const currentlyInstalledVariant: string | undefined =
         await this.rushConfiguration.getCurrentlyInstalledVariantAsync();
       for (const project of projects) {

libraries/rush-lib/src/cli/actions/InstallAction.ts

@@ -49,7 +49,7 @@ export class InstallAction extends BaseInstallAction {
       description: `Only check the validity of the shrinkwrap file without performing an install.`
     });
 
-    if (this.rushConfiguration?.packageManager === 'pnpm') {
+    if (this.rushConfiguration?.isPnpm) {
       this._resolutionOnlyParameter = this.defineFlagParameter({
         parameterLongName: '--resolution-only',
         description: `Only perform dependency resolution, useful for ensuring peer dependendencies are up to date. Note that this flag is only supported when using the pnpm package manager.`

libraries/rush-lib/src/cli/actions/PublishAction.ts

@@ -239,7 +239,7 @@ export class PublishAction extends BaseRushAction {
 
     this._validate();
 
-    this._addNpmPublishHome();
+    this._addNpmPublishHome(this.rushConfiguration.isPnpm);
 
     const git: Git = new Git(this.rushConfiguration);
     const publishGit: PublishGit = new PublishGit(git, this._targetBranch.value);
@@ -455,7 +455,7 @@ export class PublishAction extends BaseRushAction {
         args.push(`--access`, this._npmAccessLevel.value);
       }
 
-      if (this.rushConfiguration.packageManager === 'pnpm') {
+      if (this.rushConfiguration.isPnpm) {
         // PNPM 4.11.0 introduced a feature that may interrupt publishing and prompt the user for input.
         // See this issue for details: https://github.com/microsoft/rushstack/issues/1940
         args.push('--no-git-checks');
@@ -582,15 +582,16 @@ export class PublishAction extends BaseRushAction {
     }
   }
 
-  private _addNpmPublishHome(): void {
+  private _addNpmPublishHome(supportEnvVarFallbackSyntax: boolean): void {
     // Create "common\temp\publish-home" folder, if it doesn't exist
     Utilities.createFolderWithRetry(this._targetNpmrcPublishFolder);
 
     // Copy down the committed "common\config\rush\.npmrc-publish" file, if there is one
     Utilities.syncNpmrc({
       sourceNpmrcFolder: this.rushConfiguration.commonRushConfigFolder,
       targetNpmrcFolder: this._targetNpmrcPublishFolder,
-      useNpmrcPublish: true
+      useNpmrcPublish: true,
+      supportEnvVarFallbackSyntax
     });
   }
 

libraries/rush-lib/src/cli/scriptActions/PhasedScriptAction.ts

@@ -466,10 +466,7 @@ export class PhasedScriptAction extends BaseScriptAction<IPhasedCommandConfig> {
       }
 
       const { configuration: experiments } = this.rushConfiguration.experimentsConfiguration;
-      if (
-        this.rushConfiguration?.packageManager === 'pnpm' &&
-        experiments?.usePnpmSyncForInjectedDependencies
-      ) {
+      if (this.rushConfiguration?.isPnpm && experiments?.usePnpmSyncForInjectedDependencies) {
         const { PnpmSyncCopyOperationPlugin } = await import(
           '../../logic/operations/PnpmSyncCopyOperationPlugin'
         );

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

@@ -137,7 +137,8 @@ export class Autoinstaller {
         // Copy: .../common/autoinstallers/my-task/.npmrc
         Utilities.syncNpmrc({
           sourceNpmrcFolder: this._rushConfiguration.commonRushConfigFolder,
-          targetNpmrcFolder: autoinstallerFullPath
+          targetNpmrcFolder: autoinstallerFullPath,
+          supportEnvVarFallbackSyntax: this._rushConfiguration.isPnpm
         });
 
         this._logIfConsoleOutputIsNotRestricted(
@@ -193,7 +194,7 @@ export class Autoinstaller {
       oldFileContents = FileSystem.readFile(this.shrinkwrapFilePath, { convertLineEndings: NewlineKind.Lf });
       this._logIfConsoleOutputIsNotRestricted('Deleting ' + this.shrinkwrapFilePath);
       await FileSystem.deleteFileAsync(this.shrinkwrapFilePath);
-      if (this._rushConfiguration.packageManager === 'pnpm') {
+      if (this._rushConfiguration.isPnpm) {
         // Workaround for https://github.com/pnpm/pnpm/issues/1890
         //
         // When "rush update-autoinstaller" is run, Rush deletes "common/autoinstallers/my-task/pnpm-lock.yaml"
@@ -222,7 +223,8 @@ export class Autoinstaller {
 
     Utilities.syncNpmrc({
       sourceNpmrcFolder: this._rushConfiguration.commonRushConfigFolder,
-      targetNpmrcFolder: this.folderFullPath
+      targetNpmrcFolder: this.folderFullPath,
+      supportEnvVarFallbackSyntax: this._rushConfiguration.isPnpm
     });
 
     await Utilities.executeCommandAsync({