@rushstack/rush-sdk 5.114.3 → 5.116.0

package/dist/rush-lib.d.ts

@@ -1155,6 +1155,12 @@ export declare interface ICreateOperationsContext {
      * The Rush configuration
      */
     readonly rushConfiguration: RushConfiguration;
+    /**
+     * Marks an operation's result as invalid, potentially triggering a new build. Only applicable in watch mode.
+     * @param operation - The operation to invalidate
+     * @param reason - The reason for invalidating the operation
+     */
+    readonly invalidateOperation?: ((operation: Operation, reason: string) => void) | undefined;
 }
 
 /**
@@ -1349,6 +1355,12 @@ export declare interface IExperimentsJson {
      * If set to true, Rush will generate a `project-impact-graph.yaml` file in the repository root during `rush update`.
      */
     generateProjectImpactGraphDuringRushUpdate?: boolean;
+    /**
+     * If true, when running in watch mode, Rush will check for phase scripts named `_phase:<name>:ipc` and run them instead
+     * of `_phase:<name>` if they exist. The created child process will be provided with an IPC channel and expected to persist
+     * across invocations.
+     */
+    useIPCScriptsInWatchMode?: boolean;
 }
 
 /**
@@ -1677,10 +1689,6 @@ export declare interface IOperationRunnerContext {
      * Defaults to `true`. Will be `false` if Rush was invoked with `--verbose`.
      */
     quietMode: boolean;
-    /**
-     * Object used to report a summary at the end of the Rush invocation.
-     */
-    stdioSummarizer: StdioSummarizer;
     /**
      * Object used to manage metadata of the operation.
      *
@@ -1704,12 +1712,14 @@ export declare interface IOperationRunnerContext {
      */
     error?: Error;
     /**
-     * Normally the incremental build logic will rebuild changed projects as well as
-     * any projects that directly or indirectly depend on a changed project.
-     * If true, then the incremental build logic will only rebuild changed projects and
-     * ignore dependent projects.
+     * Invokes the specified callback with a terminal that is associated with this operation.
+     *
+     * Will write to a log file corresponding to the phase and project, and clean it up upon completion.
      */
-    readonly changedProjectsOnly: boolean;
+    runWithTerminalAsync<T>(callback: (terminal: ITerminal, terminalProvider: ITerminalProvider) => Promise<T>, options: {
+        createLogFile: boolean;
+        logFileSuffix?: string;
+    }): Promise<T>;
 }
 
 /**
@@ -2905,6 +2915,10 @@ export declare class PhasedCommandHooks {
     readonly afterExecuteOperation: AsyncSeriesHook<[
     IOperationRunnerContext & IOperationExecutionResult
     ]>;
+    /**
+     * Hook invoked to shutdown long-lived work in plugins.
+     */
+    readonly shutdownAsync: AsyncParallelHook<void>;
     /**
      * Hook invoked after a run has finished and the command is watching for changes.
      * May be used to display additional relevant data to the user.

package/lib/api/ExperimentsConfiguration.d.ts

@@ -75,6 +75,12 @@ export interface IExperimentsJson {
      * If set to true, Rush will generate a `project-impact-graph.yaml` file in the repository root during `rush update`.
      */
     generateProjectImpactGraphDuringRushUpdate?: boolean;
+    /**
+     * If true, when running in watch mode, Rush will check for phase scripts named `_phase:<name>:ipc` and run them instead
+     * of `_phase:<name>` if they exist. The created child process will be provided with an IPC channel and expected to persist
+     * across invocations.
+     */
+    useIPCScriptsInWatchMode?: boolean;
 }
 /**
  * Use this class to load the "common/config/rush/experiments.json" config file.

package/lib/api/RushConfigurationProject.d.ts

@@ -233,4 +233,5 @@ export declare class RushConfigurationProject {
      */
     get isMainProject(): boolean;
 }
+export declare function validateRelativePathField(relativePath: string, field: string, file: string): void;
 //# sourceMappingURL=RushConfigurationProject.d.ts.map

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

@@ -50,6 +50,7 @@ export declare class PhasedScriptAction extends BaseScriptAction<IPhasedCommandC
     private readonly _watchParameter;
     private readonly _timelineParameter;
     private readonly _installParameter;
+    private readonly _noIPCParameter;
     constructor(options: IPhasedScriptActionOptions);
     runAsync(): Promise<void>;
     private _runInitialPhases;

package/lib/logic/PublishUtilities.d.ts

@@ -65,6 +65,7 @@ export declare class PublishUtilities {
     private static _addChange;
     private static _updateDownstreamDependencies;
     private static _updateDownstreamDependency;
+    private static _getPublishDependencyVersion;
     private static _updateDependencyVersion;
 }
 //# sourceMappingURL=PublishUtilities.d.ts.map

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

@@ -1,4 +1,4 @@
-import type { StdioSummarizer } from '@rushstack/terminal';
+import type { ITerminal, ITerminalProvider } from '@rushstack/terminal';
 import type { CollatedWriter } from '@rushstack/stream-collator';
 import type { OperationStatus } from './OperationStatus';
 import type { OperationMetadataManager } from './OperationMetadataManager';
@@ -21,10 +21,6 @@ export interface IOperationRunnerContext {
      * Defaults to `true`. Will be `false` if Rush was invoked with `--verbose`.
      */
     quietMode: boolean;
-    /**
-     * Object used to report a summary at the end of the Rush invocation.
-     */
-    stdioSummarizer: StdioSummarizer;
     /**
      * Object used to manage metadata of the operation.
      *
@@ -48,12 +44,14 @@ export interface IOperationRunnerContext {
      */
     error?: Error;
     /**
-     * Normally the incremental build logic will rebuild changed projects as well as
-     * any projects that directly or indirectly depend on a changed project.
-     * If true, then the incremental build logic will only rebuild changed projects and
-     * ignore dependent projects.
+     * Invokes the specified callback with a terminal that is associated with this operation.
+     *
+     * Will write to a log file corresponding to the phase and project, and clean it up upon completion.
      */
-    readonly changedProjectsOnly: boolean;
+    runWithTerminalAsync<T>(callback: (terminal: ITerminal, terminalProvider: ITerminalProvider) => Promise<T>, options: {
+        createLogFile: boolean;
+        logFileSuffix?: string;
+    }): Promise<T>;
 }
 /**
  * The `Operation` class is a node in the dependency graph of work that needs to be scheduled by the

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

@@ -1,5 +1,5 @@
-import { StdioSummarizer } from '@rushstack/terminal';
-import type { CollatedWriter, StreamCollator } from '@rushstack/stream-collator';
+import { type ITerminal, type ITerminalProvider, StdioSummarizer } from '@rushstack/terminal';
+import { type CollatedWriter, type StreamCollator } from '@rushstack/stream-collator';
 import { OperationStatus } from './OperationStatus';
 import type { IOperationRunner, IOperationRunnerContext } from './IOperationRunner';
 import type { Operation } from './Operation';
@@ -12,7 +12,6 @@ export interface IOperationExecutionRecordContext {
     onOperationStatusChanged?: (record: OperationExecutionRecord) => void;
     debugMode: boolean;
     quietMode: boolean;
-    changedProjectsOnly: boolean;
 }
 /**
  * Internal class representing everything about executing an operation
@@ -83,7 +82,6 @@ export declare class OperationExecutionRecord implements IOperationRunnerContext
     get name(): string;
     get debugMode(): boolean;
     get quietMode(): boolean;
-    get changedProjectsOnly(): boolean;
     get collatedWriter(): CollatedWriter;
     get nonCachedDurationMs(): number | undefined;
     get cobuildRunnerId(): string | undefined;
@@ -95,6 +93,13 @@ export declare class OperationExecutionRecord implements IOperationRunnerContext
      */
     get status(): OperationStatus;
     set status(newStatus: OperationStatus);
+    /**
+     * {@inheritdoc IOperationRunnerContext.runWithTerminalAsync}
+     */
+    runWithTerminalAsync<T>(callback: (terminal: ITerminal, terminalProvider: ITerminalProvider) => Promise<T>, options: {
+        createLogFile: boolean;
+        logFileSuffix: string;
+    }): Promise<T>;
     executeAsync({ onStart, onResult }: {
         onStart: (record: OperationExecutionRecord) => Promise<OperationStatus | undefined>;
         onResult: (record: OperationExecutionRecord) => Promise<void>;

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

@@ -2,7 +2,6 @@ import { TerminalWritable, type ITerminalChunk } from '@rushstack/terminal';
 import type { CollatedTerminal } from '@rushstack/stream-collator';
 import type { RushConfigurationProject } from '../../api/RushConfigurationProject';
 export declare class ProjectLogWritable extends TerminalWritable {
-    private readonly _project;
     private readonly _terminal;
     readonly logPath: string;
     readonly errorLogPath: string;

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

@@ -1,20 +1,14 @@
-import { OperationStatus } from './OperationStatus';
-import type { IOperationRunner, IOperationRunnerContext } from './IOperationRunner';
+import type { IPhase } from '../../api/CommandLineConfiguration';
 import type { RushConfiguration } from '../../api/RushConfiguration';
 import type { RushConfigurationProject } from '../../api/RushConfigurationProject';
-import type { ProjectChangeAnalyzer } from '../ProjectChangeAnalyzer';
-import type { IPhase } from '../../api/CommandLineConfiguration';
+import type { IOperationRunner, IOperationRunnerContext } from './IOperationRunner';
+import { OperationStatus } from './OperationStatus';
 export interface IOperationRunnerOptions {
     rushProject: RushConfigurationProject;
     rushConfiguration: RushConfiguration;
     commandToRun: string;
-    projectChangeAnalyzer: ProjectChangeAnalyzer;
     displayName: string;
     phase: IPhase;
-    /**
-     * The set of phases being executed in the current command, for validation of rush-project.json
-     */
-    selectedPhases: Iterable<IPhase>;
 }
 /**
  * An `IOperationRunner` subclass that performs an operation via a shell command.
@@ -28,7 +22,6 @@ export declare class ShellOperationRunner implements IOperationRunner {
     readonly cacheable: boolean;
     readonly warningsAreAllowed: boolean;
     private readonly _commandToRun;
-    private readonly _logFilenameIdentifier;
     private readonly _rushProject;
     private readonly _rushConfiguration;
     constructor(options: IOperationRunnerOptions);

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

@@ -1,8 +1,18 @@
+import type { IPhase } from '../../api/CommandLineConfiguration';
+import type { RushConfigurationProject } from '../../api/RushConfigurationProject';
 import type { IPhasedCommandPlugin, PhasedCommandHooks } from '../../pluginFramework/PhasedCommandHooks';
+export declare const PLUGIN_NAME: 'ShellOperationRunnerPlugin';
 /**
  * Core phased command plugin that provides the functionality for executing an operation via shell command.
  */
 export declare class ShellOperationRunnerPlugin implements IPhasedCommandPlugin {
     apply(hooks: PhasedCommandHooks): void;
 }
+/**
+ * Memoizer for custom parameter values by phase
+ * @returns A function that returns the custom parameter values for a given phase
+ */
+export declare function getCustomParameterValuesByPhase(): (phase: IPhase) => ReadonlyArray<string>;
+export declare function formatCommand(rawCommand: string, customParameterValues: ReadonlyArray<string>): string;
+export declare function getDisplayName(phase: IPhase, project: RushConfigurationProject): string;
 //# sourceMappingURL=ShellOperationRunnerPlugin.d.ts.map

package/lib/pluginFramework/PhasedCommandHooks.d.ts

@@ -1,4 +1,4 @@
-import { AsyncSeriesBailHook, AsyncSeriesHook, AsyncSeriesWaterfallHook, SyncHook } from 'tapable';
+import { AsyncParallelHook, AsyncSeriesBailHook, AsyncSeriesHook, AsyncSeriesWaterfallHook, SyncHook } from 'tapable';
 import type { CommandLineParameter } from '@rushstack/ts-command-line';
 import type { BuildCacheConfiguration } from '../api/BuildCacheConfiguration';
 import type { IPhase } from '../api/CommandLineConfiguration';
@@ -83,6 +83,12 @@ export interface ICreateOperationsContext {
      * The Rush configuration
      */
     readonly rushConfiguration: RushConfiguration;
+    /**
+     * Marks an operation's result as invalid, potentially triggering a new build. Only applicable in watch mode.
+     * @param operation - The operation to invalidate
+     * @param reason - The reason for invalidating the operation
+     */
+    readonly invalidateOperation?: ((operation: Operation, reason: string) => void) | undefined;
 }
 /**
  * Hooks into the execution process for phased commands
@@ -125,6 +131,10 @@ export declare class PhasedCommandHooks {
     readonly afterExecuteOperation: AsyncSeriesHook<[
         IOperationRunnerContext & IOperationExecutionResult
     ]>;
+    /**
+     * Hook invoked to shutdown long-lived work in plugins.
+     */
+    readonly shutdownAsync: AsyncParallelHook<void>;
     /**
      * Hook invoked after a run has finished and the command is watching for changes.
      * May be used to display additional relevant data to the user.

package/lib/utilities/Utilities.d.ts

@@ -59,6 +59,10 @@ export interface ILifecycleCommandOptions {
      * If true, attempt to establish a NodeJS IPC channel to the child process.
      */
     ipc?: boolean;
+    /**
+     * If true, wire up SubprocessTerminator to the child process.
+     */
+    connectSubprocessTerminator?: boolean;
 }
 export interface IEnvironmentPathOptions {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.114.3",
+  "version": "5.116.0",
   "description": "An API for interacting with the Rush engine",
   "repository": {
     "type": "git",
@@ -25,16 +25,16 @@
   "dependencies": {
     "@types/node-fetch": "2.6.2",
     "tapable": "2.2.1",
-    "@rushstack/terminal": "0.9.0",
-    "@rushstack/node-core-library": "4.0.2"
+    "@rushstack/node-core-library": "4.0.2",
+    "@rushstack/terminal": "0.9.0"
   },
   "devDependencies": {
     "@types/semver": "7.5.0",
     "@types/webpack-env": "1.18.0",
-    "@microsoft/rush-lib": "5.114.3",
+    "@rushstack/heft": "0.65.4",
     "local-node-rig": "1.0.0",
-    "@rushstack/heft": "0.65.3",
-    "@rushstack/stream-collator": "4.1.30",
+    "@rushstack/stream-collator": "4.1.31",
+    "@microsoft/rush-lib": "5.116.0",
     "@rushstack/ts-command-line": "4.17.3"
   },
   "scripts": {