Merge pull request microsoft#4022 from zecheng01/feature/rush-event-h…

…ook-output [rush-lib] enable event hook scripts output by default
spring6225 · Mar 24, 2023 · 441ea30 · 441ea30
2 parents 2e96933 + 86166ab
commit 441ea30
Show file tree

Hide file tree

Showing 7 changed files with 37 additions and 3 deletions.
diff --git a/common/changes/@microsoft/rush/feature-rush-event-hook-output_2023-03-23-06-10.json b/common/changes/@microsoft/rush/feature-rush-event-hook-output_2023-03-23-06-10.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "Add experiment `printEventHooksOutputToConsole` to allow printing outputs from event hooks to the console.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush"
+}
diff --git a/common/config/rush/experiments.json b/common/config/rush/experiments.json
@@ -46,5 +46,10 @@
    * If true, perform a clean install after when running `rush install` or `rush update` if the
    * `.npmrc` file has changed since the last install.
    */
-  // "cleanInstallAfterNpmrcChanges": true
+  // "cleanInstallAfterNpmrcChanges": true,
+
+  /**
+   * If true, print the outputs of shell commands defined in event hooks to the console.
+   */
+  // "printEventHooksOutputToConsole": true
 }
diff --git a/common/reviews/api/rush-lib.api.md b/common/reviews/api/rush-lib.api.md
@@ -305,6 +305,7 @@ export interface IExperimentsJson {
     noChmodFieldInTarHeaderNormalization?: boolean;
     omitImportersFromPreventManualShrinkwrapChanges?: boolean;
     phasedCommands?: boolean;
+    printEventHooksOutputToConsole?: boolean;
     usePnpmFrozenLockfileForRushInstall?: boolean;
     usePnpmPreferFrozenLockfileForRushUpdate?: boolean;
 }

diff --git a/libraries/rush-lib/assets/rush-init/common/config/rush/experiments.json b/libraries/rush-lib/assets/rush-init/common/config/rush/experiments.json
@@ -46,5 +46,10 @@
    * If true, perform a clean install after when running `rush install` or `rush update` if the
    * `.npmrc` file has changed since the last install.
    */
-  /*[LINE "HYPOTHETICAL"]*/ "cleanInstallAfterNpmrcChanges": true
+  /*[LINE "HYPOTHETICAL"]*/ "cleanInstallAfterNpmrcChanges": true,
+
+  /**
+   * If true, print the outputs of shell commands defined in event hooks to the console.
+   */
+  /*[LINE "HYPOTHETICAL"]*/ "printEventHooksOutputToConsole": true
 }
diff --git a/libraries/rush-lib/src/api/ExperimentsConfiguration.ts b/libraries/rush-lib/src/api/ExperimentsConfiguration.ts
@@ -53,6 +53,11 @@ export interface IExperimentsJson {
    * `.npmrc` file has changed since the last install.
    */
   cleanInstallAfterNpmrcChanges?: boolean;
+
+  /**
+   * If true, print the outputs of shell commands defined in event hooks to the console.
+   */
+  printEventHooksOutputToConsole?: boolean;
 }
 
 /**

diff --git a/libraries/rush-lib/src/logic/EventHooksManager.ts b/libraries/rush-lib/src/logic/EventHooksManager.ts
@@ -34,13 +34,17 @@ export class EventHooksManager {
 
       const stopwatch: Stopwatch = Stopwatch.start();
       console.log('\n' + colors.green(`Executing event hooks for ${Event[event]}`));
+
+      const printEventHooksOutputToConsole: boolean | undefined =
+        isDebug ||
+        this._rushConfiguration.experimentsConfiguration.configuration.printEventHooksOutputToConsole;
       scripts.forEach((script) => {
         try {
           Utilities.executeLifecycleCommand(script, {
             rushConfiguration: this._rushConfiguration,
             workingDirectory: this._rushConfiguration.rushJsonFolder,
             initCwd: this._commonTempFolder,
-            handleOutput: !isDebug,
+            handleOutput: !printEventHooksOutputToConsole,
             environmentPathOptions: {
               includeRepoBin: true
             }

diff --git a/libraries/rush-lib/src/schemas/experiments.schema.json b/libraries/rush-lib/src/schemas/experiments.schema.json
@@ -37,6 +37,10 @@
     "cleanInstallAfterNpmrcChanges": {
       "description": "If true, perform a clean install after when running `rush install` or `rush update` if the `.npmrc` file has changed since the last install.",
       "type": "boolean"
+    },
+    "printEventHooksOutputToConsole": {
+      "description": "If true, print the outputs of shell commands defined in event hooks to the console.",
+      "type": "boolean"
     }
   },
   "additionalProperties": false