Improve the command-line help phrasing for the "--to ." feature.

iclanton · iclanton · commit 4007e0dadec8 · 2020-01-30T01:57:34.000-08:00
diff --git a/apps/rush-lib/src/cli/scriptActions/BulkScriptAction.ts b/apps/rush-lib/src/cli/scriptActions/BulkScriptAction.ts
@@ -167,8 +167,8 @@ export class BulkScriptAction extends BaseScriptAction {
       parameterLongName: '--to',
       parameterShortName: '-t',
       argumentName: 'PROJECT1',
-      description: 'Run command in the specified project and all of its dependencies. To include ' +
-        'the project in the working directory, include "."'
+      description: 'Run command in the specified project and all of its dependencies. "." can be used as shorthand ' +
+        'to specify the project in the current working directory.'
     });
     this._fromVersionPolicy =  this.defineStringListParameter({
       parameterLongName: '--from-version-policy',
@@ -186,7 +186,7 @@ export class BulkScriptAction extends BaseScriptAction {
       parameterShortName: '-f',
       argumentName: 'PROJECT2',
       description: 'Run command in all projects that directly or indirectly depend on the specified project. ' +
-        ' To include the project in the working directory, include "."'
+        '"." can be used as shorthand to specify the project in the current working directory.'
     });
     this._verboseParameter = this.defineFlagParameter({
       parameterLongName: '--verbose',
diff --git a/apps/rush-lib/src/cli/test/__snapshots__/CommandLineHelp.test.ts.snap b/apps/rush-lib/src/cli/test/__snapshots__/CommandLineHelp.test.ts.snap
@@ -124,8 +124,8 @@ Optional arguments:
                         CPU cores.
   -t PROJECT1, --to PROJECT1
                         Run command in the specified project and all of its 
-                        dependencies. To include the project in the working 
-                        directory, include \\".\\"
+                        dependencies. \\".\\" can be used as shorthand to specify 
+                        the project in the current working directory.
   --from-version-policy VERSION_POLICY_NAME
                         Run command in all projects with the specified 
                         version policy and all projects that directly or 
@@ -136,9 +136,9 @@ Optional arguments:
                         version policy and all of their dependencies
   -f PROJECT2, --from PROJECT2
                         Run command in all projects that directly or 
-                        indirectly depend on the specified project. To 
-                        include the project in the working directory, include 
-                        \\".\\"
+                        indirectly depend on the specified project. \\".\\" can 
+                        be used as shorthand to specify the project in the 
+                        current working directory.
   -v, --verbose         Display the logs during the build, rather than just 
                         displaying the build status summary
   -o, --changed-projects-only
@@ -253,8 +253,8 @@ Optional arguments:
                         CPU cores.
   -t PROJECT1, --to PROJECT1
                         Run command in the specified project and all of its 
-                        dependencies. To include the project in the working 
-                        directory, include \\".\\"
+                        dependencies. \\".\\" can be used as shorthand to specify 
+                        the project in the current working directory.
   --from-version-policy VERSION_POLICY_NAME
                         Run command in all projects with the specified 
                         version policy and all projects that directly or 
@@ -265,9 +265,9 @@ Optional arguments:
                         version policy and all of their dependencies
   -f PROJECT2, --from PROJECT2
                         Run command in all projects that directly or 
-                        indirectly depend on the specified project. To 
-                        include the project in the working directory, include 
-                        \\".\\"
+                        indirectly depend on the specified project. \\".\\" can 
+                        be used as shorthand to specify the project in the 
+                        current working directory.
   -v, --verbose         Display the logs during the build, rather than just 
                         displaying the build status summary
   --locale {en-us,fr-fr,es-es,zh-cn}
@@ -506,8 +506,8 @@ Optional arguments:
                         CPU cores.
   -t PROJECT1, --to PROJECT1
                         Run command in the specified project and all of its 
-                        dependencies. To include the project in the working 
-                        directory, include \\".\\"
+                        dependencies. \\".\\" can be used as shorthand to specify 
+                        the project in the current working directory.
   --from-version-policy VERSION_POLICY_NAME
                         Run command in all projects with the specified 
                         version policy and all projects that directly or 
@@ -518,9 +518,9 @@ Optional arguments:
                         version policy and all of their dependencies
   -f PROJECT2, --from PROJECT2
                         Run command in all projects that directly or 
-                        indirectly depend on the specified project. To 
-                        include the project in the working directory, include 
-                        \\".\\"
+                        indirectly depend on the specified project. \\".\\" can 
+                        be used as shorthand to specify the project in the 
+                        current working directory.
   -v, --verbose         Display the logs during the build, rather than just 
                         displaying the build status summary
   -s, --ship            Perform a production build, including minification 
