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]>
microsoft · Dec 10, 2024 · ae62698 · ae62698
1 parent 3f9aa73
commit ae62698
Show file tree

Hide file tree

Showing 26 changed files with 481 additions and 78 deletions.
diff --git a/...on/changes/@microsoft/rush/feature-support_fallback_syntax_in_npmrc_2024-12-04-13-22.json b/...on/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"
+}
diff --git a/...on/changes/@microsoft/rush/feature-support_fallback_syntax_in_npmrc_2024-12-10-20-47.json b/...on/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"
+}
diff --git a/common/reviews/api/rush-lib.api.md b/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;

diff --git a/libraries/rush-lib/src/api/RushConfiguration.ts b/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;

diff --git a/libraries/rush-lib/src/cli/RushXCommandLine.ts b/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) {

diff --git a/libraries/rush-lib/src/cli/actions/DeployAction.ts b/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) {

diff --git a/libraries/rush-lib/src/cli/actions/InstallAction.ts b/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.`

diff --git a/libraries/rush-lib/src/cli/actions/PublishAction.ts b/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
     });
   }
 

diff --git a/libraries/rush-lib/src/cli/scriptActions/PhasedScriptAction.ts b/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'
         );

diff --git a/libraries/rush-lib/src/logic/Autoinstaller.ts b/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({

diff --git a/libraries/rush-lib/src/logic/InstallManagerFactory.ts b/libraries/rush-lib/src/logic/InstallManagerFactory.ts
@@ -17,7 +17,7 @@ export class InstallManagerFactory {
     options: IInstallManagerOptions
   ): Promise<BaseInstallManager> {
     if (
-      rushConfiguration.packageManager === 'pnpm' &&
+      rushConfiguration.isPnpm &&
       rushConfiguration.pnpmOptions &&
       rushConfiguration.pnpmOptions.useWorkspaces
     ) {

diff --git a/libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts b/libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts
@@ -149,9 +149,7 @@ export class ProjectChangeAnalyzer {
           return new Set(rushConfiguration.projects);
         }
 
-        const { packageManager } = rushConfiguration;
-
-        if (packageManager === 'pnpm') {
+        if (rushConfiguration.isPnpm) {
           const currentShrinkwrap: PnpmShrinkwrapFile | undefined =
             PnpmShrinkwrapFile.loadFromFile(fullShrinkwrapPath);
 
@@ -256,7 +254,7 @@ export class ProjectChangeAnalyzer {
       // Include project shrinkwrap files as part of the computation
       const additionalRelativePathsToHash: string[] = [];
       const globalAdditionalFiles: string[] = [];
-      if (rushConfiguration.packageManager === 'pnpm') {
+      if (rushConfiguration.isPnpm) {
         await Async.forEachAsync(rushConfiguration.projects, async (project: RushConfigurationProject) => {
           const projectShrinkwrapFilePath: string = BaseProjectShrinkwrapFile.getFilePathForProject(project);
           if (!(await FileSystem.existsAsync(projectShrinkwrapFilePath))) {

diff --git a/libraries/rush-lib/src/logic/PurgeManager.ts b/libraries/rush-lib/src/logic/PurgeManager.ts
@@ -88,7 +88,7 @@ export class PurgeManager {
     );
 
     if (
-      this._rushConfiguration.packageManager === 'pnpm' &&
+      this._rushConfiguration.isPnpm &&
       this._rushConfiguration.pnpmOptions.pnpmStore === 'global' &&
       this._rushConfiguration.pnpmOptions.pnpmStorePath
     ) {

diff --git a/libraries/rush-lib/src/logic/RepoStateFile.ts b/libraries/rush-lib/src/logic/RepoStateFile.ts
@@ -162,7 +162,7 @@ export class RepoStateFile {
 
     // Only support saving the pnpm shrinkwrap hash if it was enabled
     const preventShrinkwrapChanges: boolean =
-      rushConfiguration.packageManager === 'pnpm' &&
+      rushConfiguration.isPnpm &&
       rushConfiguration.pnpmOptions &&
       rushConfiguration.pnpmOptions.preventManualShrinkwrapChanges;
     if (preventShrinkwrapChanges) {
@@ -200,7 +200,7 @@ export class RepoStateFile {
       this._modified = true;
     }
 
-    if (rushConfiguration.packageManager === 'pnpm' && rushConfiguration.subspacesFeatureEnabled) {
+    if (rushConfiguration.isPnpm && rushConfiguration.subspacesFeatureEnabled) {
       const packageJsonInjectedDependenciesHash: string | undefined =
         subspace.getPackageJsonInjectedDependenciesHash(variant);
 

diff --git a/libraries/rush-lib/src/logic/SetupChecks.ts b/libraries/rush-lib/src/logic/SetupChecks.ts
@@ -40,7 +40,7 @@ export class SetupChecks {
 
   private static _validate(rushConfiguration: RushConfiguration): string | undefined {
     // Check for outdated tools
-    if (rushConfiguration.packageManager === 'pnpm') {
+    if (rushConfiguration.isPnpm) {
       if (semver.lt(rushConfiguration.packageManagerToolVersion, MINIMUM_SUPPORTED_PNPM_VERSION)) {
         return (
           `The ${RushConstants.rushJsonFilename} file requests PNPM version ` +

diff --git a/libraries/rush-lib/src/logic/StandardScriptUpdater.ts b/libraries/rush-lib/src/logic/StandardScriptUpdater.ts
@@ -87,7 +87,7 @@ const _pnpmOnlyScripts: IScriptSpecifier[] = [
 ];
 
 const getScripts = (rushConfiguration: RushConfiguration): IScriptSpecifier[] => {
-  if (rushConfiguration.packageManager === 'pnpm') {
+  if (rushConfiguration.isPnpm) {
     return _scripts.concat(_pnpmOnlyScripts);
   }
 

diff --git a/libraries/rush-lib/src/logic/base/BaseInstallManager.ts b/libraries/rush-lib/src/logic/base/BaseInstallManager.ts
@@ -282,7 +282,7 @@ export abstract class BaseInstallManager {
     const { configuration: experiments } = this.rushConfiguration.experimentsConfiguration;
     // if usePnpmSyncForInjectedDependencies is true
     // the pnpm-sync will generate the pnpm-sync.json based on lockfile
-    if (this.rushConfiguration.packageManager === 'pnpm' && experiments?.usePnpmSyncForInjectedDependencies) {
+    if (this.rushConfiguration.isPnpm && experiments?.usePnpmSyncForInjectedDependencies) {
       const pnpmLockfilePath: string = subspace.getTempShrinkwrapFilename();
       const dotPnpmFolder: string = `${subspace.getSubspaceTempFolderPath()}/node_modules/.pnpm`;
 
@@ -400,7 +400,7 @@ export abstract class BaseInstallManager {
     // Add pnpm-config.json file to the potentially changed files list.
     potentiallyChangedFiles.push(subspace.getPnpmConfigFilePath());
 
-    if (this.rushConfiguration.packageManager === 'pnpm') {
+    if (this.rushConfiguration.isPnpm) {
       // If the repo is using pnpmfile.js, consider that also
       const pnpmFileFilePath: string = subspace.getPnpmfilePath(variant);
       const pnpmFileExists: boolean = await FileSystem.existsAsync(pnpmFileFilePath);
@@ -535,15 +535,16 @@ export abstract class BaseInstallManager {
       sourceNpmrcFolder: subspace.getSubspaceConfigFolderPath(),
       targetNpmrcFolder: subspace.getSubspaceTempFolderPath(),
       linesToPrepend: extraNpmrcLines,
-      createIfMissing: this.rushConfiguration.subspacesFeatureEnabled
+      createIfMissing: this.rushConfiguration.subspacesFeatureEnabled,
+      supportEnvVarFallbackSyntax: this.rushConfiguration.isPnpm
     });
     this._syncNpmrcAlreadyCalled = true;
 
     const npmrcHash: string | undefined = npmrcText
       ? crypto.createHash('sha1').update(npmrcText).digest('hex')
       : undefined;
 
-    if (this.rushConfiguration.packageManager === 'pnpm') {
+    if (this.rushConfiguration.isPnpm) {
       // Copy the committed patches folder if using pnpm
       const commonTempPnpmPatchesFolder: string = `${subspace.getSubspaceTempFolderPath()}/${
         RushConstants.pnpmPatchesFolderName
@@ -598,7 +599,7 @@ export abstract class BaseInstallManager {
 
     // Shim support for pnpmfile in.
     // Additionally when in workspaces, the shim implements support for common versions.
-    if (this.rushConfiguration.packageManager === 'pnpm') {
+    if (this.rushConfiguration.isPnpm) {
       await PnpmfileConfiguration.writeCommonTempPnpmfileShimAsync(
         this.rushConfiguration,
         subspace.getSubspaceTempFolderPath(),
@@ -836,7 +837,7 @@ ${gitLfsHookHandling}
       if (collectLogFile) {
         args.push('--verbose');
       }
-    } else if (this.rushConfiguration.packageManager === 'pnpm') {
+    } else if (this.rushConfiguration.isPnpm) {
       // Only explicitly define the store path if `pnpmStore` is using the default, or has been set to
       // 'local'.  If `pnpmStore` = 'global', then allow PNPM to use the system's default
       // path.  In all cases, this will be overridden by RUSH_PNPM_STORE_PATH
@@ -911,7 +912,8 @@ ${gitLfsHookHandling}
       */
       const isAutoInstallPeersInNpmrc: boolean = isVariableSetInNpmrcFile(
         subspace.getSubspaceConfigFolderPath(),
-        'auto-install-peers'
+        'auto-install-peers',
+        this.rushConfiguration.isPnpm
       );
 
       let autoInstallPeers: boolean | undefined = this.rushConfiguration.pnpmOptions.autoInstallPeers;
@@ -939,7 +941,8 @@ ${gitLfsHookHandling}
       */
       const isResolutionModeInNpmrc: boolean = isVariableSetInNpmrcFile(
         subspace.getSubspaceConfigFolderPath(),
-        'resolution-mode'
+        'resolution-mode',
+        this.rushConfiguration.isPnpm
       );
 
       let resolutionMode: PnpmResolutionMode | undefined = this.rushConfiguration.pnpmOptions.resolutionMode;
@@ -1116,7 +1119,7 @@ ${gitLfsHookHandling}
       // Otherwise delete the temporary file
       FileSystem.deleteFile(subspace.getTempShrinkwrapFilename());
 
-      if (this.rushConfiguration.packageManager === 'pnpm') {
+      if (this.rushConfiguration.isPnpm) {
         // Workaround for https://github.com/pnpm/pnpm/issues/1890
         //
         // When "rush update --full" is run, Rush deletes "common/temp/pnpm-lock.yaml"

diff --git a/libraries/rush-lib/src/logic/installManager/InstallHelpers.ts b/libraries/rush-lib/src/logic/installManager/InstallHelpers.ts
@@ -50,7 +50,7 @@ export class InstallHelpers {
       version: '0.0.0'
     };
 
-    if (rushConfiguration.packageManager === 'pnpm') {
+    if (rushConfiguration.isPnpm) {
       const pnpmOptions: PnpmOptionsConfiguration =
         subspace.getPnpmOptions() || rushConfiguration.pnpmOptions;
       if (!commonPackageJson.pnpm) {
@@ -132,7 +132,7 @@ export class InstallHelpers {
       if (rushConfiguration.npmOptions && rushConfiguration.npmOptions.environmentVariables) {
         configurationEnvironment = rushConfiguration.npmOptions.environmentVariables;
       }
-    } else if (rushConfiguration.packageManager === 'pnpm') {
+    } else if (rushConfiguration.isPnpm) {
       if (rushConfiguration.pnpmOptions && rushConfiguration.pnpmOptions.environmentVariables) {
         configurationEnvironment = rushConfiguration.pnpmOptions.environmentVariables;
       }

diff --git a/libraries/rush-lib/src/logic/installManager/RushInstallManager.ts b/libraries/rush-lib/src/logic/installManager/RushInstallManager.ts
@@ -332,7 +332,7 @@ export class RushInstallManager extends BaseInstallManager {
       // with the shrinkwrap file, since these will cause install to fail.
       if (
         shrinkwrapFile &&
-        this.rushConfiguration.packageManager === 'pnpm' &&
+        this.rushConfiguration.isPnpm &&
         this.rushConfiguration.experimentsConfiguration.configuration.usePnpmFrozenLockfileForRushInstall
       ) {
         const pnpmShrinkwrapFile: PnpmShrinkwrapFile = shrinkwrapFile as PnpmShrinkwrapFile;
@@ -361,7 +361,7 @@ export class RushInstallManager extends BaseInstallManager {
     }
 
     // Remove the workspace file if it exists
-    if (this.rushConfiguration.packageManager === 'pnpm') {
+    if (this.rushConfiguration.isPnpm) {
       const workspaceFilePath: string = path.join(
         this.rushConfiguration.commonTempFolder,
         'pnpm-workspace.yaml'
@@ -622,7 +622,7 @@ export class RushInstallManager extends BaseInstallManager {
       },
       this.options.maxInstallAttempts,
       () => {
-        if (this.rushConfiguration.packageManager === 'pnpm') {
+        if (this.rushConfiguration.isPnpm) {
           // eslint-disable-next-line no-console
           console.log(Colorize.yellow(`Deleting the "node_modules" folder`));
           this.installRecycler.moveFolder(commonNodeModulesFolder);