Merge pull request microsoft#2902 from chengcyber/feat-rush-install-check-only

[rush] Feat rush install check only

Author: iclanton

apps/rush-lib/src/cli/actions/InstallAction.ts

@@ -1,12 +1,16 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
+import { CommandLineFlagParameter } from '@rushstack/ts-command-line';
+
 import { BaseInstallAction } from './BaseInstallAction';
 import { IInstallManagerOptions } from '../../logic/base/BaseInstallManager';
 import { RushCommandLineParser } from '../RushCommandLineParser';
 import { SelectionParameterSet } from '../SelectionParameterSet';
 
 export class InstallAction extends BaseInstallAction {
+  private _checkOnlyParameter!: CommandLineFlagParameter;
+
   public constructor(parser: RushCommandLineParser) {
     super({
       actionName: 'install',
@@ -33,6 +37,11 @@ export class InstallAction extends BaseInstallAction {
     super.onDefineParameters();
 
     this._selectionParameters = new SelectionParameterSet(this.rushConfiguration, this);
+
+    this._checkOnlyParameter = this.defineFlagParameter({
+      parameterLongName: '--check-only',
+      description: `Only check the validity of the shrinkwrap file without performing an install.`
+    });
   }
 
   protected buildInstallOptions(): IInstallManagerOptions {
@@ -50,7 +59,8 @@ export class InstallAction extends BaseInstallAction {
       // it is safe to assume that the value is not null
       maxInstallAttempts: this._maxInstallAttempts.value!,
       // These are derived independently of the selection for command line brevity
-      pnpmFilterArguments: this._selectionParameters!.getPnpmFilterArguments()
+      pnpmFilterArguments: this._selectionParameters!.getPnpmFilterArguments(),
+      checkOnly: this._checkOnlyParameter.value
     };
   }
 }

apps/rush-lib/src/cli/actions/UpdateAction.ts

@@ -70,7 +70,8 @@ export class UpdateAction extends BaseInstallAction {
       // Because the 'defaultValue' option on the _maxInstallAttempts parameter is set,
       // it is safe to assume that the value is not null
       maxInstallAttempts: this._maxInstallAttempts.value!,
-      pnpmFilterArguments: []
+      pnpmFilterArguments: [],
+      checkOnly: false
     };
   }
 }

apps/rush-lib/src/cli/test/__snapshots__/CommandLineHelp.test.ts.snap

@@ -535,7 +535,7 @@ exports[`CommandLineHelp prints the help for each action: install 1`] = `
                     [--variant VARIANT] [-t PROJECT] [-T PROJECT] [-f PROJECT]
                     [-o PROJECT] [-i PROJECT] [-I PROJECT]
                     [--to-version-policy VERSION_POLICY_NAME]
-                    [--from-version-policy VERSION_POLICY_NAME]
+                    [--from-version-policy VERSION_POLICY_NAME] [--check-only]
                     
 
 The \\"rush install\\" command installs package dependencies for all your 
@@ -656,6 +656,8 @@ Optional arguments:
                         each of the projects belonging to VERSION_POLICY_NAME.
                          For details, refer to the website article \\"Selecting 
                         subsets of projects\\".
+  --check-only          Only check the validity of the shrinkwrap file 
+                        without performing an install.
 "
 `;
 

apps/rush-lib/src/logic/PackageJsonUpdater.ts

@@ -138,7 +138,8 @@ export class PackageJsonUpdater {
       collectLogFile: false,
       variant: variant,
       maxInstallAttempts: RushConstants.defaultMaxInstallAttempts,
-      pnpmFilterArguments: []
+      pnpmFilterArguments: [],
+      checkOnly: false
     };
     const installManager: BaseInstallManager = InstallManagerFactory.getInstallManager(
       this._rushConfiguration,

apps/rush-lib/src/logic/base/BaseInstallManager.ts

@@ -49,6 +49,11 @@ export interface IInstallManagerOptions {
    */
   allowShrinkwrapUpdates: boolean;
 
+  /**
+   * Whether to check the validation before install only, without actually installing anything.
+   */
+  checkOnly: boolean;
+
   /**
    * Whether to skip policy checks.
    */
@@ -180,6 +185,10 @@ export abstract class BaseInstallManager {
 
     const { shrinkwrapIsUpToDate, variantIsUpToDate } = await this.prepareAsync();
 
+    if (this.options.checkOnly) {
+      return;
+    }
+
     console.log(
       os.EOL + colors.bold(`Checking installation in "${this.rushConfiguration.commonTempFolder}"`)
     );

common/changes/@microsoft/rush/feat-rush-install-check-only_2021-09-11-02-21.json

@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "Add a \"--check-only\" parameter to \"rush install\" to check the validity of the shrinkwrap without performing a full install.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush",
+  "email": "[email protected]"
+}