Allow colons in command line action names

bsiegel · bsiegel · commit b7bbfabf2a91 · 2019-05-03T14:03:53.000-07:00
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
@@ -26,7 +26,7 @@
       /**
        * (Required) The name that will be typed as part of the command line.  This is also the name
        * of the "scripts" hook in the project's package.json file.
-       * The name should be comprised of lower case words separated by hyphens.
+       * The name should be comprised of lower case words separated by hyphens or colons.
        */
       "name": "my-bulk-command",
 
diff --git a/libraries/ts-command-line/src/CommandLineAction.ts b/libraries/ts-command-line/src/CommandLineAction.ts
@@ -37,7 +37,7 @@ export interface ICommandLineActionOptions {
  */
 export abstract class CommandLineAction extends CommandLineParameterProvider {
   // Example: "do-something"
-  private static _actionNameRegExp: RegExp = /^[a-z]+(-[a-z]+)*$/;
+  private static _actionNameRegExp: RegExp = /^[a-z]+([-:][a-z]+)*$/;
 
   /** {@inheritDoc ICommandLineActionOptions.actionName} */
   public readonly actionName: string;
@@ -55,7 +55,7 @@ export abstract class CommandLineAction extends CommandLineParameterProvider {
 
     if (!CommandLineAction._actionNameRegExp.test(options.actionName)) {
       throw new Error(`Invalid action name "${options.actionName}". `
-        + `The name must be comprised of lower-case words optionally separated by hyphens.`);
+        + `The name must be comprised of lower-case words optionally separated by hyphens or colons.`);
     }
 
     this.actionName = options.actionName;
diff --git a/libraries/ts-command-line/src/test/CommandLineParameter.test.ts b/libraries/ts-command-line/src/test/CommandLineParameter.test.ts
@@ -22,7 +22,7 @@ function createParser(): DynamicCommandLineParser {
   });
 
   const action: DynamicCommandLineAction = new DynamicCommandLineAction({
-    actionName: 'do-job',
+    actionName: 'do:the-job',
     summary: 'does the job',
     documentation: 'a longer description'
   });
@@ -133,17 +133,17 @@ describe('CommandLineParameter', () => {
 
   it('prints the action help', () => {
     const commandLineParser: CommandLineParser = createParser();
-    const helpText: string = colors.stripColors(commandLineParser.getAction('do-job').renderHelpText());
+    const helpText: string = colors.stripColors(commandLineParser.getAction('do:the-job').renderHelpText());
     expect(helpText).toMatchSnapshot();
   });
 
   it('parses an input with ALL parameters', () => {
     const commandLineParser: CommandLineParser = createParser();
-    const action: CommandLineAction = commandLineParser.getAction('do-job');
+    const action: CommandLineAction = commandLineParser.getAction('do:the-job');
 
     const args: string[] = [
       '--global-flag',
-      'do-job',
+      'do:the-job',
       '--choice', 'two',
       '--flag',
       '--integer', '123',
@@ -209,8 +209,8 @@ describe('CommandLineParameter', () => {
 
   it('parses an input with NO parameters', () => {
     const commandLineParser: CommandLineParser = createParser();
-    const action: CommandLineAction = commandLineParser.getAction('do-job');
-    const args: string[] = [ 'do-job', '--integer-required', '123'];
+    const action: CommandLineAction = commandLineParser.getAction('do:the-job');
+    const args: string[] = [ 'do:the-job', '--integer-required', '123'];
 
     return commandLineParser.execute(args).then(() => {
       expect(commandLineParser.selectedAction).toBe(action);
diff --git a/libraries/ts-command-line/src/test/CommandLineParser.test.ts b/libraries/ts-command-line/src/test/CommandLineParser.test.ts
@@ -11,7 +11,7 @@ class TestAction extends CommandLineAction {
 
   public constructor() {
     super({
-      actionName: 'do-job',
+      actionName: 'do:the-job',
       summary: 'does the job',
       documentation: 'a longer description'
     });
@@ -51,9 +51,9 @@ describe('CommandLineParser', () => {
   it('executes an action', () => {
     const commandLineParser: TestCommandLine = new TestCommandLine();
 
-    return commandLineParser.execute(['do-job', '--flag']).then(() => {
+    return commandLineParser.execute(['do:the-job', '--flag']).then(() => {
       expect(commandLineParser.selectedAction).toBeDefined();
-      expect(commandLineParser.selectedAction!.actionName).toEqual('do-job');
+      expect(commandLineParser.selectedAction!.actionName).toEqual('do:the-job');
 
       const action: TestAction = commandLineParser.selectedAction as TestAction;
       expect(action.done).toBe(true);
diff --git a/libraries/ts-command-line/src/test/DynamicCommandLineParser.test.ts b/libraries/ts-command-line/src/test/DynamicCommandLineParser.test.ts
@@ -16,7 +16,7 @@ describe('DynamicCommandLineParser', () => {
     );
 
     const action: DynamicCommandLineAction = new DynamicCommandLineAction({
-      actionName: 'do-job',
+      actionName: 'do:the-job',
       summary: 'does the job',
       documentation: 'a longer description'
     });
@@ -26,7 +26,7 @@ describe('DynamicCommandLineParser', () => {
       description: 'The flag'
     });
 
-    return commandLineParser.execute(['do-job', '--flag']).then(() => {
+    return commandLineParser.execute(['do:the-job', '--flag']).then(() => {
       expect(commandLineParser.selectedAction).toEqual(action);
 
       const retrievedParameter: CommandLineFlagParameter = action.getFlagParameter('--flag');
diff --git a/libraries/ts-command-line/src/test/__snapshots__/CommandLineParameter.test.ts.snap b/libraries/ts-command-line/src/test/__snapshots__/CommandLineParameter.test.ts.snap
@@ -359,12 +359,12 @@ Array [
 `;
 
 exports[`CommandLineParameter prints the action help 1`] = `
-"usage: example do-job [-h] [-c {one,two,three,default}]
-                      [--choice-with-default {one,two,three,default}] [-f]
-                      [-i NUMBER] [--integer-with-default NUMBER]
-                      --integer-required NUMBER [-s TEXT]
-                      [--string-with-default TEXT] [-l LIST]
-                      
+"usage: example do:the-job [-h] [-c {one,two,three,default}]
+                          [--choice-with-default {one,two,three,default}] [-f]
+                          [-i NUMBER] [--integer-with-default NUMBER]
+                          --integer-required NUMBER [-s TEXT]
+                          [--string-with-default TEXT] [-l LIST]
+                          
 
 a longer description
 
@@ -408,7 +408,7 @@ An example project
 
 Positional arguments:
   <command>
-    do-job           does the job
+    do:the-job       does the job
 
 Optional arguments:
   -h, --help         Show this help message and exit.
