@rushstack/rush-sdk 5.108.0 → 5.109.1-pr3481.21

package/dist/rush-lib.d.ts

@@ -132,6 +132,55 @@ export declare class ApprovedPackagesPolicy {
     constructor(rushConfiguration: RushConfiguration, rushConfigurationJson: IRushConfigurationJson);
 }
 
+/**
+ * A base class for flag file.
+ * @internal
+ */
+export declare class _BaseFlag<T extends object = JsonObject> {
+    /**
+     * Flag file path
+     */
+    readonly path: string;
+    /**
+     * Content of the flag
+     */
+    protected _state: T;
+    /**
+     * Whether the current state is modified
+     */
+    protected _isModified: boolean;
+    /**
+     * Creates a new flag file
+     * @param folderPath - the folder that this flag is managing
+     * @param state - optional, the state that should be managed or compared
+     */
+    constructor(folderPath: string, state?: Partial<T>);
+    /**
+     * Returns true if the file exists and the contents match the current state.
+     */
+    isValid(): boolean;
+    /**
+     * Writes the flag file to disk with the current state
+     */
+    create(): void;
+    /**
+     * Merge new data into current state by "merge"
+     */
+    mergeFromObject(data: JsonObject): void;
+    /**
+     * Writes the flag file to disk with the current state if modified
+     */
+    saveIfModified(): void;
+    /**
+     * Removes the flag file
+     */
+    clear(): void;
+    /**
+     * Returns Name of the flag file
+     */
+    protected get flagName(): string;
+}
+
 /**
  * Use this class to load and save the "common/config/rush/build-cache.json" config file.
  * This file provides configuration options for cached project build output.
@@ -771,11 +820,16 @@ export declare const EnvironmentVariableNames: {
      * Explicitly specifies the path for the `tar` binary that is invoked by certain Rush operations.
      */
     readonly RUSH_TAR_BINARY_PATH: "RUSH_TAR_BINARY_PATH";
+    /**
+     * Internal variable used by `rushx` when recursively invoking another `rushx` process, to avoid
+     * nesting event hooks.
+     */
+    readonly _RUSH_RECURSIVE_RUSHX_CALL: "_RUSH_RECURSIVE_RUSHX_CALL";
     /**
      * Internal variable that explicitly specifies the path for the version of `@microsoft/rush-lib` being executed.
      * Will be set upon loading Rush.
      */
-    readonly RUSH_LIB_PATH: "_RUSH_LIB_PATH";
+    readonly _RUSH_LIB_PATH: "_RUSH_LIB_PATH";
     /**
      * When Rush executes shell scripts, it sometimes changes the working directory to be a project folder or
      * the repository root folder.  The original working directory (where the Rush command was invoked) is assigned
@@ -786,6 +840,16 @@ export declare const EnvironmentVariableNames: {
      * assign when they execute lifecycle scripts.
      */
     readonly RUSH_INVOKED_FOLDER: "RUSH_INVOKED_FOLDER";
+    /**
+     * When running a hook script, this environment variable communicates the original arguments
+     * passed to the `rush` or `rushx` command.
+     *
+     * @remarks
+     * Unlike `RUSH_INVOKED_FOLDER`, the `RUSH_INVOKED_ARGS` variable is only available for hook scripts.
+     * Other lifecycle scripts should not make assumptions about Rush's command line syntax
+     * if Rush did not explicitly pass along command-line parameters to their process.
+     */
+    readonly RUSH_INVOKED_ARGS: "RUSH_INVOKED_ARGS";
 };
 
 /**
@@ -808,7 +872,15 @@ declare enum Event_2 {
     /**
      * Post Rush build event
      */
-    postRushBuild = 4
+    postRushBuild = 4,
+    /**
+     * Start of rushx execution event
+     */
+    preRushx = 5,
+    /**
+     * End of rushx execution event
+     */
+    postRushx = 6
 }
 export { Event_2 as Event }
 
@@ -1284,6 +1356,11 @@ export declare interface IExperimentsJson {
      * in common/config/rush/command-line.json.
      */
     phasedCommands?: boolean;
+    /**
+     * If true, rush install or rush update implicitly specify --ignore-scripts during pnpm install,
+     * and run install lifecycle scripts by pnpm rebuild --pending after pnpm install successfully.
+     */
+    deferredInstallationScripts?: boolean;
     /**
      * If true, perform a clean install after when running `rush install` or `rush update` if the
      * `.npmrc` file has changed since the last install.
@@ -1363,6 +1440,51 @@ declare interface IIndividualVersionJson extends IVersionPolicyJson {
     lockedMajor?: number;
 }
 
+/**
+ * This represents the JSON data structure for the "last-install.flag" file.
+ * @internal
+ */
+export declare interface _ILastInstallFlagJson {
+    /**
+     * Current node version
+     */
+    node: string;
+    /**
+     * Current package manager name
+     */
+    packageManager: PackageManagerName;
+    /**
+     * Current package manager version
+     */
+    packageManagerVersion: string;
+    /**
+     * Current rush json folder
+     */
+    rushJsonFolder: string;
+    /**
+     * The content of package.json, used in the flag file of autoinstaller
+     */
+    packageJson?: IPackageJson;
+    /**
+     * Same with pnpmOptions.pnpmStorePath in rush.json
+     */
+    storePath?: string;
+    /**
+     * True when "useWorkspaces" is true in rush.json
+     */
+    workspaces?: true;
+    /**
+     * True when user explicitly specify "--ignore-scripts" CLI parameter or deferredInstallationScripts
+     */
+    ignoreScripts?: true;
+    /**
+     * When specified, it is a list of selected projects during partial install
+     * It is undefined when full install
+     */
+    selectedProjectNames?: string[];
+    [key: string]: unknown;
+}
+
 /**
  * Options to pass to the rush "launch" functions.
  *
@@ -1381,15 +1503,22 @@ export declare interface ILaunchOptions {
      */
     alreadyReportedNodeTooNewError?: boolean;
     /**
-     * Used to specify Rush plugins that are dependencies of the "\@microsoft/rush" package.
+     * Pass along the terminal provider from the CLI version selector.
      *
-     * @internal
+     * @privateRemarks
+     * We should remove this.  The version selector package can be very old.  It's unwise for
+     * `rush-lib` to rely on a potentially ancient `ITerminalProvider` implementation.
      */
-    builtInPluginConfigurations?: _IBuiltInPluginConfiguration[];
+    terminalProvider?: ITerminalProvider;
     /**
-     * Used to specify terminal how to write a message
+     * Used only by `@microsoft/rush/lib/start-dev.js` during development.
+     * Specifies Rush devDependencies of the `@microsoft/rush` to be manually loaded.
+     *
+     * @remarks
+     * Marked as `@internal` because `IBuiltInPluginConfiguration` is internal.
+     * @internal
      */
-    terminalProvider?: ITerminalProvider;
+    builtInPluginConfigurations?: _IBuiltInPluginConfiguration[];
 }
 
 /**
@@ -1851,6 +1980,10 @@ export declare interface _IPnpmOptionsJson extends IPackageManagerOptionsJsonBas
      * {@inheritDoc PnpmOptionsConfiguration.resolutionMode}
      */
     resolutionMode?: PnpmResolutionMode;
+    /**
+     * {@inheritDoc PnpmOptionsConfiguration.autoInstallPeers}
+     */
+    autoInstallPeers?: boolean;
 }
 
 declare interface IPnpmPackageExtension {
@@ -1950,6 +2083,7 @@ declare interface IRushConfigurationProjectJson {
     skipRushCheck?: boolean;
     publishFolder?: string;
     tags?: string[];
+    splitWorkspace?: boolean;
 }
 
 /**
@@ -1974,6 +2108,16 @@ declare interface IRushConfigurationProjectOptions {
     allowedProjectTags: Set<string> | undefined;
 }
 
+/**
+ * The filter parameters to search from all projects.
+ */
+declare interface IRushConfigurationProjectsFilter {
+    /**
+     * If true, filter out projects that specify splitWorkspace as true.
+     */
+    splitWorkspace: boolean;
+}
+
 /**
  * Part of IRushConfigurationJson.
  */
@@ -2264,19 +2408,9 @@ export declare interface _IYarnOptionsJson extends IPackageManagerOptionsJsonBas
  * it can invalidate the last install.
  * @internal
  */
-export declare class _LastInstallFlag {
-    private _state;
-    /**
-     * Returns the full path to the flag file
-     */
-    readonly path: string;
-    /**
-     * Creates a new LastInstall flag
-     * @param folderPath - the folder that this flag is managing
-     * @param state - optional, the state that should be managed or compared
-     */
-    constructor(folderPath: string, state?: JsonObject);
+export declare class _LastInstallFlag extends _BaseFlag<_ILastInstallFlagJson> {
     /**
+     * @override
      * Returns true if the file exists and the contents match the current state.
      */
     isValid(options?: _ILockfileValidityCheckOptions): boolean;
@@ -2290,14 +2424,6 @@ export declare class _LastInstallFlag {
         rushVerb: string;
     }): boolean;
     private _isValid;
-    /**
-     * Writes the flag file to disk with the current state
-     */
-    create(): void;
-    /**
-     * Removes the flag file
-     */
-    clear(): void;
     /**
      * Returns the name of the flag file
      */
@@ -2917,6 +3043,13 @@ export declare class PnpmOptionsConfiguration extends PackageManagerOptionsConfi
      * The default value is true.  (For now.)
      */
     readonly useWorkspaces: boolean;
+    /**
+     * When true, any missing non-optional peer dependencies are automatically installed.
+     *
+     * @remarks
+     * The default value is same as PNPM default value.  (In PNPM 8.x, this value is true)
+     */
+    readonly autoInstallPeers: boolean | undefined;
     /**
      * The "globalOverrides" setting provides a simple mechanism for overriding version selections
      * for all dependencies of all projects in the monorepo workspace.  The settings are copied
@@ -3164,7 +3297,7 @@ export declare class Rush {
      *
      * Even though this API isn't documented, it is still supported for legacy compatibility.
      */
-    static launch(launcherVersion: string, arg: ILaunchOptions): void;
+    static launch(launcherVersion: string, options: ILaunchOptions): void;
     /**
      * This API is used by the `@microsoft/rush` front end to launch the "rushx" command-line.
      * Third-party tools should not use this API.  Instead, they should execute the "rushx" binary
@@ -3218,6 +3351,8 @@ export declare class RushConfiguration {
     private _projects;
     private _projectsByName;
     private _projectsByTag;
+    private _filteredProjectsCache;
+    private _hasSplitWorkspaceProject;
     private _commonVersionsConfigurationsByVariant;
     /**
      * The name of the package manager being used to install dependencies
@@ -3272,6 +3407,12 @@ export declare class RushConfiguration {
      * Example: `C:\MyRepo\common\temp`
      */
     readonly commonTempFolder: string;
+    /**
+     * The folder where temporary files will be stored.  This is always a subfolder called "temp"
+     * under the common folder.
+     * Example: `C:\MyRepo\common\temp-split`
+     */
+    readonly commonTempSplitFolder: string;
     /**
      * The folder where automation scripts are stored.  This is always a subfolder called "scripts"
      * under the common folder.
@@ -3326,6 +3467,21 @@ export declare class RushConfiguration {
      * or `C:\MyRepo\common\temp\pnpm-lock-preinstall.yaml`
      */
     readonly tempShrinkwrapPreinstallFilename: string;
+    /**
+     * The filename (without any path) of the shrinkwrap file for split workspace that is used by the package manager.
+     * @remarks
+     * This property merely reports the filename; the file itself may not actually exist.
+     * Example: `pnpm-lock.yaml`
+     */
+    readonly splitWorkspaceShrinkwrapFilename: string;
+    /**
+     * The full path of the temporary shrinkwrap file for split workspace that is used during
+     * "rush install". This file may get rewritten by the package manager during installation.
+     * @remarks
+     * This property merely reports the filename; the file itself may not actually exist.
+     * Example: `C:\MyRepo\common\temp-split\pnpm-lock.yaml`
+     */
+    readonly tempSplitWorkspaceShrinkwrapFilename: string;
     /**
      * The filename of the variant dependency data file.  By default this is
      * called 'current-variant.json' resides in the Rush common folder.
@@ -3592,6 +3748,11 @@ export declare class RushConfiguration {
      * @beta
      */
     get projectsByTag(): ReadonlyMap<string, ReadonlySet<RushConfigurationProject>>;
+    /**
+     * Search for projects according to filter
+     * @beta
+     */
+    getFilteredProjects(filter: IRushConfigurationProjectsFilter): RushConfigurationProject[];
     /**
      * Settings from the common-versions.json config file.
      * @remarks
@@ -3610,6 +3771,10 @@ export declare class RushConfiguration {
      * or "rush update".
      */
     get currentInstalledVariant(): string | undefined;
+    /**
+     * Is there any split workspace project.
+     */
+    get hasSplitWorkspaceProject(): boolean;
     /**
      * Gets the path to the common-versions.json config file for a specific variant.
      * @param variant - The name of the current variant in use by the active command.
@@ -3642,6 +3807,11 @@ export declare class RushConfiguration {
      * @param variant - The name of the current variant in use by the active command.
      */
     getCommittedShrinkwrapFilename(variant?: string | undefined): string;
+    /**
+     * Gets the committed shrinkwrap file name for split workspace.
+     * @param variant - The name of the current variant in use by the active command.
+     */
+    getCommittedSplitWorkspaceShrinkwrapFilename(): string;
     /**
      * Gets the absolute path for "pnpmfile.js" for a specific variant.
      * @param variant - The name of the current variant in use by the active command.
@@ -3677,6 +3847,12 @@ export declare class RushConfiguration {
      */
     tryGetProjectForPath(currentFolderPath: string): RushConfigurationProject | undefined;
     private _getVariantConfigFolderPath;
+    /**
+     * Split workspace can only works on PNPM with "useWorkspaces" enabled.
+     * The workspace project can NOT depend on a split workspace project.
+     * The split workspace project CAN depend on a workspace project.
+     */
+    private _validateSplitWorkspaceRelationships;
 }
 
 /**
@@ -3792,6 +3968,11 @@ export declare class RushConfigurationProject {
      * @beta
      */
     readonly tags: ReadonlySet<string>;
+    /**
+     * Whether this project is a split workspace project.
+     * @beta
+     */
+    readonly splitWorkspace: boolean;
     /** @internal */
     constructor(options: IRushConfigurationProjectOptions);
     /**
@@ -3901,6 +4082,12 @@ export declare class RushConstants {
      * Example: `C:\MyRepo\common\temp`
      */
     static readonly rushTempFolderName: string;
+    /**
+     * The folder name ("temp-split") under the common folder, or under the .rush folder in each project's directory where
+     * temporary files will be stored.
+     * Example: `C:\MyRepo\common\temp-split`
+     */
+    static readonly rushTempSplitFolderName: string;
     /**
      * The folder name ("projects") where temporary projects will be stored.
      * Example: `C:\MyRepo\common\temp\projects`

package/lib/api/EnvironmentConfiguration.d.ts

@@ -155,11 +155,16 @@ export declare const EnvironmentVariableNames: {
      * Explicitly specifies the path for the `tar` binary that is invoked by certain Rush operations.
      */
     readonly RUSH_TAR_BINARY_PATH: "RUSH_TAR_BINARY_PATH";
+    /**
+     * Internal variable used by `rushx` when recursively invoking another `rushx` process, to avoid
+     * nesting event hooks.
+     */
+    readonly _RUSH_RECURSIVE_RUSHX_CALL: "_RUSH_RECURSIVE_RUSHX_CALL";
     /**
      * Internal variable that explicitly specifies the path for the version of `@microsoft/rush-lib` being executed.
      * Will be set upon loading Rush.
      */
-    readonly RUSH_LIB_PATH: "_RUSH_LIB_PATH";
+    readonly _RUSH_LIB_PATH: "_RUSH_LIB_PATH";
     /**
      * When Rush executes shell scripts, it sometimes changes the working directory to be a project folder or
      * the repository root folder.  The original working directory (where the Rush command was invoked) is assigned
@@ -170,6 +175,16 @@ export declare const EnvironmentVariableNames: {
      * assign when they execute lifecycle scripts.
      */
     readonly RUSH_INVOKED_FOLDER: "RUSH_INVOKED_FOLDER";
+    /**
+     * When running a hook script, this environment variable communicates the original arguments
+     * passed to the `rush` or `rushx` command.
+     *
+     * @remarks
+     * Unlike `RUSH_INVOKED_FOLDER`, the `RUSH_INVOKED_ARGS` variable is only available for hook scripts.
+     * Other lifecycle scripts should not make assumptions about Rush's command line syntax
+     * if Rush did not explicitly pass along command-line parameters to their process.
+     */
+    readonly RUSH_INVOKED_ARGS: "RUSH_INVOKED_ARGS";
 };
 /**
  * Provides Rush-specific environment variable data. All Rush environment variables must start with "RUSH_". This class

package/lib/api/EventHooks.d.ts

@@ -19,7 +19,15 @@ export declare enum Event {
     /**
      * Post Rush build event
      */
-    postRushBuild = 4
+    postRushBuild = 4,
+    /**
+     * Start of rushx execution event
+     */
+    preRushx = 5,
+    /**
+     * End of rushx execution event
+     */
+    postRushx = 6
 }
 /**
  * This class represents Rush event hooks configured for this repo.

package/lib/api/ExperimentsConfiguration.d.ts

@@ -41,6 +41,11 @@ export interface IExperimentsJson {
      * in common/config/rush/command-line.json.
      */
     phasedCommands?: boolean;
+    /**
+     * If true, rush install or rush update implicitly specify --ignore-scripts during pnpm install,
+     * and run install lifecycle scripts by pnpm rebuild --pending after pnpm install successfully.
+     */
+    deferredInstallationScripts?: boolean;
     /**
      * If true, perform a clean install after when running `rush install` or `rush update` if the
      * `.npmrc` file has changed since the last install.

package/lib/api/LastInstallFlag.d.ts

@@ -1,6 +1,52 @@
-import { type JsonObject } from '@rushstack/node-core-library';
+import { type IPackageJson } from '@rushstack/node-core-library';
+import { BaseFlag } from './base/BaseFlag';
+import type { PackageManagerName } from './packageManager/PackageManager';
 import type { RushConfiguration } from './RushConfiguration';
 export declare const LAST_INSTALL_FLAG_FILE_NAME: string;
+/**
+ * This represents the JSON data structure for the "last-install.flag" file.
+ * @internal
+ */
+export interface ILastInstallFlagJson {
+    /**
+     * Current node version
+     */
+    node: string;
+    /**
+     * Current package manager name
+     */
+    packageManager: PackageManagerName;
+    /**
+     * Current package manager version
+     */
+    packageManagerVersion: string;
+    /**
+     * Current rush json folder
+     */
+    rushJsonFolder: string;
+    /**
+     * The content of package.json, used in the flag file of autoinstaller
+     */
+    packageJson?: IPackageJson;
+    /**
+     * Same with pnpmOptions.pnpmStorePath in rush.json
+     */
+    storePath?: string;
+    /**
+     * True when "useWorkspaces" is true in rush.json
+     */
+    workspaces?: true;
+    /**
+     * True when user explicitly specify "--ignore-scripts" CLI parameter or deferredInstallationScripts
+     */
+    ignoreScripts?: true;
+    /**
+     * When specified, it is a list of selected projects during partial install
+     * It is undefined when full install
+     */
+    selectedProjectNames?: string[];
+    [key: string]: unknown;
+}
 /**
  * @internal
  */
@@ -15,19 +61,9 @@ export interface ILockfileValidityCheckOptions {
  * it can invalidate the last install.
  * @internal
  */
-export declare class LastInstallFlag {
-    private _state;
-    /**
-     * Returns the full path to the flag file
-     */
-    readonly path: string;
-    /**
-     * Creates a new LastInstall flag
-     * @param folderPath - the folder that this flag is managing
-     * @param state - optional, the state that should be managed or compared
-     */
-    constructor(folderPath: string, state?: JsonObject);
+export declare class LastInstallFlag extends BaseFlag<ILastInstallFlagJson> {
     /**
+     * @override
      * Returns true if the file exists and the contents match the current state.
      */
     isValid(options?: ILockfileValidityCheckOptions): boolean;
@@ -41,14 +77,6 @@ export declare class LastInstallFlag {
         rushVerb: string;
     }): boolean;
     private _isValid;
-    /**
-     * Writes the flag file to disk with the current state
-     */
-    create(): void;
-    /**
-     * Removes the flag file
-     */
-    clear(): void;
     /**
      * Returns the name of the flag file
      */
@@ -69,5 +97,14 @@ export declare class LastInstallFlagFactory {
      * @internal
      */
     static getCommonTempFlag(rushConfiguration: RushConfiguration, extraState?: Record<string, string>): LastInstallFlag;
+    /**
+     * Gets the LastInstall flag and sets the current state. This state is used to compare
+     * against the last-known-good state tracked by the LastInstall flag.
+     * @param rushConfiguration - the configuration of the Rush repo to get the install
+     * state from
+     *
+     * @internal
+     */
+    static getCommonTempSplitFlag(rushConfiguration: RushConfiguration): LastInstallFlag;
 }
 //# sourceMappingURL=LastInstallFlag.d.ts.map

package/lib/api/LastLinkFlag.d.ts

@@ -1,4 +1,4 @@
-import { LastInstallFlag } from './LastInstallFlag';
+import { BaseFlag } from './base/BaseFlag';
 import type { RushConfiguration } from './RushConfiguration';
 export declare const LAST_LINK_FLAG_FILE_NAME: string;
 /**
@@ -6,11 +6,7 @@ export declare const LAST_LINK_FLAG_FILE_NAME: string;
  * indicates that linking was completed successfully.
  * @internal
  */
-export declare class LastLinkFlag extends LastInstallFlag {
-    /**
-     * @override
-     */
-    isValid(): boolean;
+export declare class LastLinkFlag extends BaseFlag {
     /**
      * @override
      */

package/lib/api/Rush.d.ts

@@ -19,15 +19,22 @@ export interface ILaunchOptions {
      */
     alreadyReportedNodeTooNewError?: boolean;
     /**
-     * Used to specify Rush plugins that are dependencies of the "\@microsoft/rush" package.
+     * Pass along the terminal provider from the CLI version selector.
      *
-     * @internal
+     * @privateRemarks
+     * We should remove this.  The version selector package can be very old.  It's unwise for
+     * `rush-lib` to rely on a potentially ancient `ITerminalProvider` implementation.
      */
-    builtInPluginConfigurations?: IBuiltInPluginConfiguration[];
+    terminalProvider?: ITerminalProvider;
     /**
-     * Used to specify terminal how to write a message
+     * Used only by `@microsoft/rush/lib/start-dev.js` during development.
+     * Specifies Rush devDependencies of the `@microsoft/rush` to be manually loaded.
+     *
+     * @remarks
+     * Marked as `@internal` because `IBuiltInPluginConfiguration` is internal.
+     * @internal
      */
-    terminalProvider?: ITerminalProvider;
+    builtInPluginConfigurations?: IBuiltInPluginConfiguration[];
 }
 /**
  * General operations for the Rush engine.
@@ -48,7 +55,7 @@ export declare class Rush {
      *
      * Even though this API isn't documented, it is still supported for legacy compatibility.
      */
-    static launch(launcherVersion: string, arg: ILaunchOptions): void;
+    static launch(launcherVersion: string, options: ILaunchOptions): void;
     /**
      * This API is used by the `@microsoft/rush` front end to launch the "rushx" command-line.
      * Third-party tools should not use this API.  Instead, they should execute the "rushx" binary