@rushstack/rush-sdk 5.124.3 → 5.124.5

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.43.4"
+      "packageVersion": "7.43.5"
     }
   ]
 }

package/lib/cli/RushCommandLineParser.d.ts

@@ -35,7 +35,7 @@ export declare class RushCommandLineParser extends CommandLineParser {
      */
     static shouldRestrictConsoleOutput(): boolean;
     flushTelemetry(): void;
-    execute(args?: string[]): Promise<boolean>;
+    executeAsync(args?: string[]): Promise<boolean>;
     protected onExecute(): Promise<void>;
     private _normalizeOptions;
     private _wrapOnExecuteAsync;

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

@@ -1,9 +1,8 @@
-import type { CommandLineFlagParameter, CommandLineIntegerParameter, CommandLineStringParameter, IRequiredCommandLineIntegerParameter } from '@rushstack/ts-command-line';
+import type { CommandLineFlagParameter, CommandLineIntegerParameter, 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';
-import type { SelectionParameterSet } from '../parsing/SelectionParameterSet';
-import type { Subspace } from '../../api/Subspace';
+import { type SelectionParameterSet } from '../parsing/SelectionParameterSet';
 /**
  * This is the common base class for InstallAction and UpdateAction.
  */
@@ -17,13 +16,11 @@ export declare abstract class BaseInstallAction extends BaseRushAction {
     protected readonly _maxInstallAttempts: IRequiredCommandLineIntegerParameter;
     protected readonly _ignoreHooksParameter: CommandLineFlagParameter;
     protected readonly _offlineParameter: CommandLineFlagParameter;
-    protected readonly _subspaceParameter: CommandLineStringParameter;
     protected _selectionParameters?: SelectionParameterSet;
     constructor(options: IBaseRushActionOptions);
-    protected abstract buildInstallOptionsAsync(): Promise<IInstallManagerOptions>;
-    protected getTargetSubspace(): Subspace;
+    protected abstract buildInstallOptionsAsync(): Promise<Omit<IInstallManagerOptions, 'subspace'>>;
     protected runAsync(): Promise<void>;
-    private _doInstall;
+    private _doInstallAsync;
     private _collectTelemetry;
 }
 //# sourceMappingURL=BaseInstallAction.d.ts.map

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

@@ -25,36 +25,36 @@ export declare class ChangeAction extends BaseRushAction {
     /**
      * The main loop which prompts the user for information on changed projects.
      */
-    private _promptForChangeFileData;
+    private _promptForChangeFileDataAsync;
     /**
      * Asks all questions which are needed to generate changelist for a project.
      */
-    private _askQuestions;
-    private _promptForComments;
+    private _askQuestionsAsync;
+    private _promptForCommentsAsync;
     private _getBumpOptions;
     private _isEmailRequired;
     /**
      * Will determine a user's email by first detecting it from their Git config,
      * or will ask for it if it is not found or the Git config is wrong.
      */
-    private _detectOrAskForEmail;
+    private _detectOrAskForEmailAsync;
     private _detectEmail;
     /**
      * Detects the user's email address from their Git configuration, prompts the user to approve the
      * detected email. It returns undefined if it cannot be detected.
      */
-    private _detectAndConfirmEmail;
+    private _detectAndConfirmEmailAsync;
     /**
      * Asks the user for their email address
      */
-    private _promptForEmail;
+    private _promptForEmailAsync;
     private _warnUnstagedChanges;
     /**
      * Writes change files to the common/changes folder. Will prompt for overwrite if file already exists.
      */
-    private _writeChangeFiles;
-    private _writeChangeFile;
-    private _promptForOverwrite;
+    private _writeChangeFilesAsync;
+    private _writeChangeFileAsync;
+    private _promptForOverwriteAsync;
     /**
      * Writes a file to disk, ensuring the directory structure up to that point exists
      */

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

@@ -4,6 +4,6 @@ import type { RushCommandLineParser } from '../RushCommandLineParser';
 export declare class InstallAction extends BaseInstallAction {
     private readonly _checkOnlyParameter;
     constructor(parser: RushCommandLineParser);
-    protected buildInstallOptionsAsync(): Promise<IInstallManagerOptions>;
+    protected buildInstallOptionsAsync(): Promise<Omit<IInstallManagerOptions, 'subspace'>>;
 }
 //# sourceMappingURL=InstallAction.d.ts.map

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

@@ -6,6 +6,6 @@ export declare class UpdateAction extends BaseInstallAction {
     private readonly _recheckParameter;
     constructor(parser: RushCommandLineParser);
     protected runAsync(): Promise<void>;
-    protected buildInstallOptionsAsync(): Promise<IInstallManagerOptions>;
+    protected buildInstallOptionsAsync(): Promise<Omit<IInstallManagerOptions, 'subspace'>>;
 }
 //# sourceMappingURL=UpdateAction.d.ts.map

package/lib/cli/parsing/SelectionParameterSet.d.ts

@@ -1,8 +1,13 @@
-import type { ITerminal } from '@rushstack/terminal';
+import { type ITerminal } from '@rushstack/terminal';
 import type { CommandLineParameterProvider } from '@rushstack/ts-command-line';
 import type { RushConfiguration } from '../../api/RushConfiguration';
 import type { RushConfigurationProject } from '../../api/RushConfigurationProject';
 import { type IGitSelectorParserOptions } from '../../logic/selectors/GitChangedProjectSelectorParser';
+export declare const SUBSPACE_LONG_ARG_NAME: '--subspace';
+interface ISelectionParameterSetOptions {
+    gitOptions: IGitSelectorParserOptions;
+    includeSubspaceSelector: boolean;
+}
 /**
  * This class is provides the set of command line parameters used to select projects
  * based on dependencies.
@@ -17,10 +22,20 @@ export declare class SelectionParameterSet {
     private readonly _onlyProject;
     private readonly _toProject;
     private readonly _toExceptProject;
+    private readonly _subspaceParameter;
     private readonly _fromVersionPolicy;
     private readonly _toVersionPolicy;
     private readonly _selectorParserByScope;
-    constructor(rushConfiguration: RushConfiguration, action: CommandLineParameterProvider, gitOptions: IGitSelectorParserOptions);
+    constructor(rushConfiguration: RushConfiguration, action: CommandLineParameterProvider, options: ISelectionParameterSetOptions);
+    /**
+     * Used to implement the `preventSelectingAllSubspaces` policy which checks for commands that accidentally
+     * select everything.   Return `true` if the CLI was invoked with selection parameters.
+     *
+     * @remarks
+     * It is still possible for a user to select everything, but they must do so using an explicit selection
+     * such as `rush install --from thing-that-everything-depends-on`.
+     */
+    didUserSelectAnything(): boolean;
     /**
      * Computes the set of selected projects based on all parameter values.
      *
@@ -53,4 +68,5 @@ export declare class SelectionParameterSet {
      */
     private _evaluateProjectParameterAsync;
 }
+export {};
 //# sourceMappingURL=SelectionParameterSet.d.ts.map

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

@@ -22,7 +22,7 @@ export declare class GlobalScriptAction extends BaseScriptAction<IGlobalCommandC
     private readonly _autoinstallerName;
     private readonly _autoinstallerFullPath;
     constructor(options: IGlobalScriptActionOptions);
-    private _prepareAutoinstallerName;
+    private _prepareAutoinstallerNameAsync;
     runAsync(): Promise<void>;
     private _expandShellCommandWithTokens;
     private _rejectAnyTokensInShellCommand;

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

@@ -53,7 +53,7 @@ export declare class PhasedScriptAction extends BaseScriptAction<IPhasedCommandC
     private readonly _noIPCParameter;
     constructor(options: IPhasedScriptActionOptions);
     runAsync(): Promise<void>;
-    private _runInitialPhases;
+    private _runInitialPhasesAsync;
     private _registerWatchModeInterface;
     /**
      * Runs the command in watch mode. Fundamentally is a simple loop:
@@ -62,11 +62,11 @@ export declare class PhasedScriptAction extends BaseScriptAction<IPhasedCommandC
      *    Uses the same algorithm as --impacted-by
      * 3) Goto (1)
      */
-    private _runWatchPhases;
+    private _runWatchPhasesAsync;
     /**
      * Runs a set of operations and reports the results.
      */
-    private _executeOperations;
+    private _executeOperationsAsync;
     private _doBeforeTask;
     private _doAfterTask;
 }

package/lib/logic/buildCache/ProjectBuildCache.d.ts

@@ -30,7 +30,7 @@ export declare class ProjectBuildCache {
     private constructor();
     private static _tryGetTarUtility;
     get cacheId(): string | undefined;
-    static tryGetProjectBuildCache(options: IProjectBuildCacheOptions): Promise<ProjectBuildCache | undefined>;
+    static tryGetProjectBuildCacheAsync(options: IProjectBuildCacheOptions): Promise<ProjectBuildCache | undefined>;
     tryRestoreFromCacheAsync(terminal: ITerminal, specifiedCacheId?: string): Promise<boolean>;
     trySetCacheEntryAsync(terminal: ITerminal, specifiedCacheId?: string): Promise<boolean>;
     /**
@@ -40,6 +40,6 @@ export declare class ProjectBuildCache {
      */
     private _tryCollectPathsToCacheAsync;
     private _getTarLogFilePath;
-    private static _getCacheId;
+    private static _getCacheIdAsync;
 }
 //# sourceMappingURL=ProjectBuildCache.d.ts.map

package/lib/logic/installManager/InstallHelpers.d.ts

@@ -11,7 +11,7 @@ export declare class InstallHelpers {
      * If the "(p)npm-local" symlink hasn't been set up yet, this creates it, installing the
      * specified (P)npm version in the user's home directory if needed.
      */
-    static ensureLocalPackageManager(rushConfiguration: RushConfiguration, rushGlobalFolder: RushGlobalFolder, maxInstallAttempts: number, restrictConsoleOutput?: boolean): Promise<void>;
+    static ensureLocalPackageManagerAsync(rushConfiguration: RushConfiguration, rushGlobalFolder: RushGlobalFolder, maxInstallAttempts: number, restrictConsoleOutput?: boolean): Promise<void>;
     private static _mergeEnvironmentVariables;
 }
 //# sourceMappingURL=InstallHelpers.d.ts.map

package/lib/logic/operations/OperationExecutionManager.d.ts

@@ -9,10 +9,10 @@ export interface IOperationExecutionManagerOptions {
     parallelism: number;
     changedProjectsOnly: boolean;
     destination?: TerminalWritable;
-    beforeExecuteOperation?: (operation: OperationExecutionRecord) => Promise<OperationStatus | undefined>;
-    afterExecuteOperation?: (operation: OperationExecutionRecord) => Promise<void>;
-    onOperationStatusChanged?: (record: OperationExecutionRecord) => void;
-    beforeExecuteOperations?: (records: Map<Operation, OperationExecutionRecord>) => Promise<void>;
+    beforeExecuteOperationAsync?: (operation: OperationExecutionRecord) => Promise<OperationStatus | undefined>;
+    afterExecuteOperationAsync?: (operation: OperationExecutionRecord) => Promise<void>;
+    onOperationStatusChangedAsync?: (record: OperationExecutionRecord) => void;
+    beforeExecuteOperationsAsync?: (records: Map<Operation, OperationExecutionRecord>) => Promise<void>;
 }
 /**
  * A class which manages the execution of a set of tasks with interdependencies.
@@ -45,6 +45,7 @@ export declare class OperationExecutionManager {
      * operations are completed successfully, or rejects when any operation fails.
      */
     executeAsync(): Promise<IExecutionResult>;
+    private _reportOperationErrorIfAny;
     /**
      * Handles the result of the operation and propagates any relevant effects.
      */

package/lib/logic/setup/SetupPackageRegistry.d.ts

@@ -20,16 +20,16 @@ export declare class SetupPackageRegistry {
      *
      * @returns - `true` if valid, `false` if not valid
      */
-    checkOnly(): Promise<boolean>;
+    checkOnlyAsync(): Promise<boolean>;
     /**
      * Test whether the NPM token is valid.  If not, prompt to update it.
      */
-    checkAndSetup(): Promise<void>;
+    checkAndSetupAsync(): Promise<void>;
     /**
      * Fetch a valid NPM token from the Artifactory service and add it to the `~/.npmrc` file,
      * preserving other settings in that file.
      */
-    private _fetchTokenAndUpdateNpmrc;
+    private _fetchTokenAndUpdateNpmrcAsync;
     /**
      * Update the `~/.npmrc` file by adding `linesToAdd` to it.
      * @remarks

package/lib/logic/setup/TerminalInput.d.ts

@@ -14,9 +14,9 @@ export interface IPromptPasswordOptions extends IBasePromptOptions {
 export interface IPromptLineOptions extends IBasePromptOptions {
 }
 export declare class TerminalInput {
-    private static _readLine;
-    static promptYesNo(options: IPromptYesNoOptions): Promise<boolean>;
-    static promptLine(options: IPromptLineOptions): Promise<string>;
-    static promptPasswordLine(options: IPromptLineOptions): Promise<string>;
+    private static _readLineAsync;
+    static promptYesNoAsync(options: IPromptYesNoOptions): Promise<boolean>;
+    static promptLineAsync(options: IPromptLineOptions): Promise<string>;
+    static promptPasswordLineAsync(options: IPromptLineOptions): Promise<string>;
 }
 //# sourceMappingURL=TerminalInput.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.124.3",
+  "version": "5.124.5",
   "description": "An API for interacting with the Rush engine",
   "repository": {
     "type": "git",
@@ -25,17 +25,17 @@
   "dependencies": {
     "@types/node-fetch": "2.6.2",
     "tapable": "2.2.1",
-    "@rushstack/node-core-library": "4.2.1",
-    "@rushstack/terminal": "0.10.3"
+    "@rushstack/node-core-library": "4.3.0",
+    "@rushstack/terminal": "0.11.0"
   },
   "devDependencies": {
     "@types/semver": "7.5.0",
     "@types/webpack-env": "1.18.0",
-    "@microsoft/rush-lib": "5.124.3",
-    "@rushstack/heft": "0.66.6",
+    "@rushstack/heft": "0.66.8",
+    "@rushstack/stream-collator": "4.1.46",
     "local-node-rig": "1.0.0",
-    "@rushstack/ts-command-line": "4.19.5",
-    "@rushstack/stream-collator": "4.1.44"
+    "@microsoft/rush-lib": "5.124.5",
+    "@rushstack/ts-command-line": "4.20.1"
   },
   "scripts": {
     "build": "heft build --clean",