@rushstack/rush-sdk 5.62.4 → 5.63.0

package/dist/rush-lib.d.ts

@@ -6,6 +6,7 @@
 /// <reference types="node" />
 
 import { AsyncSeriesHook } from 'tapable';
+import { HookMap } from 'tapable';
 import { IPackageJson } from '@rushstack/node-core-library';
 import { ITerminal } from '@rushstack/node-core-library';
 import { ITerminalProvider } from '@rushstack/node-core-library';
@@ -753,6 +754,13 @@ export declare interface IGetChangedProjectsOptions {
     enableFiltering: boolean;
 }
 
+/**
+ * Information about the currently executing global script command (as defined in command-line.json) provided to plugins.
+ * @beta
+ */
+export declare interface IGlobalCommand extends IRushCommand {
+}
+
 declare interface IIndividualVersionJson extends IVersionPolicyJson {
     lockedMajor?: number;
 }
@@ -872,6 +880,13 @@ export declare interface IPackageManagerOptionsJsonBase {
     environmentVariables?: IConfigurationEnvironment;
 }
 
+/**
+ * Information about the currently executing phased script command (as defined in command-line.json, or default "build" or "rebuild") provided to plugins.
+ * @beta
+ */
+export declare interface IPhasedCommand extends IRushCommand {
+}
+
 /**
  * Part of IRushConfigurationJson.
  * @internal
@@ -895,6 +910,17 @@ export declare interface _IPnpmOptionsJson extends IPackageManagerOptionsJsonBas
     useWorkspaces?: boolean;
 }
 
+/**
+ * Information about the currently executing command provided to plugins.
+ * @beta
+ */
+export declare interface IRushCommand {
+    /**
+     * The name of this command, as seen on the command line
+     */
+    readonly actionName: string;
+}
+
 /**
  * This represents the JSON data structure for the "rush.json" configuration file.
  * See rush.schema.json for documentation.
@@ -2542,13 +2568,31 @@ export declare class _RushGlobalFolder {
 }
 
 /**
+ * Hooks into the lifecycle of the Rush process invocation that plugins may tap into.
+ *
  * @beta
  */
 export declare class RushLifecycleHooks {
     /**
-     * The hook to run when all rush plugins is initialized.
+     * The hook to run before executing any Rush CLI Command.
+     */
+    initialize: AsyncSeriesHook<IRushCommand>;
+    /**
+     * The hook to run before executing any global Rush CLI Command (defined in command-line.json).
+     */
+    runAnyGlobalCustomCommand: AsyncSeriesHook<IGlobalCommand>;
+    /**
+     * A hook map to allow plugins to hook specific named global commands (defined in command-line.json) before execution.
+     */
+    runGlobalCustomCommand: HookMap<AsyncSeriesHook<IGlobalCommand>>;
+    /**
+     * The hook to run before executing any phased Rush CLI Command (defined in command-line.json, or the default "build" or "rebuild").
+     */
+    runAnyPhasedCommand: AsyncSeriesHook<IPhasedCommand>;
+    /**
+     * A hook map to allow plugins to hook specific named phased commands (defined in command-line.json) before execution.
      */
-    initialize: AsyncSeriesHook<void>;
+    runPhasedCommand: HookMap<AsyncSeriesHook<IPhasedCommand>>;
 }
 
 declare class RushPluginsConfiguration {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/rush-sdk",
-  "version": "5.62.4",
+  "version": "5.63.0",
   "description": "An API for interacting with the Rush engine",
   "repository": {
     "type": "git",
@@ -12,15 +12,15 @@
   "typings": "dist/rush-lib.d.ts",
   "license": "MIT",
   "dependencies": {
-    "@rushstack/node-core-library": "3.45.0",
+    "@rushstack/node-core-library": "3.45.1",
     "@types/node-fetch": "1.6.9",
     "tapable": "2.2.1"
   },
   "devDependencies": {
-    "@microsoft/rush-lib": "5.62.4",
-    "@rushstack/eslint-config": "2.5.1",
-    "@rushstack/heft": "0.44.2",
-    "@rushstack/heft-node-rig": "1.8.0",
+    "@microsoft/rush-lib": "5.63.0",
+    "@rushstack/eslint-config": "2.5.2",
+    "@rushstack/heft": "0.44.3",
+    "@rushstack/heft-node-rig": "1.8.1",
     "@types/heft-jest": "1.0.1",
     "@types/semver": "7.3.5",
     "@types/webpack-env": "1.13.0"