@rushstack/rush-sdk 5.158.1 → 5.160.0

package/dist/rush-lib.d.ts

@@ -16,6 +16,7 @@ import { HookMap } from 'tapable';
 import { IFileDiffStatus } from '@rushstack/package-deps-hash';
 import { IPackageJson } from '@rushstack/node-core-library';
 import { IPrefixMatch } from '@rushstack/lookup-by-path';
+import type { IProblemCollector } from '@rushstack/terminal';
 import { ITerminal } from '@rushstack/terminal';
 import { ITerminalProvider } from '@rushstack/terminal';
 import { JsonNull } from '@rushstack/node-core-library';
@@ -1428,6 +1429,10 @@ export declare interface IExecuteOperationsContext extends ICreateOperationsCont
      * Not part of the creation context to avoid the overhead of Git calls when initializing the graph.
      */
     readonly inputsSnapshot?: IInputsSnapshot;
+    /**
+     * An abort controller that can be used to abort the current set of queued operations.
+     */
+    readonly abortController: AbortController;
 }
 
 /**
@@ -1855,6 +1860,10 @@ export declare interface IOperationExecutionResult {
      * Object used to report a summary at the end of the Rush invocation.
      */
     readonly stdioSummarizer: StdioSummarizer;
+    /**
+     * Object used to collect problems (errors/warnings/info) encountered during the operation.
+     */
+    readonly problemCollector: IProblemCollector;
     /**
      * The value indicates the duration of the same operation without cache hit.
      */
@@ -2189,6 +2198,12 @@ export declare interface IPhasedCommand extends IRushCommand {
      * @alpha
      */
     readonly hooks: PhasedCommandHooks;
+    /**
+     * An abort controller that can be used to abort the command.
+     * Long-lived plugins should listen to the signal to handle any cleanup logic.
+     * @alpha
+     */
+    readonly sessionAbortController: AbortController;
 }
 
 /**
@@ -2210,6 +2225,7 @@ export declare interface IPnpmLockfilePolicies {
  * @internal
  */
 export declare interface _IPnpmOptionsJson extends IPackageManagerOptionsJsonBase {
+    $schema?: string;
     /**
      * {@inheritDoc PnpmOptionsConfiguration.pnpmStore}
      */
@@ -3103,7 +3119,11 @@ export declare enum OperationStatus {
     /**
      * The Operation was a no-op (for example, it had an empty script)
      */
-    NoOp = "NO OP"
+    NoOp = "NO OP",
+    /**
+     * The Operation was aborted before it could execute.
+     */
+    Aborted = "ABORTED"
 }
 
 /**
@@ -3527,7 +3547,7 @@ export declare class PnpmOptionsConfiguration extends PackageManagerOptionsConfi
     get globalPatchedDependencies(): Record<string, string> | undefined;
     private constructor();
     /** @internal */
-    static loadFromJsonFileOrThrow(jsonFilename: string, commonTempFolder: string): PnpmOptionsConfiguration;
+    static loadFromJsonFileOrThrow(jsonFilePath: string, commonTempFolder: string): PnpmOptionsConfiguration;
     /** @internal */
     static loadFromJsonObject(json: _IPnpmOptionsJson, commonTempFolder: string): PnpmOptionsConfiguration;
     /**
@@ -4944,7 +4964,10 @@ export declare class Subspace {
      * 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`
+     * Example (variants):               `C:\MyRepo\common\config\rush\variants\my-variant`
+     * Example (variants and subspaces): `C:\MyRepo\common\config\subspaces\my-subspace\variants\my-variant`
+     * Example (subspaces):              `C:\MyRepo\common\config\subspaces\my-subspace`
+     * Example (neither):                `C:\MyRepo\common\config\rush`
      * @beta
      *
      * @remarks
@@ -4957,22 +4980,24 @@ export declare class Subspace {
     /**
      * Returns the full path of the folder containing this subspace's configuration files such as `pnpm-lock.yaml`.
      *
-     * Example: `common/config/subspaces/my-subspace`
+     * Example (subspaces feature enabled):   `C:\MyRepo\common\config\subspaces\my-subspace`
+     * Example (subspaces feature disabled):  `C:\MyRepo\common\config\rush`
      * @beta
      */
     getSubspaceConfigFolderPath(): string;
     /**
      * Returns the full path of the folder containing this subspace's configuration files such as `pnpm-lock.yaml`.
      *
-     * Example: `common/config/subspaces/my-subspace/pnpm-patches` (subspaces feature enabled)
-     * Example: `common/config/pnpm-patches` (subspaces feature disabled)
+     * Example (subspaces feature enabled):   `C:\MyRepo\common\config\subspaces\my-subspace\pnpm-patches`
+     * Example (subspaces feature disabled):  `C:\MyRepo\common\pnpm-patches`
      * @beta
      */
     getSubspacePnpmPatchesFolderPath(): string;
     /**
-     * The folder where the subspace's node_modules and other temporary files will be stored.
+     * The full path of the folder where the subspace's node_modules and other temporary files will be stored.
      *
-     * Example: `common/temp/subspaces/my-subspace`
+     * Example (subspaces feature enabled):   `C:\MyRepo\common\temp\subspaces\my-subspace`
+     * Example (subspaces feature disabled):  `C:\MyRepo\common\temp`
      * @beta
      */
     getSubspaceTempFolderPath(): string;
@@ -5004,16 +5029,18 @@ export declare class Subspace {
      */
     getTempShrinkwrapPreinstallFilePath(): string;
     /**
-     * Gets the path to the common-versions.json config file for this subspace.
+     * Gets the full path to the common-versions.json config file for this subspace.
      *
-     * Example: `C:\MyRepo\common\subspaces\my-subspace\common-versions.json`
+     * Example (subspaces feature enabled):   `C:\MyRepo\common\config\subspaces\my-subspace\common-versions.json`
+     * Example (subspaces feature disabled):  `C:\MyRepo\common\config\rush\common-versions.json`
      * @beta
      */
     getCommonVersionsFilePath(variant?: string): string;
     /**
-     * Gets the path to the pnpm-config.json config file for this subspace.
+     * Gets the full path to the pnpm-config.json config file for this subspace.
      *
-     * Example: `C:\MyRepo\common\subspaces\my-subspace\pnpm-config.json`
+     * Example (subspaces feature enabled):   `C:\MyRepo\common\config\subspaces\my-subspace\pnpm-config.json`
+     * Example (subspaces feature disabled):  `C:\MyRepo\common\config\rush\pnpm-config.json`
      * @beta
      */
     getPnpmConfigFilePath(): string;

package/dist/tsdoc-metadata.json

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

package/lib/api/Subspace.d.ts

@@ -41,7 +41,10 @@ export declare class Subspace {
      * 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`
+     * Example (variants):               `C:\MyRepo\common\config\rush\variants\my-variant`
+     * Example (variants and subspaces): `C:\MyRepo\common\config\subspaces\my-subspace\variants\my-variant`
+     * Example (subspaces):              `C:\MyRepo\common\config\subspaces\my-subspace`
+     * Example (neither):                `C:\MyRepo\common\config\rush`
      * @beta
      *
      * @remarks
@@ -54,22 +57,24 @@ export declare class Subspace {
     /**
      * Returns the full path of the folder containing this subspace's configuration files such as `pnpm-lock.yaml`.
      *
-     * Example: `common/config/subspaces/my-subspace`
+     * Example (subspaces feature enabled):   `C:\MyRepo\common\config\subspaces\my-subspace`
+     * Example (subspaces feature disabled):  `C:\MyRepo\common\config\rush`
      * @beta
      */
     getSubspaceConfigFolderPath(): string;
     /**
      * Returns the full path of the folder containing this subspace's configuration files such as `pnpm-lock.yaml`.
      *
-     * Example: `common/config/subspaces/my-subspace/pnpm-patches` (subspaces feature enabled)
-     * Example: `common/config/pnpm-patches` (subspaces feature disabled)
+     * Example (subspaces feature enabled):   `C:\MyRepo\common\config\subspaces\my-subspace\pnpm-patches`
+     * Example (subspaces feature disabled):  `C:\MyRepo\common\pnpm-patches`
      * @beta
      */
     getSubspacePnpmPatchesFolderPath(): string;
     /**
-     * The folder where the subspace's node_modules and other temporary files will be stored.
+     * The full path of the folder where the subspace's node_modules and other temporary files will be stored.
      *
-     * Example: `common/temp/subspaces/my-subspace`
+     * Example (subspaces feature enabled):   `C:\MyRepo\common\temp\subspaces\my-subspace`
+     * Example (subspaces feature disabled):  `C:\MyRepo\common\temp`
      * @beta
      */
     getSubspaceTempFolderPath(): string;
@@ -101,16 +106,18 @@ export declare class Subspace {
      */
     getTempShrinkwrapPreinstallFilePath(): string;
     /**
-     * Gets the path to the common-versions.json config file for this subspace.
+     * Gets the full path to the common-versions.json config file for this subspace.
      *
-     * Example: `C:\MyRepo\common\subspaces\my-subspace\common-versions.json`
+     * Example (subspaces feature enabled):   `C:\MyRepo\common\config\subspaces\my-subspace\common-versions.json`
+     * Example (subspaces feature disabled):  `C:\MyRepo\common\config\rush\common-versions.json`
      * @beta
      */
     getCommonVersionsFilePath(variant?: string): string;
     /**
-     * Gets the path to the pnpm-config.json config file for this subspace.
+     * Gets the full path to the pnpm-config.json config file for this subspace.
      *
-     * Example: `C:\MyRepo\common\subspaces\my-subspace\pnpm-config.json`
+     * Example (subspaces feature enabled):   `C:\MyRepo\common\config\subspaces\my-subspace\pnpm-config.json`
+     * Example (subspaces feature disabled):  `C:\MyRepo\common\config\rush\pnpm-config.json`
      * @beta
      */
     getPnpmConfigFilePath(): string;

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

@@ -1,3 +1,4 @@
+import type { IPhasedCommand } from '../../pluginFramework/RushLifeCycle';
 import { PhasedCommandHooks } from '../../pluginFramework/PhasedCommandHooks';
 import { BaseScriptAction, type IBaseScriptActionOptions } from './BaseScriptAction';
 import type { IPhase, IPhasedCommandConfig } from '../../api/CommandLineConfiguration';
@@ -25,12 +26,13 @@ export interface IPhasedScriptActionOptions extends IBaseScriptActionOptions<IPh
  * and "rebuild" commands are also modeled as phased commands with a single phase that invokes the npm
  * "build" script for each project.
  */
-export declare class PhasedScriptAction extends BaseScriptAction<IPhasedCommandConfig> {
+export declare class PhasedScriptAction extends BaseScriptAction<IPhasedCommandConfig> implements IPhasedCommand {
     /**
      * @internal
      */
     _runsBeforeInstall: boolean | undefined;
     readonly hooks: PhasedCommandHooks;
+    readonly sessionAbortController: AbortController;
     private readonly _enableParallelism;
     private readonly _isIncrementalBuildAllowed;
     private readonly _disableBuildCache;
@@ -43,6 +45,7 @@ export declare class PhasedScriptAction extends BaseScriptAction<IPhasedCommandC
     private readonly _knownPhases;
     private readonly _terminal;
     private _changedProjectsOnly;
+    private _executionAbortController;
     private readonly _changedProjectsOnlyParameter;
     private readonly _selectionParameters;
     private readonly _verboseParameter;

package/lib/logic/ProjectImpactGraphGenerator.d.ts

@@ -1,5 +1,5 @@
-import type { RushConfiguration } from '../api/RushConfiguration';
 import { type ITerminal } from '@rushstack/terminal';
+import type { RushConfiguration } from '../api/RushConfiguration';
 /**
  * Project property configuration
  */

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

@@ -30,7 +30,6 @@ export declare class WorkspaceInstallManager extends BaseInstallManager {
         shrinkwrapIsUpToDate: boolean;
         shrinkwrapWarnings: string[];
     }>;
-    private _getPackageExtensionChecksum;
     protected canSkipInstallAsync(lastModifiedDate: Date, subspace: Subspace, variant: string | undefined): Promise<boolean>;
     /**
      * Runs "pnpm install" in the common folder.

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

@@ -1,4 +1,4 @@
-import type { StdioSummarizer } from '@rushstack/terminal';
+import type { StdioSummarizer, IProblemCollector } from '@rushstack/terminal';
 import type { OperationStatus } from './OperationStatus';
 import type { Operation } from './Operation';
 import type { IStopwatchResult } from '../../utilities/Stopwatch';
@@ -36,6 +36,10 @@ export interface IOperationExecutionResult {
      * Object used to report a summary at the end of the Rush invocation.
      */
     readonly stdioSummarizer: StdioSummarizer;
+    /**
+     * Object used to collect problems (errors/warnings/info) encountered during the operation.
+     */
+    readonly problemCollector: IProblemCollector;
     /**
      * The value indicates the duration of the same operation without cache hit.
      */

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

@@ -1,3 +1,4 @@
+import type { OperationRequestRunCallback } from '@rushstack/operation-graph';
 import type { IPhase } from '../../api/CommandLineConfiguration';
 import type { RushConfigurationProject } from '../../api/RushConfigurationProject';
 import type { IOperationRunner, IOperationRunnerContext } from './IOperationRunner';
@@ -9,7 +10,7 @@ export interface IIPCOperationRunnerOptions {
     commandToRun: string;
     commandForHash: string;
     persist: boolean;
-    requestRun: (requestor?: string) => void;
+    requestRun: OperationRequestRunCallback;
 }
 /**
  * Runner that hosts a long-lived process to which it communicates via IPC.

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

@@ -39,6 +39,7 @@ export declare class OperationExecutionManager {
     private readonly _createEnvironmentForOperation?;
     private _hasAnyFailures;
     private _hasAnyNonAllowedWarnings;
+    private _hasAnyAborted;
     private _completedOperations;
     private _executionQueue;
     constructor(operations: Set<Operation>, options: IOperationExecutionManagerOptions);
@@ -47,7 +48,7 @@ export declare class OperationExecutionManager {
      * Executes all operations which have been registered, returning a promise which is resolved when all the
      * operations are completed successfully, or rejects when any operation fails.
      */
-    executeAsync(): Promise<IExecutionResult>;
+    executeAsync(abortController: AbortController): Promise<IExecutionResult>;
     private _reportOperationErrorIfAny;
     /**
      * Handles the result of the operation and propagates any relevant effects.

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

@@ -1,4 +1,4 @@
-import { type ITerminal, type ITerminalProvider, StdioSummarizer } from '@rushstack/terminal';
+import { type ITerminal, type ITerminalProvider, StdioSummarizer, ProblemCollector } from '@rushstack/terminal';
 import { type CollatedWriter, type StreamCollator } from '@rushstack/stream-collator';
 import { OperationStatus } from './OperationStatus';
 import type { IOperationRunner, IOperationRunnerContext } from './IOperationRunner';
@@ -79,6 +79,7 @@ export declare class OperationExecutionRecord implements IOperationRunnerContext
     readonly consumers: Set<OperationExecutionRecord>;
     readonly stopwatch: Stopwatch;
     readonly stdioSummarizer: StdioSummarizer;
+    readonly problemCollector: ProblemCollector;
     readonly runner: IOperationRunner;
     readonly associatedPhase: IPhase;
     readonly associatedProject: RushConfigurationProject;

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

@@ -46,7 +46,11 @@ export declare enum OperationStatus {
     /**
      * The Operation was a no-op (for example, it had an empty script)
      */
-    NoOp = "NO OP"
+    NoOp = "NO OP",
+    /**
+     * The Operation was aborted before it could execute.
+     */
+    Aborted = "ABORTED"
 }
 /**
  * The set of statuses that are considered terminal.

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

@@ -1,5 +1,5 @@
-import type { IPhasedCommandPlugin, PhasedCommandHooks } from '../../pluginFramework/PhasedCommandHooks';
 import type { ITerminal } from '@rushstack/terminal';
+import type { IPhasedCommandPlugin, PhasedCommandHooks } from '../../pluginFramework/PhasedCommandHooks';
 /**
  * Core phased command plugin that provides the functionality for generating a base operation graph
  * from the set of selected projects and phases.

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

@@ -61,6 +61,7 @@ export interface IPnpmPackageExtension {
  * @internal
  */
 export interface IPnpmOptionsJson extends IPackageManagerOptionsJsonBase {
+    $schema?: string;
     /**
      * {@inheritDoc PnpmOptionsConfiguration.pnpmStore}
      */
@@ -356,7 +357,7 @@ export declare class PnpmOptionsConfiguration extends PackageManagerOptionsConfi
     get globalPatchedDependencies(): Record<string, string> | undefined;
     private constructor();
     /** @internal */
-    static loadFromJsonFileOrThrow(jsonFilename: string, commonTempFolder: string): PnpmOptionsConfiguration;
+    static loadFromJsonFileOrThrow(jsonFilePath: string, commonTempFolder: string): PnpmOptionsConfiguration;
     /** @internal */
     static loadFromJsonObject(json: IPnpmOptionsJson, commonTempFolder: string): PnpmOptionsConfiguration;
     /**

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

@@ -1,3 +1,4 @@
+import type { Lockfile, PackageSnapshot, ProjectSnapshot } from '@pnpm/lockfile.types';
 import { type ITerminal } from '@rushstack/terminal';
 import { BaseShrinkwrapFile } from '../base/BaseShrinkwrapFile';
 import { DependencySpecifier } from '../DependencySpecifier';
@@ -8,7 +9,6 @@ import type { RushConfigurationProject } from '../../api/RushConfigurationProjec
 import { PnpmProjectShrinkwrapFile } from './PnpmProjectShrinkwrapFile';
 import type { PackageManagerOptionsConfigurationBase } from '../base/BasePackageManagerOptionsConfiguration';
 import type { Subspace } from '../../api/Subspace';
-import type { Lockfile, PackageSnapshot, ProjectSnapshot } from '@pnpm/lockfile.types';
 export declare enum ShrinkwrapFileMajorVersion {
     V6 = 6,
     V9 = 9

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

@@ -1,4 +1,4 @@
-import * as readline from 'readline';
+import * as readline from 'node:readline';
 export declare class KeyboardLoop {
     protected stdin: NodeJS.ReadStream;
     protected stderr: NodeJS.WriteStream;

package/lib/pluginFramework/PhasedCommandHooks.d.ts

@@ -114,6 +114,10 @@ export interface IExecuteOperationsContext extends ICreateOperationsContext {
      * Not part of the creation context to avoid the overhead of Git calls when initializing the graph.
      */
     readonly inputsSnapshot?: IInputsSnapshot;
+    /**
+     * An abort controller that can be used to abort the current set of queued operations.
+     */
+    readonly abortController: AbortController;
 }
 /**
  * Hooks into the execution process for phased commands

package/lib/pluginFramework/RushLifeCycle.d.ts

@@ -28,6 +28,12 @@ export interface IPhasedCommand extends IRushCommand {
      * @alpha
      */
     readonly hooks: PhasedCommandHooks;
+    /**
+     * An abort controller that can be used to abort the command.
+     * Long-lived plugins should listen to the signal to handle any cleanup logic.
+     * @alpha
+     */
+    readonly sessionAbortController: AbortController;
 }
 /**
  * Hooks into the lifecycle of the Rush process invocation that plugins may tap into.

package/lib/utilities/PnpmSyncUtilities.d.ts

@@ -1,5 +1,5 @@
-import { type ITerminal } from '@rushstack/terminal';
 import { type ILogMessageCallbackOptions } from 'pnpm-sync-lib';
+import { type ITerminal } from '@rushstack/terminal';
 export declare class PnpmSyncUtilities {
     private static _addLinePrefix;
     static processLogMessage(options: ILogMessageCallbackOptions, terminal: ITerminal): void;

package/lib/utilities/Utilities.d.ts

@@ -1,4 +1,4 @@
-import * as child_process from 'child_process';
+import * as child_process from 'node:child_process';
 import { type IWaitForExitResult } from '@rushstack/node-core-library';
 import type { RushConfiguration } from '../api/RushConfiguration';
 import { syncNpmrc } from './npmrcUtilities';