[rush] Add hooks for pre and post rushx events

apps/rush/CHANGELOG.json

@@ -511,7 +511,7 @@
       "comments": {
         "none": [
           {
-            "comment": "Add code path to @rushstack/rush-sdk for inheriting @microsoft/rush-lib location from a parent process via the RUSH_LIB_PATH environment variable."
+            "comment": "Add code path to @rushstack/rush-sdk for inheriting @microsoft/rush-lib location from a parent process via the _RUSH_LIB_PATH environment variable."
           }
         ]
       }

apps/rush/CHANGELOG.md

@@ -258,7 +258,7 @@ Fri, 17 Feb 2023 02:14:43 GMT
 
 ### Updates
 
-- Add code path to @rushstack/rush-sdk for inheriting @microsoft/rush-lib location from a parent process via the RUSH_LIB_PATH environment variable.
+- Add code path to @rushstack/rush-sdk for inheriting @microsoft/rush-lib location from a parent process via the _RUSH_LIB_PATH environment variable.
 
 ## 5.92.0
 Sun, 12 Feb 2023 02:50:42 GMT
@@ -553,7 +553,7 @@ Sat, 06 Aug 2022 05:35:19 GMT
 ### Updates
 
 - Validate that if shouldPublish is set, private is not set
-- "rush install/update" should always set "ignore-compatibility-db=true" and print warning if the rush.json pnpmVersion specifies a version affected by this problem. 
+- "rush install/update" should always set "ignore-compatibility-db=true" and print warning if the rush.json pnpmVersion specifies a version affected by this problem.
 - Reorder some initialization logic so that Rush's change analysis is not counted as part of the build time for the first project
 - (BREAKING API CHANGE) Rename cyclicDependencyProjects to decoupledLocalDependencies
 
@@ -1878,7 +1878,7 @@ Thu, 11 Jul 2019 22:00:50 GMT
 
 ### Updates
 
-- Fix for issue https://github.com/microsoft/web-build-tools/issues/1349 rush install fails when there is a preferred version with a peer dependency. This was caused by file format changes in pnpm 3.x 
+- Fix for issue https://github.com/microsoft/web-build-tools/issues/1349 rush install fails when there is a preferred version with a peer dependency. This was caused by file format changes in pnpm 3.x
 - Fix an issue where "rush add" erroneously believes ensureConsistentVersions is unset.
 - Fix an issue that arises when "rush add" is run and the package manager isn't installed.
 - Fix an issue where rush add -m doesn't corretly update the common-versions.json file.
@@ -2360,9 +2360,9 @@ Fri, 06 Oct 2017 22:44:31 GMT
 ### Patches
 
 - Enable strickNullChecks
-- Fix a bug in "rush version" that devdependency does not get bumped if there is no dependency. 
-- Fix a bug in "rush change" so it handles rename properly. 
-- Add npm tag support in "rush publish". 
+- Fix a bug in "rush version" that devdependency does not get bumped if there is no dependency.
+- Fix a bug in "rush change" so it handles rename properly.
+- Add npm tag support in "rush publish".
 
 ## 3.0.18
 Tue, 26 Sep 2017 13:51:05 GMT
@@ -2617,7 +2617,7 @@ Sun, 22 Jan 2017 02:04:57 GMT
 
 ### Patches
 
-- Update temp_modules when versions are bumped. 
+- Update temp_modules when versions are bumped.
 
 ## 1.4.1
 Tue, 03 Jan 2017 21:52:49 GMT

apps/rush/bin/rush

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-require('../lib/start.js')
+require('../lib/start.js');

common/changes/@microsoft/rush/neboste-rushx_hooks_2023-10-03-00-40.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "Add start `preRushx` and `postRushx` event hooks for monitoring the `rushx` command",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush"
+}

common/reviews/api/rush-lib.api.md

@@ -264,16 +264,20 @@ export const EnvironmentVariableNames: {
     readonly RUSH_COBUILD_LEAF_PROJECT_LOG_ONLY_ALLOWED: "RUSH_COBUILD_LEAF_PROJECT_LOG_ONLY_ALLOWED";
     readonly RUSH_GIT_BINARY_PATH: "RUSH_GIT_BINARY_PATH";
     readonly RUSH_TAR_BINARY_PATH: "RUSH_TAR_BINARY_PATH";
-    readonly RUSH_LIB_PATH: "_RUSH_LIB_PATH";
+    readonly _RUSH_RECURSIVE_RUSHX_CALL: "_RUSH_RECURSIVE_RUSHX_CALL";
+    readonly _RUSH_LIB_PATH: "_RUSH_LIB_PATH";
     readonly RUSH_INVOKED_FOLDER: "RUSH_INVOKED_FOLDER";
+    readonly RUSH_INVOKED_ARGS: "RUSH_INVOKED_ARGS";
 };
 
 // @beta
 enum Event_2 {
     postRushBuild = 4,
     postRushInstall = 2,
+    postRushx = 6,
     preRushBuild = 3,
-    preRushInstall = 1
+    preRushInstall = 1,
+    preRushx = 5
 }
 export { Event_2 as Event }
 

libraries/rush-lib/assets/rush-init/rush.json

@@ -247,26 +247,36 @@
    */
   "eventHooks": {
     /**
-     * The list of shell commands to run before the Rush installation starts
+     * A list of shell commands to run before "rush install" or "rush update" starts installation
      */
     "preRushInstall": [
       /*[LINE "HYPOTHETICAL"]*/ "common/scripts/pre-rush-install.js"
     ],
 
     /**
-     * The list of shell commands to run after the Rush installation finishes
+     * A list of shell commands to run after "rush install" or "rush update" finishes installation
      */
     "postRushInstall": [],
 
     /**
-     * The list of shell commands to run before the Rush build command starts
+     * A list of shell commands to run before "rush build" or "rush rebuild" starts building
      */
     "preRushBuild": [],
 
     /**
-     * The list of shell commands to run after the Rush build command finishes
+     * A list of shell commands to run after "rush build" or "rush rebuild" finishes building
      */
-    "postRushBuild": []
+    "postRushBuild": [],
+
+    /**
+     * A list of shell commands to run before the "rushx" command starts
+     */
+    "preRushX": [],
+
+    /**
+     * A list of shell commands to run after the "rushx" command finishes
+     */
+    "postRushX": []
   },
 
   /**

libraries/rush-lib/src/api/EnvironmentConfiguration.ts

@@ -184,11 +184,17 @@ export const EnvironmentVariableNames = {
    */
   RUSH_TAR_BINARY_PATH: 'RUSH_TAR_BINARY_PATH',
 
+  /**
+   * Internal variable used by `rushx` when recursively invoking another `rushx` process, to avoid
+   * nesting event hooks.
+   */
+  _RUSH_RECURSIVE_RUSHX_CALL: '_RUSH_RECURSIVE_RUSHX_CALL',
+
   /**
    * Internal variable that explicitly specifies the path for the version of `@microsoft/rush-lib` being executed.
    * Will be set upon loading Rush.
    */
-  RUSH_LIB_PATH: '_RUSH_LIB_PATH',
+  _RUSH_LIB_PATH: '_RUSH_LIB_PATH',
 
   /**
    * When Rush executes shell scripts, it sometimes changes the working directory to be a project folder or
@@ -199,7 +205,18 @@ export const EnvironmentVariableNames = {
    * The `RUSH_INVOKED_FOLDER` variable is the same idea as the `INIT_CWD` variable that package managers
    * assign when they execute lifecycle scripts.
    */
-  RUSH_INVOKED_FOLDER: 'RUSH_INVOKED_FOLDER'
+  RUSH_INVOKED_FOLDER: 'RUSH_INVOKED_FOLDER',
+
+  /**
+   * When running a hook script, this environment variable communicates the original arguments
+   * passed to the `rush` or `rushx` command.
+   *
+   * @remarks
+   * Unlike `RUSH_INVOKED_FOLDER`, the `RUSH_INVOKED_ARGS` variable is only available for hook scripts.
+   * Other lifecycle scripts should not make assumptions about Rush's command line syntax
+   * if Rush did not explicitly pass along command-line parameters to their process.
+   */
+  RUSH_INVOKED_ARGS: 'RUSH_INVOKED_ARGS'
 } as const;
 
 /**
@@ -530,10 +547,15 @@ export class EnvironmentConfiguration {
             break;
 
           case EnvironmentVariableNames.RUSH_INVOKED_FOLDER:
-          case EnvironmentVariableNames.RUSH_LIB_PATH:
+          case EnvironmentVariableNames.RUSH_INVOKED_ARGS:
+          case EnvironmentVariableNames._RUSH_LIB_PATH:
             // Assigned by Rush itself
             break;
 
+          case EnvironmentVariableNames._RUSH_RECURSIVE_RUSHX_CALL:
+            // Assigned/read internally by RushXCommandLine
+            break;
+
           default:
             unknownEnvVariables.push(envVarName);
             break;

libraries/rush-lib/src/api/EventHooks.ts

@@ -24,7 +24,15 @@ export enum Event {
   /**
    * Post Rush build event
    */
-  postRushBuild = 4
+  postRushBuild = 4,
+  /**
+   * Start of rushx execution event
+   */
+  preRushx = 5,
+  /**
+   * End of rushx execution event
+   */
+  postRushx = 6
 }
 
 /**

libraries/rush-lib/src/api/Rush.ts

@@ -103,7 +103,7 @@ export class Rush {
     options = Rush._normalizeLaunchOptions(options);
 
     Rush._assignRushInvokedFolder();
-    RushXCommandLine._launchRushXInternal(launcherVersion, { ...options });
+    RushXCommandLine.launchRushX(options.isManaged);
   }
 
   /**