@rushstack/rush-sdk 5.135.0 → 5.136.0

package/lib/cli/actions/RemoveAction.d.ts

@@ -5,9 +5,9 @@ import type { IPackageJsonUpdaterRushRemoveOptions } from '../../logic/PackageJs
 export declare class RemoveAction extends BaseAddAndRemoveAction {
     protected readonly _allFlag: CommandLineFlagParameter;
     protected readonly _packageNameList: CommandLineStringListParameter;
-    private _terminalProvider;
-    private _terminal;
+    private readonly _variantParameter;
+    private readonly _terminal;
     constructor(parser: RushCommandLineParser);
-    getUpdateOptions(): IPackageJsonUpdaterRushRemoveOptions;
+    getUpdateOptionsAsync(): Promise<IPackageJsonUpdaterRushRemoveOptions>;
 }
 //# sourceMappingURL=RemoveAction.d.ts.map

package/lib/cli/actions/UpgradeInteractiveAction.d.ts

@@ -3,6 +3,7 @@ import { BaseRushAction } from './BaseRushAction';
 export declare class UpgradeInteractiveAction extends BaseRushAction {
     private _makeConsistentFlag;
     private _skipUpdateFlag;
+    private readonly _variantParameter;
     constructor(parser: RushCommandLineParser);
     runAsync(): Promise<void>;
 }

package/lib/cli/scriptActions/PhasedScriptAction.d.ts

@@ -51,6 +51,7 @@ export declare class PhasedScriptAction extends BaseScriptAction<IPhasedCommandC
     private readonly _timelineParameter;
     private readonly _cobuildPlanParameter;
     private readonly _installParameter;
+    private readonly _variantParameter;
     private readonly _noIPCParameter;
     constructor(options: IPhasedScriptActionOptions);
     runAsync(): Promise<void>;

package/lib/logic/DependencyAnalyzer.d.ts

@@ -20,10 +20,10 @@ export interface IDependencyAnalysis {
 export declare class DependencyAnalyzer {
     private static _dependencyAnalyzerByRushConfiguration;
     private _rushConfiguration;
-    private _analysisBySubspace;
+    private _analysisByVariantBySubspace;
     private constructor();
     static forRushConfiguration(rushConfiguration: RushConfiguration): DependencyAnalyzer;
-    getAnalysis(subspace?: Subspace, addAction?: boolean): IDependencyAnalysis;
+    getAnalysis(subspace: Subspace | undefined, variant: string | undefined, addAction: boolean): IDependencyAnalysis;
     /**
      * Generates the {@link IDependencyAnalysis}.
      *

package/lib/logic/PackageJsonUpdaterTypes.d.ts

@@ -45,6 +45,10 @@ export interface IPackageJsonUpdaterRushBaseUpdateOptions {
      * actionName
      */
     actionName: string;
+    /**
+     * The variant to consider when performing installations and validating shrinkwrap updates.
+     */
+    variant: string | undefined | undefined;
 }
 /**
  * Configuration options for adding or updating a dependency in a single project

package/lib/logic/ProjectChangeAnalyzer.d.ts

@@ -8,6 +8,7 @@ export interface IGetChangedProjectsOptions {
     targetBranchName: string;
     terminal: ITerminal;
     shouldFetch?: boolean;
+    variant?: string;
     /**
      * If set to `true`, consider a project's external dependency installation layout as defined in the
      * package manager lockfile when determining if it has changed.

package/lib/logic/RepoStateFile.d.ts

@@ -51,7 +51,7 @@ export declare class RepoStateFile {
      *
      * @returns true if the file was modified, otherwise false.
      */
-    refreshState(rushConfiguration: RushConfiguration, subspace: Subspace | undefined): boolean;
+    refreshState(rushConfiguration: RushConfiguration, subspace: Subspace | undefined, variant?: string): boolean;
     /**
      * Writes the "repo-state.json" file to disk, using the filename that was passed to loadFromFile().
      */

package/lib/logic/RushConstants.d.ts

@@ -41,6 +41,12 @@ export declare class RushConstants {
      * The NPM scope ("\@rush-temp") that is used for Rush's temporary projects.
      */
     static readonly rushTempNpmScope: '@rush-temp';
+    /**
+     * The folder name ("variants") under which named variant configurations for
+     * alternate dependency sets may be found.
+     * Example: `C:\MyRepo\common\config\rush\variants`
+     */
+    static readonly rushVariantsFolderName: 'variants';
     /**
      * The folder name ("temp") under the common folder, or under the .rush folder in each project's directory where
      * temporary files will be stored.
@@ -268,5 +274,9 @@ export declare class RushConstants {
      * The filename for the machine-generated file that tracks state for Rush alerts.
      */
     static readonly rushAlertsStateFilename: 'rush-alerts-state.json';
+    /**
+     * The filename for the file that tracks which variant is currently installed.
+     */
+    static readonly currentVariantsFilename: 'current-variants.json';
 }
 //# sourceMappingURL=RushConstants.d.ts.map

package/lib/logic/base/BaseInstallManagerTypes.d.ts

@@ -64,6 +64,10 @@ export interface IInstallManagerOptions {
      * If specified when using PNPM, the logs will be in /common/temp/pnpm.log
      */
     collectLogFile: boolean;
+    /**
+     * The variant to consider when performing installations and validating shrinkwrap updates.
+     */
+    variant: string | undefined;
     /**
      * Retry the install the specified number of times
      */

package/lib/logic/base/BaseShrinkwrapFile.d.ts

@@ -85,10 +85,11 @@ export declare abstract class BaseShrinkwrapFile {
      * a given package.json. Returns true if any dependencies are not aligned with the shrinkwrap.
      *
      * @param project - the Rush project that is being validated against the shrinkwrap
+     * @param variant - the variant that is being validated
      *
      * @virtual
      */
-    abstract isWorkspaceProjectModifiedAsync(project: RushConfigurationProject, subspace: Subspace): Promise<boolean>;
+    abstract isWorkspaceProjectModifiedAsync(project: RushConfigurationProject, subspace: Subspace, variant: string | undefined): Promise<boolean>;
     /** @virtual */
     protected abstract serialize(): string;
     protected _getTempProjectNames(dependencies: {

package/lib/logic/npm/NpmShrinkwrapFile.d.ts

@@ -25,6 +25,6 @@ export declare class NpmShrinkwrapFile extends BaseShrinkwrapFile {
     /** @override */
     getProjectShrinkwrap(project: RushConfigurationProject): BaseProjectShrinkwrapFile<NpmShrinkwrapFile> | undefined;
     /** @override */
-    isWorkspaceProjectModifiedAsync(project: RushConfigurationProject, subspace: Subspace): Promise<boolean>;
+    isWorkspaceProjectModifiedAsync(project: RushConfigurationProject, subspace: Subspace, variant: string | undefined): Promise<boolean>;
 }
 //# sourceMappingURL=NpmShrinkwrapFile.d.ts.map

package/lib/logic/pnpm/PnpmShrinkwrapFile.d.ts

@@ -255,7 +255,7 @@ export declare class PnpmShrinkwrapFile extends BaseShrinkwrapFile {
     getImporter(importerKey: string): IPnpmShrinkwrapImporterYaml | undefined;
     getIntegrityForImporter(importerKey: string): Map<string, string> | undefined;
     /** @override */
-    isWorkspaceProjectModifiedAsync(project: RushConfigurationProject, subspace: Subspace): Promise<boolean>;
+    isWorkspaceProjectModifiedAsync(project: RushConfigurationProject, subspace: Subspace, variant: string | undefined): Promise<boolean>;
     private _getIntegrityForPackage;
     private _addIntegrities;
     /**

package/lib/logic/pnpm/PnpmfileConfiguration.d.ts

@@ -8,8 +8,8 @@ import type { Subspace } from '../../api/Subspace';
 export declare class PnpmfileConfiguration {
     private _context;
     private constructor();
-    static initializeAsync(rushConfiguration: RushConfiguration, subspace: Subspace): Promise<PnpmfileConfiguration>;
-    static writeCommonTempPnpmfileShimAsync(rushConfiguration: RushConfiguration, targetDir: string, subspace: Subspace): Promise<void>;
+    static initializeAsync(rushConfiguration: RushConfiguration, subspace: Subspace, variant: string | undefined): Promise<PnpmfileConfiguration>;
+    static writeCommonTempPnpmfileShimAsync(rushConfiguration: RushConfiguration, targetDir: string, subspace: Subspace, variant: string | undefined): Promise<void>;
     private static _getPnpmfileShimSettingsAsync;
     /**
      * Transform a package.json file using the pnpmfile.js hook.

package/lib/logic/pnpm/SubspacePnpmfileConfiguration.d.ts

@@ -11,8 +11,8 @@ export declare class SubspacePnpmfileConfiguration {
      * That means each project owns their individual pnpmfile under project folder. While the global pnpmfile could be
      * under the common/temp-split/ folder and be used by all split workspace projects.
      */
-    static writeCommonTempSubspaceGlobalPnpmfileAsync(rushConfiguration: RushConfiguration, subspace: Subspace): Promise<void>;
-    static getSubspacePnpmfileShimSettings(rushConfiguration: RushConfiguration, subspace: Subspace): ISubspacePnpmfileShimSettings;
+    static writeCommonTempSubspaceGlobalPnpmfileAsync(rushConfiguration: RushConfiguration, subspace: Subspace, variant: string | undefined): Promise<void>;
+    static getSubspacePnpmfileShimSettings(rushConfiguration: RushConfiguration, subspace: Subspace, variant: string | undefined): ISubspacePnpmfileShimSettings;
     private static _getProjectNameToInjectedDependenciesMap;
     private static _processDependenciesForTransitiveInjectedInstall;
 }

package/lib/logic/policy/PolicyValidator.d.ts

@@ -5,5 +5,5 @@ export interface IPolicyValidatorOptions {
     bypassPolicy?: boolean;
     allowShrinkwrapUpdates?: boolean;
 }
-export declare function validatePolicyAsync(rushConfiguration: RushConfiguration, subspace: Subspace, options: IPolicyValidatorOptions): Promise<void>;
+export declare function validatePolicyAsync(rushConfiguration: RushConfiguration, subspace: Subspace, variant: string | undefined, options: IPolicyValidatorOptions): Promise<void>;
 //# sourceMappingURL=PolicyValidator.d.ts.map

package/lib/logic/policy/ShrinkwrapFilePolicy.d.ts

@@ -8,5 +8,5 @@ export interface IShrinkwrapFilePolicyValidatorOptions extends IPolicyValidatorO
 /**
  *  A policy that validates shrinkwrap files used by package managers.
  */
-export declare function validate(rushConfiguration: RushConfiguration, subspace: Subspace, options: IPolicyValidatorOptions): void;
+export declare function validate(rushConfiguration: RushConfiguration, subspace: Subspace, variant: string | undefined, options: IPolicyValidatorOptions): void;
 //# sourceMappingURL=ShrinkwrapFilePolicy.d.ts.map

package/lib/logic/versionMismatch/VersionMismatchFinder.d.ts

@@ -3,12 +3,12 @@ import type { RushConfiguration } from '../../api/RushConfiguration';
 import type { VersionMismatchFinderEntity } from './VersionMismatchFinderEntity';
 import type { Subspace } from '../../api/Subspace';
 export interface IVersionMismatchFinderOptions {
-    subspace: Subspace;
+    subspace?: Subspace;
+    variant: string | undefined;
 }
 export interface IVersionMismatchFinderRushCheckOptions extends IVersionMismatchFinderOptions {
     printAsJson?: boolean | undefined;
     truncateLongPackageNameLists?: boolean | undefined;
-    subspace: Subspace;
 }
 export interface IVersionMismatchFinderEnsureConsistentVersionsOptions extends IVersionMismatchFinderOptions {
 }

package/lib/pluginFramework/RushLifeCycle.d.ts

@@ -58,11 +58,19 @@ export declare class RushLifecycleHooks {
     /**
      * The hook to run between preparing the common/temp folder and invoking the package manager during "rush install" or "rush update".
      */
-    readonly beforeInstall: AsyncSeriesHook<[IGlobalCommand, Subspace]>;
+    readonly beforeInstall: AsyncSeriesHook<[
+        command: IGlobalCommand,
+        subspace: Subspace,
+        variant: string | undefined
+    ]>;
     /**
      * The hook to run after a successful install.
      */
-    readonly afterInstall: AsyncSeriesHook<[IRushCommand, Subspace]>;
+    readonly afterInstall: AsyncSeriesHook<[
+        command: IRushCommand,
+        subspace: Subspace,
+        variant: string | undefined
+    ]>;
     /**
      * A hook to allow plugins to hook custom logic to process telemetry data.
      */

package/lib/utilities/Utilities.d.ts

@@ -120,7 +120,7 @@ export declare class Utilities {
      * hard disk.
      */
     static dangerouslyDeletePath(folderPath: string): void;
-    static isFileTimestampCurrent(dateToCompare: Date, inputFilenames: string[]): boolean;
+    static isFileTimestampCurrentAsync(dateToCompare: Date, inputFilePaths: string[]): Promise<boolean>;
     static executeCommandAsync(options: IExecuteCommandOptions & {
         captureExitCodeAndSignal: true;
     }): Promise<Pick<IWaitForExitResult, 'exitCode' | 'signal'>>;

package/lib-shim/index.js

@@ -160,6 +160,13 @@ const EnvironmentVariableNames = {
      * or `0` to disallow them. (See the comments in the command-line.json file for more information).
      */
     RUSH_ALLOW_WARNINGS_IN_SUCCESSFUL_BUILD: 'RUSH_ALLOW_WARNINGS_IN_SUCCESSFUL_BUILD',
+    /**
+     * This variable selects a specific installation variant for Rush to use when installing
+     * and linking package dependencies.
+     * For more information, see the command-line help for the `--variant` parameter
+     * and this article:  https://rushjs.io/pages/advanced/installation_variants/
+     */
+    RUSH_VARIANT: 'RUSH_VARIANT',
     /**
      * Specifies the maximum number of concurrent processes to launch during a build.
      * For more information, see the command-line help for the `--parallelism` parameter for "rush build".
@@ -543,6 +550,7 @@ class EnvironmentConfiguration {
                     }
                     case EnvironmentVariableNames.RUSH_PARALLELISM:
                     case EnvironmentVariableNames.RUSH_PREVIEW_VERSION:
+                    case EnvironmentVariableNames.RUSH_VARIANT:
                     case EnvironmentVariableNames.RUSH_DEPLOY_TARGET_FOLDER:
                         // Handled by @microsoft/rush front end
                         break;
@@ -748,6 +756,12 @@ RushConstants.commonFolderName = 'common';
  * The NPM scope ("\@rush-temp") that is used for Rush's temporary projects.
  */
 RushConstants.rushTempNpmScope = '@rush-temp';
+/**
+ * The folder name ("variants") under which named variant configurations for
+ * alternate dependency sets may be found.
+ * Example: `C:\MyRepo\common\config\rush\variants`
+ */
+RushConstants.rushVariantsFolderName = 'variants';
 /**
  * The folder name ("temp") under the common folder, or under the .rush folder in each project's directory where
  * temporary files will be stored.
@@ -977,6 +991,10 @@ RushConstants.rushAlertsConfigFilename = 'rush-alerts.json';
  * The filename for the machine-generated file that tracks state for Rush alerts.
  */
 RushConstants.rushAlertsStateFilename = 'rush-alerts-state.json';
+/**
+ * The filename for the file that tracks which variant is currently installed.
+ */
+RushConstants.currentVariantsFilename = 'current-variants.json';
 //# sourceMappingURL=RushConstants.js.map
 
 /***/ }),
@@ -1130,17 +1148,30 @@ class Utilities {
      * NOTE: The filenames can also be paths for directories, in which case the directory
      * timestamp is compared.
      */
-    static isFileTimestampCurrent(dateToCompare, inputFilenames) {
-        for (const inputFilename of inputFilenames) {
-            if (!_rushstack_node_core_library__WEBPACK_IMPORTED_MODULE_5__.FileSystem.exists(inputFilename)) {
-                return false;
-            }
-            const inputStats = _rushstack_node_core_library__WEBPACK_IMPORTED_MODULE_5__.FileSystem.getStatistics(inputFilename);
-            if (dateToCompare < inputStats.mtime) {
-                return false;
+    static async isFileTimestampCurrentAsync(dateToCompare, inputFilePaths) {
+        let anyAreOutOfDate = false;
+        await _rushstack_node_core_library__WEBPACK_IMPORTED_MODULE_5__.Async.forEachAsync(inputFilePaths, async (filePath) => {
+            if (!anyAreOutOfDate) {
+                let inputStats;
+                try {
+                    inputStats = await _rushstack_node_core_library__WEBPACK_IMPORTED_MODULE_5__.FileSystem.getStatisticsAsync(filePath);
+                }
+                catch (e) {
+                    if (_rushstack_node_core_library__WEBPACK_IMPORTED_MODULE_5__.FileSystem.isNotExistError(e)) {
+                        // eslint-disable-next-line require-atomic-updates
+                        anyAreOutOfDate = true;
+                    }
+                    else {
+                        throw e;
+                    }
+                }
+                if (inputStats && dateToCompare < inputStats.mtime) {
+                    // eslint-disable-next-line require-atomic-updates
+                    anyAreOutOfDate = true;
+                }
             }
-        }
-        return true;
+        }, { concurrency: 10 });
+        return !anyAreOutOfDate;
     }
     /**
      * Executes the command with the specified command-line parameters, and waits for it to complete.