Skip to content

Commit 94e9d34

Browse files
committed
Update names in plugins
1 parent 453b9aa commit 94e9d34

File tree

4 files changed

+11
-13
lines changed

4 files changed

+11
-13
lines changed

rush-plugins/rush-bridge-cache-plugin/src/BridgeCachePlugin.ts

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import {
77
OperationStatus,
88
type Operation,
99
type IOperationExecutionResult,
10-
type IOperationExecutionPassOptions
10+
type IOperationExecutionIterationOptions
1111
} from '@rushstack/rush-sdk';
1212
import type {
1313
ILogger,
@@ -64,11 +64,11 @@ export class BridgeCachePlugin implements IRushPlugin {
6464
const { terminal } = logger;
6565
const requireOutputFolders: boolean = this._isRequireOutputFoldersFlagSet(customParameters);
6666

67-
executionManager.hooks.beforeExecuteOperationsAsync.tapPromise(
67+
executionManager.hooks.beforeExecuteIterationAsync.tapPromise(
6868
PLUGIN_NAME,
6969
async (
7070
operationRecords: ReadonlyMap<Operation, IOperationExecutionResult>,
71-
passOptions: IOperationExecutionPassOptions
71+
iterationOptions: IOperationExecutionIterationOptions
7272
): Promise<OperationStatus | undefined> => {
7373
const filteredOperations: IBaseOperationExecutionResult[] = [];
7474
for (const record of operationRecords.values()) {
@@ -151,9 +151,7 @@ export class BridgeCachePlugin implements IRushPlugin {
151151
);
152152

153153
// Bail out with a status indicating success; treat cache read as FromCache.
154-
return cacheAction === CACHE_ACTION_READ
155-
? (OperationStatus.FromCache as OperationStatus)
156-
: (OperationStatus.Success as OperationStatus);
154+
return cacheAction === CACHE_ACTION_READ ? OperationStatus.FromCache : OperationStatus.Success;
157155
}
158156
);
159157
}

rush-plugins/rush-serve-plugin/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ function applyQueuedStates(states: IOperationExecutionState[] | undefined): void
5858
function effectiveStatus(name: string): string | undefined {
5959
const exec = executionStates.get(name);
6060
if (exec) return exec.status;
61-
// Optionally fall back to last-known previous pass results if you track them.
61+
// Optionally fall back to last-known previous iteration results if you track them.
6262
return undefined;
6363
}
6464

rush-plugins/rush-serve-plugin/src/api.types.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ export interface IWebSocketBatchStatusChangeEventMessage {
156156
}
157157

158158
/**
159-
* Message sent to a WebSocket client at the start of an execution pass.
159+
* Message sent to a WebSocket client at the start of an execution iteration.
160160
*/
161161
export interface IWebSocketBeforeExecuteEventMessage {
162162
event: 'before-execute';
@@ -179,7 +179,7 @@ export interface IWebSocketSyncEventMessage {
179179
*/
180180
currentExecutionStates: IOperationExecutionState[];
181181
/**
182-
* Execution states for operations that have been queued for the next pass (if any)
182+
* Execution states for operations that have been queued for the next iteration (if any)
183183
* when the sync message was generated.
184184
*/
185185
queuedStates?: IOperationExecutionState[];
@@ -194,7 +194,7 @@ export interface IWebSocketSyncEventMessage {
194194
hasScheduledIteration: boolean;
195195
};
196196
/**
197-
* The results of the previous execution pass for all operations, if available.
197+
* The results of the previous execution for all operations, if available.
198198
* This mirrors the values() of OperationExecutionManager.lastExecutionResults at the time of emission.
199199
*/
200200
lastExecutionResults?: IOperationExecutionState[];
@@ -247,7 +247,7 @@ export type IWebSocketEventMessage =
247247
*/
248248
// Command (client->server) message interfaces (alphabetically by interface name)
249249
/**
250-
* Message received from a WebSocket client to request abortion of the current execution pass.
250+
* Message received from a WebSocket client to request abortion of the current execution iteration.
251251
*/
252252
export interface IWebSocketAbortExecutionCommandMessage {
253253
command: 'abort-execution';
@@ -269,7 +269,7 @@ export interface IWebSocketCloseRunnersCommandMessage {
269269
}
270270

271271
/**
272-
* Message received from a WebSocket client to request execution of a new execution pass.
272+
* Message received from a WebSocket client to request execution of a new execution iteration.
273273
*/
274274
export interface IWebSocketExecuteCommandMessage {
275275
command: 'execute';

rush-plugins/rush-serve-plugin/src/tryEnableBuildStatusWebSocketServer.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ export function tryEnableBuildStatusWebSocketServer(
234234
};
235235

236236
let executionManager: IOperationExecutionManager | undefined;
237-
// Operations that have been queued for an upcoming execution pass (captured at queue time)
237+
// Operations that have been queued for an upcoming execution iteration (captured at queue time)
238238
let queuedStates: IOperationExecutionResult[] | undefined;
239239

240240
function getManagerStateSnapshot(): IWebSocketSyncEventMessage['managerState'] | undefined {

0 commit comments

Comments
 (0)