[rush] Introduce a "rush add" command #843

nickpape · 2018-09-26T01:51:41Z

Introduces a rush add command which can change dependencies.

The command should be run when inside a project folder.
The command requires the name of the new dependency to be added with --package/-p
If no version is specified, it will use the latest version, unless ensureConsistentVersions policy is active, in which case it will pick a version that will not violate the policy.
If a version range is specified (--version), the newest version that satisfies the range will be selected.
- The new version will be prepended with ~ by default. If --caret is used, then it will be prepended with ^. If --exact is specified, nothing will be prepended.
The --make-consistent flag must be used if the new version introduces a version mismatch and
the ensureConsistentVersions policy is active.
- This command will update all packages that use the dependency to be consistent.
rush update will be run after the command unless --no-install is specified.

nickpape · 2018-09-26T01:52:05Z

Fixes #820 #Resolved

nickpape · 2018-09-26T01:54:27Z

@pgonzal @iclanton #Resolved

nickpape · 2018-09-26T01:55:09Z

Example:

#Resolved

iclanton · 2018-09-26T02:01:22Z

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

+      required: true,
+      argumentName: 'PACKAGE_NAME',
+      description: '(Required) The name of the package which should be added as a dependency'
+    });


This is clunky. How hard would it be to add an "anonymous" argument to TS-command-line? #WontFix

Pete and I discussed this, but it will be a pretty big change in ts-command-line. We decided to just go with the normal way for now, then potentially change it later.

In reply to: 220407271 [](ancestors = 220407271)

iclanton · 2018-09-26T02:02:01Z

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

+      parameterShortName: '-v',
+      argumentName: 'VERSION_RANGE',
+      description: ''
+    });


Can this be specified as package@version? #WontFix

Could be, but requires extra parsing and whatnot. We will make it like that when we allow anonymous arguments.

In reply to: 220407345 [](ancestors = 220407345)

Don't we already have parsing for that?

In reply to: 220743394 [](ancestors = 220743394,220407345)

Not that I am aware of...

In reply to: 220749976 [](ancestors = 220749976,220743394,220407345)

Can't we just split by the "@" character?

In reply to: 220751648 [](ancestors = 220751648,220749976,220743394,220407345)

iclanton · 2018-09-26T02:02:30Z

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

+      description: 'If specified, the version specifier inserted into the'
+        + ' package.json will be a prepended with a "caret" specifier ("^").'
+    });
+    this._devDependencyFlag = this.defineFlagParameter({


These can be just specified with the version. #ByDesign

?

In reply to: 220407415 [](ancestors = 220407415)

You can specify the version as "~1.2.3" or "^2.3.4"

In reply to: 220743430 [](ancestors = 220743430,220407415)

You highlighted devDependency flag.

And that isn't how --version works. It works how "npm install --save" works.

In reply to: 220750046 [](ancestors = 220750046,220743430,220407415)

So NPM has --carat and --tilde arguments? That seems really clunky.

In reply to: 220751772 [](ancestors = 220751772,220750046,220743430,220407415)

iclanton · 2018-09-26T02:03:12Z

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

+    });
+    this._makeConsistentFlag = this.defineFlagParameter({
+      parameterLongName: '--make-consistent',
+      parameterShortName: '-c',


-c [](start = 27, length = 2)

-m? #Resolved

iclanton · 2018-09-26T02:03:26Z

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

+    });
+    this._noInstallFlag = this.defineFlagParameter({
+      parameterLongName: '--no-install',
+      parameterShortName: '-n',


-n [](start = 27, length = 2)

Is this the same as npm? #WontFix

Wontfix?

In reply to: 220407520 [](ancestors = 220407520)

What do you mean. NPM doesn't have an option for --skip-install or --no-install or anything.

In reply to: 220750062 [](ancestors = 220750062,220407520)

That's what I was asking.

In reply to: 220751842 [](ancestors = 220751842,220750062,220407520)

iclanton · 2018-09-26T02:04:19Z

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

+      parameterLongName: '--version',
+      parameterShortName: '-v',
+      argumentName: 'VERSION_RANGE',
+      description: ''


'' [](start = 19, length = 2)

Include a description. #Resolved

iclanton · 2018-09-26T02:04:25Z

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

+
+  constructor(parser: RushCommandLineParser) {
+    const documentation: string[] = [
+      'Blah.'


Blah [](start = 7, length = 4)

? #Resolved

iclanton · 2018-09-26T02:05:54Z

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

@@ -743,6 +743,16 @@ export class RushConfiguration {
    return this._versionPolicyConfiguration;
  }

+  public getCurrentProjectFromPath(currentFolderPath: string): RushConfigurationProject | undefined {


getCurrentProjectFromPath [](start = 9, length = 25)

getProjectFromPath? It doesn't necessarily need to be the current project or the current path. #Resolved

iclanton · 2018-09-26T02:07:32Z

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

+  public getCurrentProjectFromPath(currentFolderPath: string): RushConfigurationProject | undefined {
+    const resolvedPath: string = path.resolve(currentFolderPath);
+    for (const project of this.projects) {
+      if (path.relative(project.projectFolder, resolvedPath).indexOf('..') !== 0) {


path.relative(project.projectFolder, resolvedPath).indexOf('..') !== 0 [](start = 10, length = 70)

use Path.isUnder from node-core-library. #Resolved

iclanton · 2018-09-26T02:07:53Z

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

@@ -156,6 +156,8 @@ class RushConfiguration {
  readonly eventHooks: EventHooks;
  findProjectByShorthandName(shorthandProjectName: string): RushConfigurationProject | undefined;
  findProjectByTempName(tempProjectName: string): RushConfigurationProject | undefined;
+  // (undocumented)
+  getCurrentProjectFromPath(currentFolderPath: string): RushConfigurationProject | undefined;


Add docs. #Resolved

Why is this the "current" project? Probably it should be getProjectForPath?

In reply to: 220408115 [](ancestors = 220408115)

octogonz · 2018-09-26T21:35:35Z

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

+  public getCurrentProjectFromPath(currentFolderPath: string): RushConfigurationProject | undefined {
+    const resolvedPath: string = path.resolve(currentFolderPath);
+    for (const project of this.projects) {
+      if (path.relative(project.projectFolder, resolvedPath).indexOf('..') !== 0) {


path.relative [](start = 10, length = 13)

Use Path.isUnder #Resolved

octogonz · 2018-09-26T21:36:57Z

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

+                [--dev] [-c] [-n]
+
+
+Blah.


? #Resolved

Document that it's a tilde by default.

In reply to: 220731693 [](ancestors = 220731693)

octogonz · 2018-09-26T21:37:28Z

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

+                        (Required) The name of the package which should be 
+                        added as a dependency
+  -v VERSION_RANGE, --version VERSION_RANGE
+  --exact               If specified, the version specifier inserted into the 


inserted into [](start = 59, length = 14)

"SemVer specifier added to" #Resolved

octogonz · 2018-09-26T21:38:35Z

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

+  -c, --make-consistent
+                        If specified, other packages with this dependency 
+                        will have their package.json files updated to point 
+                        at the specified depdendency


specify the same SemVer range? #Resolved

octogonz · 2018-09-26T21:38:48Z

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

+                        If specified, other packages with this dependency 
+                        will have their package.json files updated to point 
+                        at the specified depdendency
+  -n, --no-install      If specified, the \\"rush update\\" command will not be 


no-install [](start = 8, length = 10)

--skip-update? #Resolved

octogonz · 2018-09-26T21:39:27Z

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

+import { PurgeManager } from './PurgeManager';
+import { Utilities } from '../utilities/Utilities';
+
+export const enum SemVerStyle {


export [](start = 0, length = 6)

Add docs in this file #Resolved

octogonz · 2018-09-28T01:54:43Z

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

@@ -0,0 +1,219 @@
+import * as semver from 'semver';


import [](start = 0, length = 7)

copyright banner #Resolved

octogonz · 2018-09-28T01:55:08Z

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

+   * Returns the project for which the specified path is underneath that project's folder.
+   * If the path is not under any project's folder, returns undefined.
+   */
+  public getProjectForPath(currentFolderPath: string): RushConfigurationProject | undefined {


tryGet? #Resolved

octogonz · 2018-09-28T01:55:23Z

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

   */
  public get packageJson(): IPackageJson {
    return this._packageJson;
  }

+  /**
+   * A useful wrapper around the package.json file for making modifications
+   * @alpha


@beta -- we don't use alpha in WBT #Resolved

octogonz · 2018-09-28T01:55:43Z

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

@@ -172,11 +176,20 @@ export class RushConfigurationProject {

  /**
   * The parsed NPM "package.json" file from projectFolder.
+   * Will be deprecated soon in favor of packageJsonEditor


Will [](start = 5, length = 4)

@deprecated Use packageJsonEditor instead #Resolved

octogonz · 2018-09-28T01:57:53Z

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

+
+
+Adds a dependency on a certain package to the current project (detected using 
+the current working directory) and then runs rush update. If no version is 


rush update [](start = 45, length = 11)

"rush update" #Resolved

octogonz · 2018-09-28T01:58:17Z

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

+latest version or a version that won't break the ensureConsistentVersions 
+policy). If a version range is specified, the latest version in the range 
+will be used. The version will be automatically prepended with a tilde, 
+unless the --exact or --caret flags are used. The --make-consistent flag can 


--exact [](start = 11, length = 7)

"--exact" #Resolved

octogonz · 2018-09-28T01:58:49Z

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

+                        package.json will be a prepended with a \\"caret\\" 
+                        specifier (\\"^\\").
+  -d, --dev             If specified, the package will be added as a 
+                        \\"devDependency\\" to the package.json


\"devDependency\" to the package.json [](start = 23, length = 40)

to the package.json "devDependencies" section #Resolved

octogonz · 2018-09-28T01:59:39Z

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

@@ -202,6 +203,9 @@ class RushConfigurationProject {
  // @beta
  readonly isMainProject: boolean;
  readonly packageJson: IPackageJson;
+  // WARNING: The type "PackageJsonEditor" needs to be exported by the package (e.g. added to index.ts)


PackageJsonEditor [](start = 24, length = 17)

Fix this warning #Resolved

octogonz · 2018-09-28T02:00:44Z

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

+      if (mismatches.length) {
+        if (!updateOtherPackages) {
+          return Promise.reject(new Error(`Adding '${packageName}@${version}' to ${currentProject.packageName}`
+            + ` causes mismatched dependencies. Use the --make-consistent flag to update other packages to use this`


--make-consistent [](start = 56, length = 17)

"--make-consistent" #Resolved

…build-tools into nickpape/rush-add

octogonz

…build-tools into nickpape/rush-add

Nick Pape added 9 commits September 21, 2018 16:41

introduce the new command - incomplete

0f4ae68

API Change

7260861

Fill out most of the rest of the logic for the add command

60f2fa9

Fix lint issues

0ae6ccf

Some small change4s

a66230d

Small changes

9c6f76f

Move add code into a seperate class

30df582

Fix bugs

caf6983

Add logging

0a8a922

Merge branch 'master' into nickpape/rush-add

f094bb8

iclanton reviewed Sep 26, 2018

View reviewed changes

Fix wording

8add64f

octogonz reviewed Sep 26, 2018

View reviewed changes

octogonz reviewed Sep 28, 2018

View reviewed changes

Some PR feedback

1c8e54a

octogonz force-pushed the nickpape/rush-add branch from b593dc7 to ee299b1 Compare September 28, 2018 02:07

Nick Pape and others added 7 commits September 27, 2018 19:09

PR Feedback

abfabf2

More feedback

9d66f66

More feedback

14e448f

Snapshot

6e62fdc

Updating strings

836c9a2

Merge branch 'nickpape/rush-add' of https://github.com/Microsoft/web-…

2909608

…build-tools into nickpape/rush-add

Add change log

e0793d0

octogonz approved these changes Sep 28, 2018

View reviewed changes

Nick Pape added 9 commits September 27, 2018 19:43

Some fixes

ddf3e0b

Fix small bug

d48c7eb

Merge branch 'nickpape/rush-add' of https://github.com/Microsoft/web-…

2d81c46

…build-tools into nickpape/rush-add

Minor changes

128da2f

more bugs

daf87a2

small bug

91b5592

remove debugging:

a115ad5

Missing changefile

2ac1044

Merge branch 'master' into nickpape/rush-add

612e9bf

nickpape merged commit 6587a80 into master Sep 28, 2018

octogonz deleted the nickpape/rush-add branch October 3, 2018 23:37



		Adds a dependency on a certain package to the current project (detected using
		the current working directory) and then runs rush update. If no version is

[rush] Introduce a "rush add" command #843

[rush] Introduce a "rush add" command #843

Conversation

nickpape commented Sep 26, 2018

nickpape commented Sep 26, 2018 • edited Loading

nickpape commented Sep 26, 2018 • edited Loading

nickpape commented Sep 26, 2018 • edited Loading

iclanton Sep 26, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iclanton Sep 26, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iclanton Sep 26, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iclanton Sep 26, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

iclanton Sep 26, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

iclanton Sep 26, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

iclanton Sep 26, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

iclanton Sep 26, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

iclanton Sep 26, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

iclanton Sep 26, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

octogonz Sep 26, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

octogonz Sep 26, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

octogonz Sep 26, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

octogonz Sep 26, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

octogonz Sep 26, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

octogonz Sep 26, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

octogonz Sep 28, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

octogonz Sep 28, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

octogonz Sep 28, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

octogonz Sep 28, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

octogonz Sep 28, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

octogonz Sep 28, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

octogonz Sep 28, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

octogonz Sep 28, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

octogonz Sep 28, 2018 • edited by nickpape Loading

Choose a reason for hiding this comment

octogonz left a comment

Choose a reason for hiding this comment

nickpape commented Sep 26, 2018 •

edited

Loading

nickpape commented Sep 26, 2018 •

edited

Loading

nickpape commented Sep 26, 2018 •

edited

Loading

iclanton Sep 26, 2018 •

edited by nickpape

Loading

iclanton Sep 26, 2018 •

edited by nickpape

Loading

iclanton Sep 26, 2018 •

edited by nickpape

Loading

iclanton Sep 26, 2018 •

edited by nickpape

Loading

iclanton Sep 26, 2018 •

edited by nickpape

Loading

iclanton Sep 26, 2018 •

edited by nickpape

Loading

iclanton Sep 26, 2018 •

edited by nickpape

Loading

iclanton Sep 26, 2018 •

edited by nickpape

Loading

iclanton Sep 26, 2018 •

edited by nickpape

Loading

iclanton Sep 26, 2018 •

edited by nickpape

Loading

octogonz Sep 26, 2018 •

edited by nickpape

Loading

octogonz Sep 26, 2018 •

edited by nickpape

Loading

octogonz Sep 26, 2018 •

edited by nickpape

Loading

octogonz Sep 26, 2018 •

edited by nickpape

Loading

octogonz Sep 26, 2018 •

edited by nickpape

Loading

octogonz Sep 26, 2018 •

edited by nickpape

Loading

octogonz Sep 28, 2018 •

edited by nickpape

Loading

octogonz Sep 28, 2018 •

edited by nickpape

Loading

octogonz Sep 28, 2018 •

edited by nickpape

Loading

octogonz Sep 28, 2018 •

edited by nickpape

Loading

octogonz Sep 28, 2018 •

edited by nickpape

Loading

octogonz Sep 28, 2018 •

edited by nickpape

Loading

octogonz Sep 28, 2018 •

edited by nickpape

Loading

octogonz Sep 28, 2018 •

edited by nickpape

Loading

octogonz Sep 28, 2018 •

edited by nickpape

Loading