Merge pull request #2705 from EmmanuelOluyomi/AllowWarnings

[rush-lib] Add environment variable to override allowWarningsInSuccessfulBuild setting

Author: octogonz

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

@@ -40,6 +40,13 @@ export const enum EnvironmentVariableNames {
    */
   RUSH_ALLOW_UNSUPPORTED_NODEJS = 'RUSH_ALLOW_UNSUPPORTED_NODEJS',
 
+  /**
+   * Setting this environment variable overrides the value of `allowWarningsInSuccessfulBuild`
+   * in the `command-line.json` configuration file. Specify `1` to allow warnings in a successful build,
+   * or `0` to disallow them. (See the comments in the command-line.json file for more information).
+   */
+  RUSH_ALLOW_WARNINGS_IN_SUCCESSFUL_BUILD = 'RUSH_ALLOW_WARNINGS_IN_SUCCESSFUL_BUILD',
+
   /**
    * This variable selects a specific installation variant for Rush to use when installing
    * and linking package dependencies.
@@ -156,6 +163,8 @@ export class EnvironmentConfiguration {
 
   private static _allowUnsupportedNodeVersion: boolean = false;
 
+  private static _allowWarningsInSuccessfulBuild: boolean = false;
+
   private static _pnpmStorePathOverride: string | undefined;
 
   private static _rushGlobalFolderOverride: string | undefined;
@@ -197,6 +206,16 @@ export class EnvironmentConfiguration {
     return EnvironmentConfiguration._allowUnsupportedNodeVersion;
   }
 
+  /**
+   * Setting this environment variable overrides the value of `allowWarningsInSuccessfulBuild`
+   * in the `command-line.json` configuration file. Specify `1` to allow warnings in a successful build,
+   * or `0` to disallow them. (See the comments in the command-line.json file for more information).
+   */
+  public static get allowWarningsInSuccessfulBuild(): boolean {
+    EnvironmentConfiguration._ensureInitialized();
+    return EnvironmentConfiguration._allowWarningsInSuccessfulBuild;
+  }
+
   /**
    * An override for the PNPM store path, if `pnpmStore` configuration is set to 'path'
    * See {@link EnvironmentVariableNames.RUSH_PNPM_STORE_PATH}
@@ -312,6 +331,15 @@ export class EnvironmentConfiguration {
             break;
           }
 
+          case EnvironmentVariableNames.RUSH_ALLOW_WARNINGS_IN_SUCCESSFUL_BUILD: {
+            EnvironmentConfiguration._allowWarningsInSuccessfulBuild =
+              EnvironmentConfiguration.parseBooleanEnvironmentVariable(
+                EnvironmentVariableNames.RUSH_ALLOW_WARNINGS_IN_SUCCESSFUL_BUILD,
+                value
+              ) ?? false;
+            break;
+          }
+
           case EnvironmentVariableNames.RUSH_PNPM_STORE_PATH: {
             EnvironmentConfiguration._pnpmStorePathOverride =
               value && !options.doNotNormalizePaths

apps/rush-lib/src/cli/RushCommandLineParser.ts

@@ -42,6 +42,7 @@ import { Telemetry } from '../logic/Telemetry';
 import { RushGlobalFolder } from '../api/RushGlobalFolder';
 import { NodeJsCompatibility } from '../logic/NodeJsCompatibility';
 import { SetupAction } from './actions/SetupAction';
+import { EnvironmentConfiguration } from '../api/EnvironmentConfiguration';
 
 /**
  * Options for `RushCommandLineParser`.
@@ -248,6 +249,9 @@ export class RushCommandLineParser extends CommandLineParser {
 
     this._validateCommandLineConfigCommand(command);
 
+    const overrideAllowWarnings: boolean =
+      this.rushConfiguration && EnvironmentConfiguration.allowWarningsInSuccessfulBuild;
+
     switch (command.commandKind) {
       case RushConstants.bulkCommandKind:
         this.addAction(
@@ -269,7 +273,7 @@ export class RushCommandLineParser extends CommandLineParser {
             ignoreMissingScript: command.ignoreMissingScript || false,
             ignoreDependencyOrder: command.ignoreDependencyOrder || false,
             incremental: command.incremental || false,
-            allowWarningsInSuccessfulBuild: !!command.allowWarningsInSuccessfulBuild,
+            allowWarningsInSuccessfulBuild: overrideAllowWarnings || !!command.allowWarningsInSuccessfulBuild,
 
             watchForChanges: command.watchForChanges || false,
             disableBuildCache: command.disableBuildCache || false

common/changes/@microsoft/rush/AllowWarnings_2021-05-21-18-05.json

@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "Add RUSH_ALLOW_WARNINGS_IN_SUCCESSFUL_BUILD environment variable",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush",
+  "email": "EmmanuelOluyomi@users.noreply.github.com"
+}

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

@@ -96,6 +96,7 @@ export const enum DependencyType {
 export const enum EnvironmentVariableNames {
     RUSH_ABSOLUTE_SYMLINKS = "RUSH_ABSOLUTE_SYMLINKS",
     RUSH_ALLOW_UNSUPPORTED_NODEJS = "RUSH_ALLOW_UNSUPPORTED_NODEJS",
+    RUSH_ALLOW_WARNINGS_IN_SUCCESSFUL_BUILD = "RUSH_ALLOW_WARNINGS_IN_SUCCESSFUL_BUILD",
     RUSH_BUILD_CACHE_CREDENTIAL = "RUSH_BUILD_CACHE_CREDENTIAL",
     RUSH_BUILD_CACHE_ENABLED = "RUSH_BUILD_CACHE_ENABLED",
     RUSH_BUILD_CACHE_WRITE_ALLOWED = "RUSH_BUILD_CACHE_WRITE_ALLOWED",