Add support for .env files in rushx and rush-pnpm.

Author: iclanton

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

@@ -16,7 +16,6 @@ import {
   Colorize,
   type ITerminal
 } from '@rushstack/terminal';
-import dotenv from 'dotenv';
 
 import { RushConfiguration } from '../api/RushConfiguration';
 import { RushConstants } from '../logic/RushConstants';
@@ -65,8 +64,7 @@ import { RushSession } from '../pluginFramework/RushSession';
 import type { IBuiltInPluginConfiguration } from '../pluginFramework/PluginLoader/BuiltInPluginLoader';
 import { InitSubspaceAction } from './actions/InitSubspaceAction';
 import { RushAlerts } from '../utilities/RushAlerts';
-import { RushUserConfiguration } from '../api/RushUserConfiguration';
-import { EnvironmentConfiguration } from '../api/EnvironmentConfiguration';
+import { initializeDotEnv } from '../logic/dotenv';
 
 import { measureAsyncFn } from '../utilities/performance';
 
@@ -135,22 +133,7 @@ export class RushCommandLineParser extends CommandLineParser {
         showVerbose: !this._restrictConsoleOutput
       });
 
-      if (EnvironmentConfiguration.hasBeenValidated) {
-        throw new Error(
-          `The ${EnvironmentConfiguration.name} was initialized before .env files were loaded. Rush environment ` +
-            'variables may have unexpected values.'
-        );
-      }
-
-      if (rushJsonFilePath) {
-        const rushJsonFolder: string = path.dirname(rushJsonFilePath);
-        dotenv.config({ path: `${rushJsonFolder}/.env` });
-      }
-
-      const rushUserFolder: string = RushUserConfiguration.getRushUserFolderPath();
-      dotenv.config({ path: `${rushUserFolder}/.env` });
-
-      // TODO: Consider adding support for repo-specific `.rush-user` `.env` files.
+      initializeDotEnv(terminal, rushJsonFilePath);
 
       if (rushJsonFilePath) {
         this.rushConfiguration = RushConfiguration.loadFromConfigurationFile(rushJsonFilePath);

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

@@ -33,6 +33,7 @@ import { Utilities } from '../utilities/Utilities';
 import type { Subspace } from '../api/Subspace';
 import type { PnpmOptionsConfiguration } from '../logic/pnpm/PnpmOptionsConfiguration';
 import { EnvironmentVariableNames } from '../api/EnvironmentConfiguration';
+import { initializeDotEnv } from '../logic/dotenv';
 
 const RUSH_SKIP_CHECKS_PARAMETER: string = '--rush-skip-checks';
 
@@ -78,10 +79,17 @@ export class RushPnpmCommandLineParser {
     this._terminal = terminal;
 
     // Are we in a Rush repo?
-    const rushConfiguration: RushConfiguration | undefined = RushConfiguration.tryLoadFromDefaultLocation({
+    const rushJsonFilePath: string | undefined = RushConfiguration.tryFindRushJsonLocation({
       // showVerbose is false because the logging message may break JSON output
       showVerbose: false
     });
+
+    initializeDotEnv(terminal, rushJsonFilePath);
+
+    const rushConfiguration: RushConfiguration | undefined = rushJsonFilePath
+      ? RushConfiguration.loadFromConfigurationFile(rushJsonFilePath)
+      : undefined;
+
     NodeJsCompatibility.warnAboutCompatibilityIssues({
       isRushLib: true,
       alreadyReportedNodeTooNewError: !!options.alreadyReportedNodeTooNewError,

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

@@ -25,6 +25,7 @@ import { Event } from '../api/EventHooks';
 import { EnvironmentVariableNames } from '../api/EnvironmentConfiguration';
 import { RushConstants } from '../logic/RushConstants';
 import { PnpmSyncUtilities } from '../utilities/PnpmSyncUtilities';
+import { initializeDotEnv } from '../logic/dotenv';
 
 interface IRushXCommandLineArguments {
   /**
@@ -77,18 +78,31 @@ export class RushXCommandLine {
   public static async launchRushXAsync(launcherVersion: string, options: ILaunchOptions): Promise<void> {
     try {
       const rushxArguments: IRushXCommandLineArguments = RushXCommandLine._parseCommandLineArguments();
-      const rushConfiguration: RushConfiguration | undefined = RushConfiguration.tryLoadFromDefaultLocation({
+      const rushJsonFilePath: string | undefined = RushConfiguration.tryFindRushJsonLocation({
         showVerbose: false
       });
+      const { isDebug, help, ignoreHooks } = rushxArguments;
+
+      const terminalProvider: ITerminalProvider = new ConsoleTerminalProvider({
+        debugEnabled: isDebug,
+        verboseEnabled: isDebug
+      });
+      const terminal: ITerminal = new Terminal(terminalProvider);
+
+      initializeDotEnv(terminal, rushJsonFilePath);
+
+      const rushConfiguration: RushConfiguration | undefined = rushJsonFilePath
+        ? RushConfiguration.loadFromConfigurationFile(rushJsonFilePath)
+        : undefined;
       const eventHooksManager: EventHooksManager | undefined = rushConfiguration
         ? new EventHooksManager(rushConfiguration)
         : undefined;
 
       const suppressHooks: boolean = process.env[EnvironmentVariableNames._RUSH_RECURSIVE_RUSHX_CALL] === '1';
-      const attemptHooks: boolean = !suppressHooks && !rushxArguments.help;
+      const attemptHooks: boolean = !suppressHooks && !help;
       if (attemptHooks) {
         try {
-          eventHooksManager?.handle(Event.preRushx, rushxArguments.isDebug, rushxArguments.ignoreHooks);
+          eventHooksManager?.handle(Event.preRushx, isDebug, ignoreHooks);
         } catch (error) {
           // eslint-disable-next-line no-console
           console.error(Colorize.red('PreRushx hook error: ' + (error as Error).message));
@@ -98,10 +112,10 @@ export class RushXCommandLine {
       // promise exception), so we start with the assumption that the exit code is 1
       // and set it to 0 only on success.
       process.exitCode = 1;
-      await RushXCommandLine._launchRushXInternalAsync(rushxArguments, rushConfiguration, options);
+      await RushXCommandLine._launchRushXInternalAsync(terminal, rushxArguments, rushConfiguration, options);
       if (attemptHooks) {
         try {
-          eventHooksManager?.handle(Event.postRushx, rushxArguments.isDebug, rushxArguments.ignoreHooks);
+          eventHooksManager?.handle(Event.postRushx, isDebug, ignoreHooks);
         } catch (error) {
           // eslint-disable-next-line no-console
           console.error(Colorize.red('PostRushx hook error: ' + (error as Error).message));
@@ -122,6 +136,7 @@ export class RushXCommandLine {
   }
 
   private static async _launchRushXInternalAsync(
+    terminal: ITerminal,
     rushxArguments: IRushXCommandLineArguments,
     rushConfiguration: RushConfiguration | undefined,
     options: ILaunchOptions
@@ -218,12 +233,6 @@ export class RushXCommandLine {
       }
     });
 
-    const terminalProvider: ITerminalProvider = new ConsoleTerminalProvider({
-      debugEnabled: rushxArguments.isDebug,
-      verboseEnabled: rushxArguments.isDebug
-    });
-    const terminal: ITerminal = new Terminal(terminalProvider);
-
     if (rushConfiguration?.isPnpm && rushConfiguration?.experimentsConfiguration) {
       const { configuration: experiments } = rushConfiguration?.experimentsConfiguration;
 

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

@@ -1,6 +1,10 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
+jest.mock('../../logic/dotenv', () => ({
+  initializeDotEnv: () => {}
+}));
+
 import { PackageJsonLookup } from '@rushstack/node-core-library';
 
 import { Utilities } from '../../utilities/Utilities';
@@ -61,7 +65,8 @@ describe(RushXCommandLine.name, () => {
         return projects.find((project) => project.projectFolder === path);
       }
     } as RushConfiguration;
-    jest.spyOn(RushConfiguration, 'tryLoadFromDefaultLocation').mockReturnValue(rushConfiguration);
+    jest.spyOn(RushConfiguration, 'tryFindRushJsonLocation').mockReturnValue('/Users/jdoe/bigrepo');
+    jest.spyOn(RushConfiguration, 'loadFromConfigurationFile').mockReturnValue(rushConfiguration);
 
     // Mock command execution
     executeLifecycleCommandMock = jest.spyOn(Utilities, 'executeLifecycleCommand');

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

@@ -0,0 +1,28 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+import path from 'node:path';
+import dotenv from 'dotenv';
+import type { ITerminal } from '@rushstack/terminal';
+
+import { RushUserConfiguration } from '../api/RushUserConfiguration';
+import { EnvironmentConfiguration } from '../api/EnvironmentConfiguration';
+
+export function initializeDotEnv(terminal: ITerminal, rushJsonFilePath: string | undefined): void {
+  if (EnvironmentConfiguration.hasBeenValidated) {
+    throw terminal.writeWarningLine(
+      `The ${EnvironmentConfiguration.name} was initialized before .env files were loaded. Rush environment ` +
+        'variables may have unexpected values.'
+    );
+  }
+
+  if (rushJsonFilePath) {
+    const rushJsonFolder: string = path.dirname(rushJsonFilePath);
+    dotenv.config({ path: `${rushJsonFolder}/.env` });
+  }
+
+  const rushUserFolder: string = RushUserConfiguration.getRushUserFolderPath();
+  dotenv.config({ path: `${rushUserFolder}/.env` });
+
+  // TODO: Consider adding support for repo-specific `.rush-user` `.env` files.
+}