Merge pull request microsoft#1825 from iclanton/ianc/rebuild

iclanton · web-flow · commit 2180c881a88a · 2020-04-14T15:03:41.000-07:00
[rush] When the "rebuild" command is overridden, run the "rebuild" script.
diff --git a/apps/rush-lib/assets/rush-init/common/config/rush/command-line.json b/apps/rush-lib/assets/rush-init/common/config/rush/command-line.json
@@ -29,6 +29,9 @@
        * The name should be comprised of lower case words separated by hyphens or colons. The name should include an
        * English verb (e.g. "deploy"). Use a hyphen to separate words (e.g. "upload-docs"). A group of related commands
        * can be prefixed with a colon (e.g. "docs:generate", "docs:deploy", "docs:serve", etc).
+       *
+       * Note that if the "rebuild" command is overridden here, it becomes separated from the "build" command
+       * and will call the "rebuild" script instead of the "build" script.
        */
       "name": "my-bulk-command",
 
diff --git a/apps/rush-lib/src/cli/RushCommandLineParser.ts b/apps/rush-lib/src/cli/RushCommandLineParser.ts
@@ -200,7 +200,11 @@ export class RushCommandLineParser extends CommandLineParser {
     }
 
     if (!this.tryGetAction(RushConstants.rebuildCommandName)) {
-      this._addCommandLineConfigAction(commandLineConfiguration, CommandLineConfiguration.defaultRebuildCommandJson);
+      this._addCommandLineConfigAction(
+        commandLineConfiguration,
+        CommandLineConfiguration.defaultRebuildCommandJson,
+        RushConstants.buildCommandName
+      );
     }
   }
 
@@ -217,7 +221,8 @@ export class RushCommandLineParser extends CommandLineParser {
 
   private _addCommandLineConfigAction(
     commandLineConfiguration: CommandLineConfiguration | undefined,
-    command: CommandJson
+    command: CommandJson,
+    commandToRun?: string
   ): void {
     if (this.tryGetAction(command.name)) {
       throw new Error(`${RushConstants.commandLineFilename} defines a command "${command.name}"`
@@ -231,9 +236,9 @@ export class RushCommandLineParser extends CommandLineParser {
         this.addAction(new BulkScriptAction({
           actionName: command.name,
 
-          // The rush rebuild and rush build command invoke the same NPM script because they share the same
-          // package-deps-hash state.
-          commandToRun: command.name === RushConstants.rebuildCommandName ? 'build' : undefined,
+          // By default, the "rebuild" action runs the "build" script. However, if the command-line.json file
+          // overrides "rebuild," the "rebuild" script should be run.
+          commandToRun: commandToRun,
 
           summary: command.summary,
           documentation: command.description || command.summary,
diff --git a/apps/rush-lib/src/cli/scriptActions/BulkScriptAction.ts b/apps/rush-lib/src/cli/scriptActions/BulkScriptAction.ts
@@ -4,30 +4,28 @@
 import * as os from 'os';
 import * as colors from 'colors';
 
-import {
-  Event
-} from '../../index';
-
 import {
   CommandLineFlagParameter,
   CommandLineStringParameter,
   CommandLineStringListParameter,
   CommandLineParameterKind
 } from '@rushstack/ts-command-line';
+import {
+  FileSystem,
+  PackageJsonLookup,
+  IPackageJson
+} from '@rushstack/node-core-library';
 
+import { Event } from '../../index';
 import { SetupChecks } from '../../logic/SetupChecks';
 import { TaskSelector } from '../../logic/TaskSelector';
 import { Stopwatch } from '../../utilities/Stopwatch';
 import { AlreadyReportedError } from '../../utilities/AlreadyReportedError';
 import { BaseScriptAction, IBaseScriptActionOptions } from './BaseScriptAction';
-import {
-  FileSystem,
-  PackageJsonLookup,
-  IPackageJson
-} from '@rushstack/node-core-library';
 import { TaskRunner } from '../../logic/taskRunner/TaskRunner';
 import { TaskCollection } from '../../logic/taskRunner/TaskCollection';
 import { Utilities } from '../../utilities/Utilities';
+import { RushConstants } from '../../logic/RushConstants';
 
 /**
  * Constructor parameters for BulkScriptAction.
@@ -255,7 +253,7 @@ export class BulkScriptAction extends BaseScriptAction {
   }
 
   private _doBeforeTask(): void {
-    if (this.actionName !== 'build' && this.actionName !== 'rebuild') {
+    if (this.actionName !== RushConstants.buildCommandName && this.actionName !== RushConstants.rebuildCommandName) {
       // Only collects information for built-in tasks like build or rebuild.
       return;
     }
@@ -266,7 +264,7 @@ export class BulkScriptAction extends BaseScriptAction {
   }
 
   private _doAfterTask(stopwatch: Stopwatch, success: boolean): void {
-    if (this.actionName !== 'build' && this.actionName !== 'rebuild') {
+    if (this.actionName !== RushConstants.buildCommandName && this.actionName !== RushConstants.rebuildCommandName) {
       // Only collects information for built-in tasks like build or rebuild.
       return;
     }
diff --git a/apps/rush-lib/src/cli/test/RushCommandLineParser.test.ts b/apps/rush-lib/src/cli/test/RushCommandLineParser.test.ts
@@ -199,7 +199,7 @@ describe('RushCommandLineParser', () => {
       });
 
       describe(`'rebuild' action`, () => {
-        it(`executes the package's 'build' script`, () => {
+        it(`executes the package's 'rebuild' script`, () => {
           const repoName: string = 'overrideRebuildAndRunRebuildActionRepo';
           const instance: IParserTestInstance = getCommandLineParserInstance(repoName, 'rebuild');
 
@@ -211,7 +211,7 @@ describe('RushCommandLineParser', () => {
               expect(packageCount).toEqual(2);
 
               // Use regex for task name in case spaces were prepended or appended to spawned command
-              const expectedBuildTaskRegexp: RegExp = /fake_build_task_but_works_with_mock/;
+              const expectedBuildTaskRegexp: RegExp = /fake_REbuild_task_but_works_with_mock/;
 
               // eslint-disable-next-line @typescript-eslint/no-explicit-any
               const firstSpawn: any[] = instance.spawnMock.mock.calls[0];
diff --git a/common/changes/@microsoft/rush/ianc-rebuild_2020-04-11-01-02.json b/common/changes/@microsoft/rush/ianc-rebuild_2020-04-11-01-02.json
@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "Fix a regression in Rush 5.19.0 where customizing \"rush rebuild\" would call the \"build\" script instead of the \"rebuild\" script.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush",
+  "email": "iclanton@users.noreply.github.com"
+}
