@rushstack/rush-sdk 5.89.0 → 5.90.0-pr3481.15

package/dist/rush-lib.d.ts

@@ -131,6 +131,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 lodash "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.
@@ -878,6 +927,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.
@@ -949,6 +1003,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.
  *
@@ -1224,14 +1323,14 @@ export declare interface IPhase {
      */
     name: string;
     /**
-     * If set to "true," this this phase was generated from a bulk command, and
+     * If set to `true,` this this phase was generated from a bulk command, and
      * was not explicitly defined in the command-line.json file.
      */
     isSynthetic: boolean;
     /**
      * This property is used in the name of the filename for the logs generated by this
      * phase. This is a filesystem-safe version of the phase name. For example,
-     * a phase with name "_phase:compile" has a `logFilenameIdentifier` of "_phase_compile".
+     * a phase with name `_phase:compile` has a `logFilenameIdentifier` of `_phase_compile`.
      */
     logFilenameIdentifier: string;
     /**
@@ -1246,13 +1345,24 @@ export declare interface IPhase {
         upstream: Set<IPhase>;
     };
     /**
-     * Normally Rush requires that each project's package.json has a \"scripts\" entry matching the phase name. To disable this check, set \"ignoreMissingScript\" to true.
+     * Normally Rush requires that each project's package.json has a `"scripts"` entry matching the phase name.
+     * To disable this check, set `ignoreMissingScript` to true.
      */
     ignoreMissingScript: boolean;
     /**
-     * By default, Rush returns a nonzero exit code if errors or warnings occur during a command. If this option is set to \"true\", Rush will return a zero exit code if warnings occur during the execution of this phase.
+     * By default, Rush returns a nonzero exit code if errors or warnings occur during a command. If this option is
+     * set to `true`, Rush will return a zero exit code if warnings occur during the execution of this phase.
      */
     allowWarningsOnSuccess: boolean;
+    /**
+     * (Optional) If the `shellCommand` field is set for a bulk command, Rush will invoke it for each
+     * selected project; otherwise, Rush will invoke the package.json `"scripts"` entry matching Rush command/phase name.
+     *
+     * This string is the path to a script that will be invoked using the OS shell. The working directory will be
+     * the folder that contains rush.json.  If custom parameters are associated with this command, their
+     * values will be appended to the end of this string.
+     */
+    shellCommand?: string;
 }
 
 /**
@@ -1405,6 +1515,7 @@ declare interface IRushConfigurationProjectJson {
     skipRushCheck?: boolean;
     publishFolder?: string;
     tags?: string[];
+    splitWorkspace?: boolean;
 }
 
 /**
@@ -1429,6 +1540,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.
  */
@@ -1692,19 +1813,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;
@@ -1718,14 +1829,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
      */
@@ -2041,7 +2144,10 @@ export declare class PackageJsonEditor {
     private _modified;
     private _sourceData;
     readonly filePath: string;
-    private constructor();
+    /**
+     * @internal
+     */
+    protected constructor(filepath: string, data: IPackageJson);
     static load(filePath: string): PackageJsonEditor;
     static fromObject(object: IPackageJson, filename: string): PackageJsonEditor;
     get name(): string;
@@ -2501,6 +2607,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
@@ -2555,6 +2663,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.
@@ -2609,6 +2723,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.
@@ -2864,6 +2993,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
@@ -2882,6 +3016,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.
@@ -2914,6 +3052,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.
@@ -2949,6 +3092,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;
 }
 
 /**
@@ -2961,6 +3110,7 @@ export declare class RushConfigurationProject {
     private _versionPolicy;
     private _dependencyProjects;
     private _consumingProjects;
+    private _packageJson;
     /**
      * The name of the NPM package.  An error is reported if this name is not
      * identical to packageJson.name.
@@ -3012,7 +3162,7 @@ export declare class RushConfigurationProject {
     /**
      * The parsed NPM "package.json" file from projectFolder.
      */
-    readonly packageJson: IPackageJson;
+    get packageJson(): IPackageJson;
     /**
      * A useful wrapper around the package.json file for making modifications
      * @beta
@@ -3063,6 +3213,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);
     /**
@@ -3172,6 +3327,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.89.0",
+  "version": "5.90.0-pr3481.15",
   "description": "An API for interacting with the Rush engine",
   "repository": {
     "type": "git",
@@ -12,21 +12,21 @@
   "typings": "dist/rush-lib.d.ts",
   "license": "MIT",
   "dependencies": {
-    "@rushstack/node-core-library": "3.53.3",
     "@types/node-fetch": "1.6.9",
-    "tapable": "2.2.1"
+    "tapable": "2.2.1",
+    "@rushstack/node-core-library": "3.53.3"
   },
   "devDependencies": {
-    "@microsoft/rush-lib": "5.89.0",
-    "@rushstack/eslint-config": "3.1.1",
-    "@rushstack/heft": "0.49.1",
-    "@rushstack/heft-node-rig": "1.11.12",
-    "@rushstack/stream-collator": "4.0.220",
-    "@rushstack/ts-command-line": "4.13.1",
-    "@rushstack/terminal": "0.3.89",
+    "@microsoft/rush-lib": "5.90.0-pr3481.15",
     "@types/heft-jest": "1.0.1",
     "@types/semver": "7.3.5",
-    "@types/webpack-env": "1.13.0"
+    "@types/webpack-env": "1.13.0",
+    "@rushstack/eslint-config": "3.1.1",
+    "@rushstack/heft-node-rig": "1.12.0",
+    "@rushstack/stream-collator": "4.0.223",
+    "@rushstack/heft": "0.49.3",
+    "@rushstack/ts-command-line": "4.13.1",
+    "@rushstack/terminal": "0.3.92"
   },
   "scripts": {
     "build": "heft build --clean",