Only support fallback for pnpm.

Author: iclanton

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);
@@ -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/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(
@@ -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({

libraries/rush-lib/src/logic/base/BaseInstallManager.ts

@@ -536,7 +536,8 @@ 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;
 
@@ -912,7 +913,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;
@@ -940,7 +942,8 @@ ${gitLfsHookHandling}
       */
       const isResolutionModeInNpmrc: boolean = isVariableSetInNpmrcFile(
         subspace.getSubspaceConfigFolderPath(),
-        'resolution-mode'
+        'resolution-mode',
+        this.rushConfiguration.isPnpm
       );
 
       let resolutionMode: PnpmResolutionMode | undefined = this.rushConfiguration.pnpmOptions.resolutionMode;

libraries/rush-lib/src/logic/setup/SetupPackageRegistry.ts

@@ -110,7 +110,8 @@ export class SetupPackageRegistry {
     if (!this._options.syncNpmrcAlreadyCalled) {
       Utilities.syncNpmrc({
         sourceNpmrcFolder: this.rushConfiguration.commonRushConfigFolder,
-        targetNpmrcFolder: this.rushConfiguration.commonTempFolder
+        targetNpmrcFolder: this.rushConfiguration.commonTempFolder,
+        supportEnvVarFallbackSyntax: this.rushConfiguration.isPnpm
       });
     }
 

libraries/rush-lib/src/scripts/install-run.ts

@@ -169,7 +169,8 @@ function _resolvePackageVersion(
       syncNpmrc({
         sourceNpmrcFolder,
         targetNpmrcFolder: rushTempFolder,
-        logger
+        logger,
+        supportEnvVarFallbackSyntax: false
       });
 
       const npmPath: string = getNpmPath();
@@ -433,7 +434,8 @@ export function installAndRun(
     syncNpmrc({
       sourceNpmrcFolder,
       targetNpmrcFolder: packageInstallFolder,
-      logger
+      logger,
+      supportEnvVarFallbackSyntax: false
     });
 
     _createPackageJson(packageInstallFolder, packageName, packageVersion);

libraries/rush-lib/src/utilities/Utilities.ts

@@ -531,7 +531,8 @@ export class Utilities {
     if (commonRushConfigFolder) {
       Utilities.syncNpmrc({
         sourceNpmrcFolder: commonRushConfigFolder,
-        targetNpmrcFolder: directory
+        targetNpmrcFolder: directory,
+        supportEnvVarFallbackSyntax: false
       });
     }
 

libraries/rush-lib/src/utilities/npmrcUtilities.ts

@@ -22,12 +22,13 @@ export interface ILogger {
 // create a global _combinedNpmrc for cache purpose
 const _combinedNpmrcMap: Map<string, string> = new Map();
 
-function _trimNpmrcFile(options: {
-  sourceNpmrcPath: string;
-  linesToPrepend?: string[];
-  linesToAppend?: string[];
-}): string {
-  const { sourceNpmrcPath, linesToPrepend, linesToAppend } = options;
+function _trimNpmrcFile(
+  options: Pick<
+    INpmrcTrimOptions,
+    'sourceNpmrcPath' | 'linesToAppend' | 'linesToPrepend' | 'supportEnvVarFallbackSyntax'
+  >
+): string {
+  const { sourceNpmrcPath, linesToPrepend, linesToAppend, supportEnvVarFallbackSyntax } = options;
   const combinedNpmrcFromCache: string | undefined = _combinedNpmrcMap.get(sourceNpmrcPath);
   if (combinedNpmrcFromCache !== undefined) {
     return combinedNpmrcFromCache;
@@ -48,7 +49,7 @@ function _trimNpmrcFile(options: {
 
   npmrcFileLines = npmrcFileLines.map((line) => (line || '').trim());
 
-  const resultLines: string[] = trimNpmrcFileLines(npmrcFileLines, process.env);
+  const resultLines: string[] = trimNpmrcFileLines(npmrcFileLines, process.env, supportEnvVarFallbackSyntax);
 
   const combinedNpmrc: string = resultLines.join('\n');
 
@@ -58,7 +59,18 @@ function _trimNpmrcFile(options: {
   return combinedNpmrc;
 }
 
-export function trimNpmrcFileLines(npmrcFileLines: string[], env: NodeJS.ProcessEnv): string[] {
+/**
+ *
+ * @param npmrcFileLines The npmrc file's lines
+ * @param env The environment variables object
+ * @param supportEnvVarFallbackSyntax Whether to support fallback values in the form of `${VAR_NAME:-fallback}`
+ * @returns
+ */
+export function trimNpmrcFileLines(
+  npmrcFileLines: string[],
+  env: NodeJS.ProcessEnv,
+  supportEnvVarFallbackSyntax: boolean
+): string[] {
   const resultLines: string[] = [];
 
   // This finds environment variable tokens that look like "${VAR_NAME}"
@@ -91,18 +103,24 @@ export function trimNpmrcFileLines(npmrcFileLines: string[], env: NodeJS.Process
            */
           const nameWithFallback: string = token.substring(2, token.length - 1);
 
-          /**
-           * Get the environment variable name and fallback value.
-           *
-           *                                name          fallback
-           * nameString                 ->  nameString    undefined
-           * nameString-fallbackString  ->  nameString    fallbackString
-           * nameString:-fallbackString ->  nameString    fallbackString
-           */
-          const matched: string[] | null = nameWithFallback.match(/^([^:-]+)(?:\:?-(.+))?$/);
-          // matched: [originStr, variableName, fallback]
-          const environmentVariableName: string = matched?.[1] ?? nameWithFallback;
-          const fallback: string | undefined = matched?.[2];
+          let environmentVariableName: string;
+          let fallback: string | undefined;
+          if (supportEnvVarFallbackSyntax) {
+            /**
+             * Get the environment variable name and fallback value.
+             *
+             *                                name          fallback
+             * nameString                 ->  nameString    undefined
+             * nameString-fallbackString  ->  nameString    fallbackString
+             * nameString:-fallbackString ->  nameString    fallbackString
+             */
+            const matched: string[] | null = nameWithFallback.match(/^([^:-]+)(?:\:?-(.+))?$/);
+            // matched: [originStr, variableName, fallback]
+            environmentVariableName = matched?.[1] ?? nameWithFallback;
+            fallback = matched?.[2];
+          } else {
+            environmentVariableName = nameWithFallback;
+          }
 
           // Is the environment variable and fallback value defined.
           if (!env[environmentVariableName] && !fallback) {
@@ -146,18 +164,15 @@ interface INpmrcTrimOptions {
   logger: ILogger;
   linesToPrepend?: string[];
   linesToAppend?: string[];
+  supportEnvVarFallbackSyntax: boolean;
 }
 
 function _copyAndTrimNpmrcFile(options: INpmrcTrimOptions): string {
-  const { logger, sourceNpmrcPath, targetNpmrcPath, linesToPrepend, linesToAppend } = options;
+  const { logger, sourceNpmrcPath, targetNpmrcPath } = options;
   logger.info(`Transforming ${sourceNpmrcPath}`); // Verbose
   logger.info(`  --> "${targetNpmrcPath}"`);
 
-  const combinedNpmrc: string = _trimNpmrcFile({
-    sourceNpmrcPath,
-    linesToPrepend,
-    linesToAppend
-  });
+  const combinedNpmrc: string = _trimNpmrcFile(options);
 
   fs.writeFileSync(targetNpmrcPath, combinedNpmrc);
 
@@ -176,12 +191,14 @@ function _copyAndTrimNpmrcFile(options: INpmrcTrimOptions): string {
 export interface ISyncNpmrcOptions {
   sourceNpmrcFolder: string;
   targetNpmrcFolder: string;
+  supportEnvVarFallbackSyntax: boolean;
   useNpmrcPublish?: boolean;
   logger?: ILogger;
   linesToPrepend?: string[];
   linesToAppend?: string[];
   createIfMissing?: boolean;
 }
+
 export function syncNpmrc(options: ISyncNpmrcOptions): string | undefined {
   const {
     sourceNpmrcFolder,
@@ -193,9 +210,7 @@ export function syncNpmrc(options: ISyncNpmrcOptions): string | undefined {
       // eslint-disable-next-line no-console
       error: console.error
     },
-    createIfMissing = false,
-    linesToAppend,
-    linesToPrepend
+    createIfMissing = false
   } = options;
   const sourceNpmrcPath: string = path.join(
     sourceNpmrcFolder,
@@ -213,8 +228,7 @@ export function syncNpmrc(options: ISyncNpmrcOptions): string | undefined {
         sourceNpmrcPath,
         targetNpmrcPath,
         logger,
-        linesToAppend,
-        linesToPrepend
+        ...options
       });
     } else if (fs.existsSync(targetNpmrcPath)) {
       // If the source .npmrc doesn't exist and there is one in the target, delete the one in the target
@@ -226,15 +240,19 @@ export function syncNpmrc(options: ISyncNpmrcOptions): string | undefined {
   }
 }
 
-export function isVariableSetInNpmrcFile(sourceNpmrcFolder: string, variableKey: string): boolean {
+export function isVariableSetInNpmrcFile(
+  sourceNpmrcFolder: string,
+  variableKey: string,
+  supportEnvVarFallbackSyntax: boolean
+): boolean {
   const sourceNpmrcPath: string = `${sourceNpmrcFolder}/.npmrc`;
 
   //if .npmrc file does not exist, return false directly
   if (!fs.existsSync(sourceNpmrcPath)) {
     return false;
   }
 
-  const trimmedNpmrcFile: string = _trimNpmrcFile({ sourceNpmrcPath });
+  const trimmedNpmrcFile: string = _trimNpmrcFile({ sourceNpmrcPath, supportEnvVarFallbackSyntax });
 
   const variableKeyRegExp: RegExp = new RegExp(`^${variableKey}=`, 'm');
   return trimmedNpmrcFile.match(variableKeyRegExp) !== null;