@rushstack/rush-sdk 5.93.2 → 5.94.1

package/dist/rush-lib.d.ts

@@ -1373,6 +1373,16 @@ declare interface IPnpmPeerDependencyRules {
     allowedVersions?: Record<string, string>;
 }
 
+/**
+ * Object containing both the matched item and the start index of the remainder of the query.
+ *
+ * @beta
+ */
+export declare interface IPrefixMatch<TItem> {
+    value: TItem;
+    index: number;
+}
+
 /**
  * @internal
  */
@@ -1835,11 +1845,11 @@ export declare class LockStepVersionPolicy extends VersionPolicy {
  * @example
  * ```ts
  * const tree = new LookupByPath([['foo', 1], ['bar', 2], ['foo/bar', 3]]);
- * tree.getNearestAncestor('foo'); // returns 1
- * tree.getNearestAncestor('foo/baz'); // returns 1
- * tree.getNearestAncestor('baz'); // returns undefined
- * tree.getNearestAncestor('foo/bar/baz'); returns 3
- * tree.getNearestAncestor('bar/foo/bar'); returns 2
+ * tree.findChildPath('foo'); // returns 1
+ * tree.findChildPath('foo/baz'); // returns 1
+ * tree.findChildPath('baz'); // returns undefined
+ * tree.findChildPath('foo/bar/baz'); returns 3
+ * tree.findChildPath('bar/foo/bar'); returns 2
  * ```
  * @beta
  */
@@ -1868,6 +1878,7 @@ export declare class LookupByPath<TItem> {
      * `LookupByPath.iteratePathSegments('foo\\bar\\baz', '\\')` yields 'foo', 'bar', 'baz'
      */
     static iteratePathSegments(serializedPath: string, delimiter?: string): Iterable<string>;
+    private static _iteratePrefixes;
     /**
      * Associates the value with the specified serialized path.
      * If a value is already associated, will overwrite.
@@ -1896,6 +1907,21 @@ export declare class LookupByPath<TItem> {
      * ```
      */
     findChildPath(childPath: string): TItem | undefined;
+    /**
+     * Searches for the item for which the recorded prefix is the longest matching prefix of `query`.
+     * Obtains both the item and the length of the matched prefix, so that the remainder of the path can be
+     * extracted.
+     *
+     * @returns the found item and the length of the matched prefix, or `undefined` if no item was found
+     *
+     * @example
+     * ```ts
+     * const tree = new LookupByPath([['foo', 1], ['foo/bar', 2]]);
+     * tree.findLongestPrefixMatch('foo/baz'); // returns { item: 1, index: 3 }
+     * tree.findLongestPrefixMatch('foo/bar/baz'); // returns { item: 2, index: 7 }
+     * ```
+     */
+    findLongestPrefixMatch(query: string): IPrefixMatch<TItem> | undefined;
     /**
      * Searches for the item associated with `childPathSegments`, or the nearest ancestor of that path that
      * has an associated item.
@@ -1910,6 +1936,15 @@ export declare class LookupByPath<TItem> {
      * ```
      */
     findChildPathFromSegments(childPathSegments: Iterable<string>): TItem | undefined;
+    /**
+     * Iterates through progressively longer prefixes of a given string and returns as soon
+     * as the number of candidate items that match the prefix are 1 or 0.
+     *
+     * If a match is present, returns the matched itme and the length of the matched prefix.
+     *
+     * @returns the found item, or `undefined` if no item was found
+     */
+    private _findLongestPrefixMatch;
 }
 
 /**
@@ -2205,6 +2240,16 @@ export declare class PhasedCommandHooks {
      * Use the context to distinguish between the initial run and phased runs.
      */
     readonly createOperations: AsyncSeriesWaterfallHook<[Set<Operation>, ICreateOperationsContext]>;
+    /**
+     * Hook invoked before operation start
+     * Hook is series for stable output.
+     */
+    readonly beforeExecuteOperations: AsyncSeriesHook<[Map<Operation, IOperationExecutionResult>]>;
+    /**
+     * Hook invoked when operation status changed
+     * Hook is series for stable output.
+     */
+    readonly onOperationStatusChanged: SyncHook<[IOperationExecutionResult]>;
     /**
      * Hook invoked after executing a set of operations.
      * Use the context to distinguish between the initial run and phased runs.

package/lib/index.d.ts

@@ -22,7 +22,7 @@ export { ApprovedPackagesItem, ApprovedPackagesConfiguration } from './api/Appro
 export { CommonVersionsConfiguration } from './api/CommonVersionsConfiguration';
 export { PackageJsonEditor, PackageJsonDependency, DependencyType } from './api/PackageJsonEditor';
 export { RepoStateFile } from './logic/RepoStateFile';
-export { LookupByPath } from './logic/LookupByPath';
+export { LookupByPath, IPrefixMatch } from './logic/LookupByPath';
 export { EventHooks, Event } from './api/EventHooks';
 export { ChangeManager } from './api/ChangeManager';
 export { LastInstallFlag as _LastInstallFlag, ILockfileValidityCheckOptions as _ILockfileValidityCheckOptions } from './api/LastInstallFlag';

package/lib/logic/Autoinstaller.d.ts

@@ -1,12 +1,15 @@
 import { RushConfiguration } from '../api/RushConfiguration';
+import type { RushGlobalFolder } from '../api/RushGlobalFolder';
 interface IAutoinstallerOptions {
     autoinstallerName: string;
     rushConfiguration: RushConfiguration;
+    rushGlobalFolder: RushGlobalFolder;
     restrictConsoleOutput?: boolean;
 }
 export declare class Autoinstaller {
     readonly name: string;
     private readonly _rushConfiguration;
+    private readonly _rushGlobalFolder;
     private readonly _restrictConsoleOutput;
     constructor(options: IAutoinstallerOptions);
     get folderFullPath(): string;
@@ -14,7 +17,7 @@ export declare class Autoinstaller {
     get packageJsonPath(): string;
     static validateName(autoinstallerName: string): void;
     prepareAsync(): Promise<void>;
-    update(): void;
+    updateAsync(): Promise<void>;
     private _logIfConsoleOutputIsNotRestricted;
 }
 export {};

package/lib/logic/LookupByPath.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Object containing both the matched item and the start index of the remainder of the query.
+ *
+ * @beta
+ */
+export interface IPrefixMatch<TItem> {
+    value: TItem;
+    index: number;
+}
 /**
  * This class is used to associate POSIX relative paths, such as those returned by `git` commands,
  * with entities that correspond with ancestor folders, such as Rush Projects.
@@ -7,11 +16,11 @@
  * @example
  * ```ts
  * const tree = new LookupByPath([['foo', 1], ['bar', 2], ['foo/bar', 3]]);
- * tree.getNearestAncestor('foo'); // returns 1
- * tree.getNearestAncestor('foo/baz'); // returns 1
- * tree.getNearestAncestor('baz'); // returns undefined
- * tree.getNearestAncestor('foo/bar/baz'); returns 3
- * tree.getNearestAncestor('bar/foo/bar'); returns 2
+ * tree.findChildPath('foo'); // returns 1
+ * tree.findChildPath('foo/baz'); // returns 1
+ * tree.findChildPath('baz'); // returns undefined
+ * tree.findChildPath('foo/bar/baz'); returns 3
+ * tree.findChildPath('bar/foo/bar'); returns 2
  * ```
  * @beta
  */
@@ -40,6 +49,7 @@ export declare class LookupByPath<TItem> {
      * `LookupByPath.iteratePathSegments('foo\\bar\\baz', '\\')` yields 'foo', 'bar', 'baz'
      */
     static iteratePathSegments(serializedPath: string, delimiter?: string): Iterable<string>;
+    private static _iteratePrefixes;
     /**
      * Associates the value with the specified serialized path.
      * If a value is already associated, will overwrite.
@@ -68,6 +78,21 @@ export declare class LookupByPath<TItem> {
      * ```
      */
     findChildPath(childPath: string): TItem | undefined;
+    /**
+     * Searches for the item for which the recorded prefix is the longest matching prefix of `query`.
+     * Obtains both the item and the length of the matched prefix, so that the remainder of the path can be
+     * extracted.
+     *
+     * @returns the found item and the length of the matched prefix, or `undefined` if no item was found
+     *
+     * @example
+     * ```ts
+     * const tree = new LookupByPath([['foo', 1], ['foo/bar', 2]]);
+     * tree.findLongestPrefixMatch('foo/baz'); // returns { item: 1, index: 3 }
+     * tree.findLongestPrefixMatch('foo/bar/baz'); // returns { item: 2, index: 7 }
+     * ```
+     */
+    findLongestPrefixMatch(query: string): IPrefixMatch<TItem> | undefined;
     /**
      * Searches for the item associated with `childPathSegments`, or the nearest ancestor of that path that
      * has an associated item.
@@ -82,5 +107,14 @@ export declare class LookupByPath<TItem> {
      * ```
      */
     findChildPathFromSegments(childPathSegments: Iterable<string>): TItem | undefined;
+    /**
+     * Iterates through progressively longer prefixes of a given string and returns as soon
+     * as the number of candidate items that match the prefix are 1 or 0.
+     *
+     * If a match is present, returns the matched itme and the length of the matched prefix.
+     *
+     * @returns the found item, or `undefined` if no item was found
+     */
+    private _findLongestPrefixMatch;
 }
 //# sourceMappingURL=LookupByPath.d.ts.map

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

@@ -1,5 +1,6 @@
 import { TerminalWritable } from '@rushstack/terminal';
 import { Operation } from './Operation';
+import { OperationExecutionRecord } from './OperationExecutionRecord';
 import { IExecutionResult } from './IOperationExecutionResult';
 export interface IOperationExecutionManagerOptions {
     quietMode: boolean;
@@ -7,6 +8,8 @@ export interface IOperationExecutionManagerOptions {
     parallelism: number;
     changedProjectsOnly: boolean;
     destination?: TerminalWritable;
+    onOperationStatusChanged?: (record: OperationExecutionRecord) => void;
+    beforeExecuteOperations?: (records: Map<Operation, OperationExecutionRecord>) => Promise<void>;
 }
 /**
  * A class which manages the execution of a set of tasks with interdependencies.
@@ -24,6 +27,8 @@ export declare class OperationExecutionManager {
     private readonly _colorsNewlinesTransform;
     private readonly _streamCollator;
     private readonly _terminal;
+    private readonly _onOperationStatusChanged?;
+    private readonly _beforeExecuteOperations?;
     private _hasAnyFailures;
     private _hasAnyNonAllowedWarnings;
     private _completedOperations;

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

@@ -7,6 +7,7 @@ import { Stopwatch } from '../../utilities/Stopwatch';
 import { OperationMetadataManager } from './OperationMetadataManager';
 export interface IOperationExecutionRecordContext {
     streamCollator: StreamCollator;
+    onOperationStatusChanged?: (record: OperationExecutionRecord) => void;
     debugMode: boolean;
     quietMode: boolean;
 }

package/lib/pluginFramework/PhasedCommandHooks.d.ts

@@ -6,7 +6,7 @@ import type { RushConfiguration } from '../api/RushConfiguration';
 import type { RushConfigurationProject } from '../api/RushConfigurationProject';
 import type { Operation } from '../logic/operations/Operation';
 import type { ProjectChangeAnalyzer } from '../logic/ProjectChangeAnalyzer';
-import { IExecutionResult } from '../logic/operations/IOperationExecutionResult';
+import { IExecutionResult, IOperationExecutionResult } from '../logic/operations/IOperationExecutionResult';
 /**
  * A plugin that interacts with a phased commands.
  * @alpha
@@ -77,6 +77,16 @@ export declare class PhasedCommandHooks {
      * Use the context to distinguish between the initial run and phased runs.
      */
     readonly createOperations: AsyncSeriesWaterfallHook<[Set<Operation>, ICreateOperationsContext]>;
+    /**
+     * Hook invoked before operation start
+     * Hook is series for stable output.
+     */
+    readonly beforeExecuteOperations: AsyncSeriesHook<[Map<Operation, IOperationExecutionResult>]>;
+    /**
+     * Hook invoked when operation status changed
+     * Hook is series for stable output.
+     */
+    readonly onOperationStatusChanged: SyncHook<[IOperationExecutionResult]>;
     /**
      * Hook invoked after executing a set of operations.
      * Use the context to distinguish between the initial run and phased runs.

package/lib/pluginFramework/PluginLoader/AutoinstallerPluginLoader.d.ts

@@ -2,8 +2,10 @@ import { JsonObject } from '@rushstack/node-core-library';
 import { IRushPluginConfiguration } from '../../api/RushPluginsConfiguration';
 import { Autoinstaller } from '../../logic/Autoinstaller';
 import { IPluginLoaderOptions, PluginLoaderBase } from './PluginLoaderBase';
+import type { RushGlobalFolder } from '../../api/RushGlobalFolder';
 interface IAutoinstallerPluginLoaderOptions extends IPluginLoaderOptions<IRushPluginConfiguration> {
     restrictConsoleOutput: boolean;
+    rushGlobalFolder: RushGlobalFolder;
 }
 /**
  * @beta

package/lib/pluginFramework/PluginManager.d.ts

@@ -5,12 +5,14 @@ import { IBuiltInPluginConfiguration } from './PluginLoader/BuiltInPluginLoader'
 import { AutoinstallerPluginLoader } from './PluginLoader/AutoinstallerPluginLoader';
 import { RushSession } from './RushSession';
 import { PluginLoaderBase } from './PluginLoader/PluginLoaderBase';
+import type { RushGlobalFolder } from '../api/RushGlobalFolder';
 export interface IPluginManagerOptions {
     terminal: ITerminal;
     rushConfiguration: RushConfiguration;
     rushSession: RushSession;
     builtInPluginConfigurations: IBuiltInPluginConfiguration[];
     restrictConsoleOutput: boolean;
+    rushGlobalFolder: RushGlobalFolder;
 }
 export interface ICustomCommandLineConfigurationInfo {
     commandLineConfiguration: CommandLineConfiguration;
@@ -25,6 +27,7 @@ export declare class PluginManager {
     private readonly _autoinstallerPluginLoaders;
     private readonly _installedAutoinstallerNames;
     private readonly _loadedPluginNames;
+    private readonly _rushGlobalFolder;
     private _error;
     constructor(options: IPluginManagerOptions);
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.93.2",
+  "version": "5.94.1",
   "description": "An API for interacting with the Rush engine",
   "repository": {
     "type": "git",
@@ -20,13 +20,13 @@
     "@types/heft-jest": "1.0.1",
     "@types/semver": "7.3.5",
     "@types/webpack-env": "1.18.0",
-    "@microsoft/rush-lib": "5.93.2",
+    "@microsoft/rush-lib": "5.94.1",
     "@rushstack/eslint-config": "3.2.0",
-    "@rushstack/heft": "0.49.7",
-    "@rushstack/heft-node-rig": "1.12.4",
-    "@rushstack/stream-collator": "4.0.227",
+    "@rushstack/heft": "0.50.0",
+    "@rushstack/heft-node-rig": "1.12.5",
+    "@rushstack/stream-collator": "4.0.228",
     "@rushstack/ts-command-line": "4.13.2",
-    "@rushstack/terminal": "0.5.2"
+    "@rushstack/terminal": "0.5.3"
   },
   "scripts": {
     "build": "heft build --clean",