From a5b48643fc06262e5aec8def7a53973bbf21de34 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Thu, 11 Aug 2022 18:51:29 -0700 Subject: [PATCH 1/3] Fix issue from https://github.com/microsoft/rushjs.io-website/pull/120 --- libraries/rush-lib/src/cli/actions/AddAction.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/libraries/rush-lib/src/cli/actions/AddAction.ts b/libraries/rush-lib/src/cli/actions/AddAction.ts index 695e15d515..1e308b24bd 100644 --- a/libraries/rush-lib/src/cli/actions/AddAction.ts +++ b/libraries/rush-lib/src/cli/actions/AddAction.ts @@ -46,7 +46,7 @@ export class AddAction extends BaseRushAction { required: true, argumentName: 'PACKAGE', description: - '(Required) The name of the package which should be added as a dependency.' + + 'The name of the package which should be added as a dependency.' + ' A SemVer version specifier can be appended after an "@" sign. WARNING: Symbol characters' + " are usually interpreted by your shell, so it's recommended to use quotes." + ' For example, write "rush add --package "example@^1.2.3"" instead of "rush add --package example@^1.2.3".' + From e7a7715638b10447c9ea659984c90e08d5287b33 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Thu, 11 Aug 2022 19:01:13 -0700 Subject: [PATCH 2/3] rush change --- .../rush/octogonz-rush-add-help_2022-08-12-02-00.json | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 common/changes/@microsoft/rush/octogonz-rush-add-help_2022-08-12-02-00.json diff --git a/common/changes/@microsoft/rush/octogonz-rush-add-help_2022-08-12-02-00.json b/common/changes/@microsoft/rush/octogonz-rush-add-help_2022-08-12-02-00.json new file mode 100644 index 0000000000..7add2c8306 --- /dev/null +++ b/common/changes/@microsoft/rush/octogonz-rush-add-help_2022-08-12-02-00.json @@ -0,0 +1,10 @@ +{ + "changes": [ + { + "packageName": "@microsoft/rush", + "comment": "Update CLI docs for \"rush add\"", + "type": "none" + } + ], + "packageName": "@microsoft/rush" +} \ No newline at end of file From d4911de391d9e7e7eef7b66ae456865fd2973966 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Thu, 11 Aug 2022 19:25:22 -0700 Subject: [PATCH 3/3] Update Jest snapshot --- .../src/cli/test/__snapshots__/CommandLineHelp.test.ts.snap | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/libraries/rush-lib/src/cli/test/__snapshots__/CommandLineHelp.test.ts.snap b/libraries/rush-lib/src/cli/test/__snapshots__/CommandLineHelp.test.ts.snap index 96e58e0ec5..3bc97e1fa9 100644 --- a/libraries/rush-lib/src/cli/test/__snapshots__/CommandLineHelp.test.ts.snap +++ b/libraries/rush-lib/src/cli/test/__snapshots__/CommandLineHelp.test.ts.snap @@ -87,9 +87,9 @@ packages with the dependency. Optional arguments: -h, --help Show this help message and exit. -p PACKAGE, --package PACKAGE - (Required) The name of the package which should be - added as a dependency. A SemVer version specifier can - be appended after an \\"@\\" sign. WARNING: Symbol + The name of the package which should be added as a + dependency. A SemVer version specifier can be + appended after an \\"@\\" sign. WARNING: Symbol characters are usually interpreted by your shell, so it's recommended to use quotes. For example, write \\"rush add --package \\"example@^1.2.3\\"\\" instead of