@rushstack/rush-sdk 5.135.0 → 5.136.1

package/dist/rush-lib.d.ts

@@ -17,6 +17,7 @@ import { IPackageJson } from '@rushstack/node-core-library';
 import { IPrefixMatch } from '@rushstack/lookup-by-path';
 import { ITerminal } from '@rushstack/terminal';
 import { ITerminalProvider } from '@rushstack/terminal';
+import { JsonNull } from '@rushstack/node-core-library';
 import { JsonObject } from '@rushstack/node-core-library';
 import { LookupByPath } from '@rushstack/lookup-by-path';
 import { PackageNameParser } from '@rushstack/node-core-library';
@@ -343,7 +344,7 @@ export declare class CommonVersionsConfiguration {
      * Loads the common-versions.json data from the specified file path.
      * If the file has not been created yet, then an empty object is returned.
      */
-    static loadFromFile(jsonFilename: string, rushConfiguration?: RushConfiguration): CommonVersionsConfiguration;
+    static loadFromFile(jsonFilePath: string, rushConfiguration?: RushConfiguration): CommonVersionsConfiguration;
     private static _deserializeTable;
     private static _serializeTable;
     /**
@@ -683,6 +684,13 @@ export declare const EnvironmentVariableNames: {
      * or `0` to disallow them. (See the comments in the command-line.json file for more information).
      */
     readonly 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/
+     */
+    readonly 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".
@@ -1236,6 +1244,13 @@ export declare interface ICredentialCacheOptions {
     supportEditing: boolean;
 }
 
+/**
+ * This represents the JSON data structure for the "current-variant.json" data file.
+ */
+declare interface ICurrentVariantJson {
+    variant: string | JsonNull;
+}
+
 /**
  * Metadata for a custom tip.
  *
@@ -1482,6 +1497,7 @@ export declare 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.
@@ -2214,7 +2230,7 @@ declare interface IRushConfigurationJson {
     pnpmOptions?: _IPnpmOptionsJson;
     yarnOptions?: _IYarnOptionsJson;
     ensureConsistentVersions?: boolean;
-    variants?: unknown;
+    variants?: IRushVariantOptionsJson[];
 }
 
 /**
@@ -2392,6 +2408,14 @@ export declare interface IRushSessionOptions {
     getIsDebugMode: () => boolean;
 }
 
+/**
+ * Options defining an allowed variant as part of IRushConfigurationJson.
+ */
+declare interface IRushVariantOptionsJson {
+    variantName: string;
+    description: string;
+}
+
 /**
  * Represents a readonly view of a `Stopwatch`.
  * @beta
@@ -3363,7 +3387,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().
      */
@@ -3449,6 +3473,10 @@ export declare class RushCommandLine {
 export declare class RushConfiguration {
     private static _jsonSchema;
     private readonly _pathTrees;
+    /**
+     * @internal
+     */
+    _currentVariantJsonLoadingPromise: Promise<ICurrentVariantJson | undefined> | undefined;
     private _projects;
     private _projectsByName;
     private _projectsByTag;
@@ -3553,12 +3581,13 @@ export declare class RushConfiguration {
      */
     readonly subspacesFeatureEnabled: boolean;
     /**
-     * If true, the `variants` field is present in rush.json.
+     * The filename of the variant dependency data file.  By default this is
+     * called 'current-variant.json' and resides in the Rush common folder.
+     * Its data structure is defined by ICurrentVariantJson.
      *
-     * @internal
-     * @deprecated - Remove when the field is removed from the rush.json schema.
+     * Example: `C:\MyRepo\common\temp\current-variant.json`
      */
-    readonly _hasVariantsField: boolean;
+    readonly currentVariantJsonFilePath: string;
     /**
      * The version of the locally package manager tool.  (Example: "1.2.3")
      */
@@ -3744,6 +3773,12 @@ export declare class RushConfiguration {
      * @internal
      */
     readonly _rushPluginsConfiguration: RushPluginsConfiguration;
+    /**
+     * The variants specified in the rush.json configuration file.
+     *
+     * @beta
+     */
+    readonly variants: ReadonlySet<string>;
     /**
      * Use RushConfiguration.loadFromConfigurationFile() or Use RushConfiguration.loadFromDefaultLocation()
      * instead.
@@ -3870,23 +3905,34 @@ export declare class RushConfiguration {
      * Instead it will be initialized in an empty state, and calling CommonVersionsConfiguration.save()
      * will create the file.
      *
-     * @deprecated Use `getCommonVersions` instead, which gets the correct common version data.
+     * @deprecated Use `getCommonVersions` instead, which gets the correct common version data
+     * for a given active variant.
      */
     get commonVersions(): CommonVersionsConfiguration;
+    /**
+     * Gets the currently-installed variant, if an installation has occurred.
+     * For Rush operations which do not take a --variant parameter, this method
+     * determines which variant, if any, was last specified when performing "rush install"
+     * or "rush update".
+     */
+    getCurrentlyInstalledVariantAsync(): Promise<string | undefined>;
     /**
      * @deprecated Use {@link Subspace.getCommonVersionsFilePath} instead
      */
-    getCommonVersionsFilePath(subspace?: Subspace): string;
+    getCommonVersionsFilePath(subspace?: Subspace, variant?: string): string;
     /**
      * @deprecated Use {@link Subspace.getCommonVersions} instead
      */
-    getCommonVersions(subspace?: Subspace): CommonVersionsConfiguration;
+    getCommonVersions(subspace?: Subspace, variant?: string): CommonVersionsConfiguration;
     /**
      * Returns a map of all direct dependencies that only have a single semantic version specifier.
      *
+     * @param subspace - The subspace to use
+     * @param variant - The name of the current variant in use by the active command.
+     *
      * @returns A map of dependency name --\> version specifier for implicitly preferred versions.
      */
-    getImplicitlyPreferredVersions(subspace?: Subspace): Map<string, string>;
+    getImplicitlyPreferredVersions(subspace?: Subspace, variant?: string): Map<string, string>;
     /**
      * @deprecated Use {@link Subspace.getRepoStateFilePath} instead
      */
@@ -3896,13 +3942,13 @@ export declare class RushConfiguration {
      */
     getRepoState(subspace?: Subspace): RepoStateFile;
     /**
-     * @deprecated Use {@link Subspace.getCommittedShrinkwrapFilename} instead
+     * @deprecated Use {@link Subspace.getCommittedShrinkwrapFilePath} instead
      */
-    getCommittedShrinkwrapFilename(subspace?: Subspace): string;
+    getCommittedShrinkwrapFilename(subspace?: Subspace, variant?: string): string;
     /**
-     * @deprecated Use {@link Subspace.getRepoStateFilePath} instead
+     * @deprecated Use {@link Subspace.getPnpmfilePath} instead
      */
-    getPnpmfilePath(subspace?: Subspace): string;
+    getPnpmfilePath(subspace?: Subspace, variant?: string): string;
     /**
      * Looks up a project in the projectsByName map.  If the project is not found,
      * then undefined is returned.
@@ -3930,6 +3976,7 @@ export declare class RushConfiguration {
      * If the path is not under any project's folder, returns undefined.
      */
     tryGetProjectForPath(currentFolderPath: string): RushConfigurationProject | undefined;
+    private _loadCurrentVariantJsonAsync;
 }
 
 /**
@@ -4165,6 +4212,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.
@@ -4392,6 +4445,10 @@ 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';
 }
 
 /**
@@ -4470,11 +4527,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.
      */
@@ -4613,6 +4678,21 @@ export declare class Subspace {
      */
     getPnpmOptions(): PnpmOptionsConfiguration | undefined;
     private _ensureDetail;
+    /**
+     * Returns the full path of the folder containing this subspace's variant-dependent configuration files
+     * such as `pnpm-lock.yaml`.
+     *
+     * Example: `common/config/subspaces/my-subspace` or `common/config/subspaces/my-subspace/variants/my-variant`
+     * @beta
+     *
+     * @remarks
+     * The following files may be variant-dependent:
+     * - Lockfiles: (i.e. - `pnpm-lock.yaml`, `npm-shrinkwrap.json`, `yarn.lock`, etc)
+     * - 'common-versions.json'
+     * - 'pnpmfile.js'/'.pnpmfile.cjs'
+     * - 'pnpm-config.js'
+     */
+    getVariantDependentSubspaceConfigFolderPath(variant: string | undefined): string;
     /**
      * Returns the full path of the folder containing this subspace's configuration files such as `pnpm-lock.yaml`.
      *
@@ -4647,6 +4727,10 @@ export declare class Subspace {
      * @beta
      */
     getTempShrinkwrapFilename(): string;
+    /**
+     * @deprecated - Use {@link Subspace.getTempShrinkwrapPreinstallFilePath} instead.
+     */
+    getTempShrinkwrapPreinstallFilename(subspaceName?: string | undefined): string;
     /**
      * The full path of a backup copy of tempShrinkwrapFilename. This backup copy is made
      * before installation begins, and can be compared to determine how the package manager
@@ -4657,32 +4741,32 @@ export declare class Subspace {
      * or `C:\MyRepo\common\temp\pnpm-lock-preinstall.yaml`
      * @beta
      */
-    getTempShrinkwrapPreinstallFilename(subspaceName?: string | undefined): string;
+    getTempShrinkwrapPreinstallFilePath(): string;
     /**
      * Gets the path to the common-versions.json config file for this subspace.
      *
      * Example: `C:\MyRepo\common\subspaces\my-subspace\common-versions.json`
      * @beta
      */
-    getCommonVersionsFilePath(): string;
+    getCommonVersionsFilePath(variant?: string): string;
     /**
      * Gets the path to the pnpm-config.json config file for this subspace.
      *
      * Example: `C:\MyRepo\common\subspaces\my-subspace\pnpm-config.json`
      * @beta
      */
-    getPnpmConfigFilePath(): string;
+    getPnpmConfigFilePath(variant?: string): string;
     /**
      * Gets the settings from the common-versions.json config file.
      * @beta
      */
-    getCommonVersions(): CommonVersionsConfiguration;
+    getCommonVersions(variant?: string): CommonVersionsConfiguration;
     /**
      * Gets the ensureConsistentVersions property from the common-versions.json config file,
      * or from the rush.json file if it isn't defined in common-versions.json
      * @beta
      */
-    get shouldEnsureConsistentVersions(): boolean;
+    shouldEnsureConsistentVersions(variant?: string): boolean;
     /**
      * Gets the path to the repo-state.json file.
      * @beta
@@ -4695,10 +4779,15 @@ export declare class Subspace {
      */
     getRepoState(): RepoStateFile;
     /**
-     * Gets the committed shrinkwrap file name.
-     * @beta
+     * @deprecated - Use {@link Subspace.getCommittedShrinkwrapFilePath} instead.
      */
     getCommittedShrinkwrapFilename(): string;
+    /**
+     * Gets the committed shrinkwrap file name for a specific variant.
+     * @param variant - The name of the current variant in use by the active command.
+     * @beta
+     */
+    getCommittedShrinkwrapFilePath(variant?: string): string;
     /**
      * Gets the absolute path for "pnpmfile.js" for a specific subspace.
      * @param subspace - The name of the current subspace in use by the active command.
@@ -4706,7 +4795,7 @@ export declare class Subspace {
      * The file path is returned even if PNPM is not configured as the package manager.
      * @beta
      */
-    getPnpmfilePath(): string;
+    getPnpmfilePath(variant?: string): string;
     /**
      * Returns true if the specified project belongs to this subspace.
      * @beta
@@ -4718,7 +4807,7 @@ export declare class Subspace {
      * Returns hash value of injected dependencies in related package.json.
      * @beta
      */
-    getPackageJsonInjectedDependenciesHash(): string | undefined;
+    getPackageJsonInjectedDependenciesHash(variant?: string): string | undefined;
 }
 
 /**

package/lib/api/CommonVersionsConfiguration.d.ts

@@ -80,7 +80,7 @@ export declare class CommonVersionsConfiguration {
      * Loads the common-versions.json data from the specified file path.
      * If the file has not been created yet, then an empty object is returned.
      */
-    static loadFromFile(jsonFilename: string, rushConfiguration?: RushConfiguration): CommonVersionsConfiguration;
+    static loadFromFile(jsonFilePath: string, rushConfiguration?: RushConfiguration): CommonVersionsConfiguration;
     private static _deserializeTable;
     private static _serializeTable;
     /**

package/lib/api/EnvironmentConfiguration.d.ts

@@ -36,6 +36,13 @@ export declare const EnvironmentVariableNames: {
      * or `0` to disallow them. (See the comments in the command-line.json file for more information).
      */
     readonly 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/
+     */
+    readonly 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".

package/lib/api/RushConfiguration.d.ts

@@ -1,4 +1,4 @@
-import { type PackageNameParser } from '@rushstack/node-core-library';
+import { type PackageNameParser, type JsonNull } from '@rushstack/node-core-library';
 import { LookupByPath } from '@rushstack/lookup-by-path';
 import { RushConfigurationProject, type IRushConfigurationProjectJson } from './RushConfigurationProject';
 import { ApprovedPackagesPolicy } from './ApprovedPackagesPolicy';
@@ -77,6 +77,13 @@ export interface IRushRepositoryJsonMultipleUrls extends IRushRepositoryJsonBase
     urls?: string[];
 }
 export type IRushRepositoryJson = IRushRepositoryJsonSingleUrl | IRushRepositoryJsonMultipleUrls;
+/**
+ * Options defining an allowed variant as part of IRushConfigurationJson.
+ */
+export interface IRushVariantOptionsJson {
+    variantName: string;
+    description: string;
+}
 /**
  * This represents the JSON data structure for the "rush.json" configuration file.
  * See rush.schema.json for documentation.
@@ -106,7 +113,13 @@ export interface IRushConfigurationJson {
     pnpmOptions?: IPnpmOptionsJson;
     yarnOptions?: IYarnOptionsJson;
     ensureConsistentVersions?: boolean;
-    variants?: unknown;
+    variants?: IRushVariantOptionsJson[];
+}
+/**
+ * This represents the JSON data structure for the "current-variant.json" data file.
+ */
+export interface ICurrentVariantJson {
+    variant: string | JsonNull;
 }
 /**
  * The filter parameters to search from all projects
@@ -139,6 +152,10 @@ export interface ITryFindRushJsonLocationOptions {
 export declare class RushConfiguration {
     private static _jsonSchema;
     private readonly _pathTrees;
+    /**
+     * @internal
+     */
+    _currentVariantJsonLoadingPromise: Promise<ICurrentVariantJson | undefined> | undefined;
     private _projects;
     private _projectsByName;
     private _projectsByTag;
@@ -243,12 +260,13 @@ export declare class RushConfiguration {
      */
     readonly subspacesFeatureEnabled: boolean;
     /**
-     * If true, the `variants` field is present in rush.json.
+     * The filename of the variant dependency data file.  By default this is
+     * called 'current-variant.json' and resides in the Rush common folder.
+     * Its data structure is defined by ICurrentVariantJson.
      *
-     * @internal
-     * @deprecated - Remove when the field is removed from the rush.json schema.
+     * Example: `C:\MyRepo\common\temp\current-variant.json`
      */
-    readonly _hasVariantsField: boolean;
+    readonly currentVariantJsonFilePath: string;
     /**
      * The version of the locally package manager tool.  (Example: "1.2.3")
      */
@@ -434,6 +452,12 @@ export declare class RushConfiguration {
      * @internal
      */
     readonly _rushPluginsConfiguration: RushPluginsConfiguration;
+    /**
+     * The variants specified in the rush.json configuration file.
+     *
+     * @beta
+     */
+    readonly variants: ReadonlySet<string>;
     /**
      * Use RushConfiguration.loadFromConfigurationFile() or Use RushConfiguration.loadFromDefaultLocation()
      * instead.
@@ -560,23 +584,34 @@ export declare class RushConfiguration {
      * Instead it will be initialized in an empty state, and calling CommonVersionsConfiguration.save()
      * will create the file.
      *
-     * @deprecated Use `getCommonVersions` instead, which gets the correct common version data.
+     * @deprecated Use `getCommonVersions` instead, which gets the correct common version data
+     * for a given active variant.
      */
     get commonVersions(): CommonVersionsConfiguration;
+    /**
+     * Gets the currently-installed variant, if an installation has occurred.
+     * For Rush operations which do not take a --variant parameter, this method
+     * determines which variant, if any, was last specified when performing "rush install"
+     * or "rush update".
+     */
+    getCurrentlyInstalledVariantAsync(): Promise<string | undefined>;
     /**
      * @deprecated Use {@link Subspace.getCommonVersionsFilePath} instead
      */
-    getCommonVersionsFilePath(subspace?: Subspace): string;
+    getCommonVersionsFilePath(subspace?: Subspace, variant?: string): string;
     /**
      * @deprecated Use {@link Subspace.getCommonVersions} instead
      */
-    getCommonVersions(subspace?: Subspace): CommonVersionsConfiguration;
+    getCommonVersions(subspace?: Subspace, variant?: string): CommonVersionsConfiguration;
     /**
      * Returns a map of all direct dependencies that only have a single semantic version specifier.
      *
+     * @param subspace - The subspace to use
+     * @param variant - The name of the current variant in use by the active command.
+     *
      * @returns A map of dependency name --\> version specifier for implicitly preferred versions.
      */
-    getImplicitlyPreferredVersions(subspace?: Subspace): Map<string, string>;
+    getImplicitlyPreferredVersions(subspace?: Subspace, variant?: string): Map<string, string>;
     /**
      * @deprecated Use {@link Subspace.getRepoStateFilePath} instead
      */
@@ -586,13 +621,13 @@ export declare class RushConfiguration {
      */
     getRepoState(subspace?: Subspace): RepoStateFile;
     /**
-     * @deprecated Use {@link Subspace.getCommittedShrinkwrapFilename} instead
+     * @deprecated Use {@link Subspace.getCommittedShrinkwrapFilePath} instead
      */
-    getCommittedShrinkwrapFilename(subspace?: Subspace): string;
+    getCommittedShrinkwrapFilename(subspace?: Subspace, variant?: string): string;
     /**
-     * @deprecated Use {@link Subspace.getRepoStateFilePath} instead
+     * @deprecated Use {@link Subspace.getPnpmfilePath} instead
      */
-    getPnpmfilePath(subspace?: Subspace): string;
+    getPnpmfilePath(subspace?: Subspace, variant?: string): string;
     /**
      * Looks up a project in the projectsByName map.  If the project is not found,
      * then undefined is returned.
@@ -620,5 +655,6 @@ export declare class RushConfiguration {
      * If the path is not under any project's folder, returns undefined.
      */
     tryGetProjectForPath(currentFolderPath: string): RushConfigurationProject | undefined;
+    private _loadCurrentVariantJsonAsync;
 }
 //# sourceMappingURL=RushConfiguration.d.ts.map

package/lib/api/Subspace.d.ts

@@ -37,6 +37,21 @@ export declare class Subspace {
      */
     getPnpmOptions(): PnpmOptionsConfiguration | undefined;
     private _ensureDetail;
+    /**
+     * Returns the full path of the folder containing this subspace's variant-dependent configuration files
+     * such as `pnpm-lock.yaml`.
+     *
+     * Example: `common/config/subspaces/my-subspace` or `common/config/subspaces/my-subspace/variants/my-variant`
+     * @beta
+     *
+     * @remarks
+     * The following files may be variant-dependent:
+     * - Lockfiles: (i.e. - `pnpm-lock.yaml`, `npm-shrinkwrap.json`, `yarn.lock`, etc)
+     * - 'common-versions.json'
+     * - 'pnpmfile.js'/'.pnpmfile.cjs'
+     * - 'pnpm-config.js'
+     */
+    getVariantDependentSubspaceConfigFolderPath(variant: string | undefined): string;
     /**
      * Returns the full path of the folder containing this subspace's configuration files such as `pnpm-lock.yaml`.
      *
@@ -71,6 +86,10 @@ export declare class Subspace {
      * @beta
      */
     getTempShrinkwrapFilename(): string;
+    /**
+     * @deprecated - Use {@link Subspace.getTempShrinkwrapPreinstallFilePath} instead.
+     */
+    getTempShrinkwrapPreinstallFilename(subspaceName?: string | undefined): string;
     /**
      * The full path of a backup copy of tempShrinkwrapFilename. This backup copy is made
      * before installation begins, and can be compared to determine how the package manager
@@ -81,32 +100,32 @@ export declare class Subspace {
      * or `C:\MyRepo\common\temp\pnpm-lock-preinstall.yaml`
      * @beta
      */
-    getTempShrinkwrapPreinstallFilename(subspaceName?: string | undefined): string;
+    getTempShrinkwrapPreinstallFilePath(): string;
     /**
      * Gets the path to the common-versions.json config file for this subspace.
      *
      * Example: `C:\MyRepo\common\subspaces\my-subspace\common-versions.json`
      * @beta
      */
-    getCommonVersionsFilePath(): string;
+    getCommonVersionsFilePath(variant?: string): string;
     /**
      * Gets the path to the pnpm-config.json config file for this subspace.
      *
      * Example: `C:\MyRepo\common\subspaces\my-subspace\pnpm-config.json`
      * @beta
      */
-    getPnpmConfigFilePath(): string;
+    getPnpmConfigFilePath(variant?: string): string;
     /**
      * Gets the settings from the common-versions.json config file.
      * @beta
      */
-    getCommonVersions(): CommonVersionsConfiguration;
+    getCommonVersions(variant?: string): CommonVersionsConfiguration;
     /**
      * Gets the ensureConsistentVersions property from the common-versions.json config file,
      * or from the rush.json file if it isn't defined in common-versions.json
      * @beta
      */
-    get shouldEnsureConsistentVersions(): boolean;
+    shouldEnsureConsistentVersions(variant?: string): boolean;
     /**
      * Gets the path to the repo-state.json file.
      * @beta
@@ -119,10 +138,15 @@ export declare class Subspace {
      */
     getRepoState(): RepoStateFile;
     /**
-     * Gets the committed shrinkwrap file name.
-     * @beta
+     * @deprecated - Use {@link Subspace.getCommittedShrinkwrapFilePath} instead.
      */
     getCommittedShrinkwrapFilename(): string;
+    /**
+     * Gets the committed shrinkwrap file name for a specific variant.
+     * @param variant - The name of the current variant in use by the active command.
+     * @beta
+     */
+    getCommittedShrinkwrapFilePath(variant?: string): string;
     /**
      * Gets the absolute path for "pnpmfile.js" for a specific subspace.
      * @param subspace - The name of the current subspace in use by the active command.
@@ -130,7 +154,7 @@ export declare class Subspace {
      * The file path is returned even if PNPM is not configured as the package manager.
      * @beta
      */
-    getPnpmfilePath(): string;
+    getPnpmfilePath(variant?: string): string;
     /**
      * Returns true if the specified project belongs to this subspace.
      * @beta
@@ -142,6 +166,6 @@ export declare class Subspace {
      * Returns hash value of injected dependencies in related package.json.
      * @beta
      */
-    getPackageJsonInjectedDependenciesHash(): string | undefined;
+    getPackageJsonInjectedDependenciesHash(variant?: string): string | undefined;
 }
 //# sourceMappingURL=Subspace.d.ts.map

package/lib/api/Variants.d.ts

@@ -0,0 +1,8 @@
+import type { CommandLineStringParameter, ICommandLineStringDefinition } from '@rushstack/ts-command-line';
+import type { RushConfiguration } from './RushConfiguration';
+/**
+ * Provides the parameter configuration for '--variant'.
+ */
+export declare const VARIANT_PARAMETER: ICommandLineStringDefinition;
+export declare function getVariantAsync(variantsParameter: CommandLineStringParameter | undefined, rushConfiguration: RushConfiguration, defaultToCurrentlyInstalledVariant: boolean): Promise<string | undefined>;
+//# sourceMappingURL=Variants.d.ts.map

package/lib/api/Variants.js

@@ -0,0 +1 @@
+module.exports = require("../../lib-shim/index")._rushSdk_loadInternalModule("api/Variants");

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

@@ -10,7 +10,8 @@ export declare class AddAction extends BaseAddAndRemoveAction {
     private readonly _devDependencyFlag;
     private readonly _peerDependencyFlag;
     private readonly _makeConsistentFlag;
+    private readonly _variantParameter;
     constructor(parser: RushCommandLineParser);
-    getUpdateOptions(): IPackageJsonUpdaterRushAddOptions;
+    getUpdateOptionsAsync(): Promise<IPackageJsonUpdaterRushAddOptions>;
 }
 //# sourceMappingURL=AddAction.d.ts.map

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

@@ -29,7 +29,7 @@ export declare abstract class BaseAddAndRemoveAction extends BaseRushAction {
     protected abstract readonly _packageNameList: CommandLineStringListParameter;
     protected get specifiedPackageNameList(): readonly string[];
     constructor(options: IBaseRushActionOptions);
-    protected abstract getUpdateOptions(): IPackageJsonUpdaterRushBaseUpdateOptions;
+    protected abstract getUpdateOptionsAsync(): Promise<IPackageJsonUpdaterRushBaseUpdateOptions>;
     protected getProjects(): RushConfigurationProject[];
     runAsync(): Promise<void>;
 }

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

@@ -1,4 +1,4 @@
-import type { CommandLineFlagParameter, CommandLineIntegerParameter, IRequiredCommandLineIntegerParameter } from '@rushstack/ts-command-line';
+import type { CommandLineFlagParameter, CommandLineIntegerParameter, CommandLineStringParameter, IRequiredCommandLineIntegerParameter } from '@rushstack/ts-command-line';
 import { type ITerminal } from '@rushstack/terminal';
 import { BaseRushAction, type IBaseRushActionOptions } from './BaseRushAction';
 import type { IInstallManagerOptions } from '../../logic/base/BaseInstallManagerTypes';
@@ -8,6 +8,7 @@ import { type SelectionParameterSet } from '../parsing/SelectionParameterSet';
  */
 export declare abstract class BaseInstallAction extends BaseRushAction {
     protected readonly _terminal: ITerminal;
+    protected readonly _variantParameter: CommandLineStringParameter;
     protected readonly _purgeParameter: CommandLineFlagParameter;
     protected readonly _bypassPolicyParameter: CommandLineFlagParameter;
     protected readonly _noLinkParameter: CommandLineFlagParameter;

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

@@ -5,6 +5,7 @@ export declare class CheckAction extends BaseRushAction {
     private readonly _jsonFlag;
     private readonly _verboseFlag;
     private readonly _subspaceParameter;
+    private readonly _variantParameter;
     constructor(parser: RushCommandLineParser);
     protected runAsync(): Promise<void>;
 }