Merge pull request #389 from rockcarver/pr/388

Pr/388
rockcarver · May 8, 2024 · 31db484 · 31db484
2 parents cd34901 + 1f743bb
commit 31db484
Show file tree

Hide file tree

Showing 240 changed files with 9,778 additions and 9,239 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -119,7 +119,7 @@
     ]
   },
   "dependencies": {
-    "@rockcarver/frodo-lib": "2.0.0-79",
+    "@rockcarver/frodo-lib": "2.0.0-80",
     "chokidar": "^3.5.3",
     "cli-progress": "^3.11.2",
     "cli-table3": "^0.6.3",

diff --git a/src/cli/FrodoCommand.ts b/src/cli/FrodoCommand.ts
@@ -1,5 +1,5 @@
 import { frodo, state } from '@rockcarver/frodo-lib';
-import { Argument, Command, Option } from 'commander';
+import { Argument, Command, Help, Option } from 'commander';
 import fs from 'fs';
 
 import * as globalConfig from '../storage/StaticStorage';
@@ -202,6 +202,17 @@ export class FrodoStubCommand extends Command {
       cleanupProgressIndicators();
     });
   }
+
+  createHelp() {
+    return Object.assign(new FrodoStubHelp(), this.configureHelp());
+  }
+}
+
+class FrodoStubHelp extends Help {
+  subcommandTerm(cmd) {
+    return cmd._name +
+        (cmd._aliases[0] ? '|' + cmd._aliases[0] : '');
+  }
 }
 
 /**

diff --git a/src/cli/_template/something-delete.ts b/src/cli/_template/something-delete.ts
@@ -3,43 +3,45 @@ import { Option } from 'commander';
 import { getTokens } from '../../ops/AuthenticateOps';
 import { FrodoCommand } from '../FrodoCommand';
 
-const program = new FrodoCommand('frodo something delete');
+export default function setup() {
+  const program = new FrodoCommand('frodo something delete');
 
-program
-  .description('Delete something.')
-  .addOption(
-    new Option(
-      '-i, --something-id <something-id>',
-      '[Something] id. If specified, -a and -A are ignored.'
+  program
+    .description('Delete something.')
+    .addOption(
+      new Option(
+        '-i, --something-id <something-id>',
+        '[Something] id. If specified, -a and -A are ignored.'
+      )
     )
-  )
-  .addOption(
-    new Option('-a, --all', 'Delete all [somethings]. Ignored with -i.')
-  )
-  .addOption(
-    new Option(
-      '--no-deep',
-      'No deep delete. This leaves orphaned configuration artifacts behind.'
+    .addOption(
+      new Option('-a, --all', 'Delete all [somethings]. Ignored with -i.')
     )
-  )
-  .action(
-    // implement command logic inside action handler
-    async (host, realm, user, password, options, command) => {
-      command.handleDefaultArgsAndOpts(
-        host,
-        realm,
-        user,
-        password,
-        options,
-        command
-      );
-      if (await getTokens()) {
-        // code goes here
-      } else {
-        process.exitCode = 1;
+    .addOption(
+      new Option(
+        '--no-deep',
+        'No deep delete. This leaves orphaned configuration artifacts behind.'
+      )
+    )
+    .action(
+      // implement command logic inside action handler
+      async (host, realm, user, password, options, command) => {
+        command.handleDefaultArgsAndOpts(
+          host,
+          realm,
+          user,
+          password,
+          options,
+          command
+        );
+        if (await getTokens()) {
+          // code goes here
+        } else {
+          process.exitCode = 1;
+        }
       }
-    }
-    // end command logic inside action handler
-  );
+      // end command logic inside action handler
+    );
 
-program.parse();
+  return program;
+}
diff --git a/src/cli/_template/something-describe.ts b/src/cli/_template/something-describe.ts
@@ -3,29 +3,33 @@ import { Option } from 'commander';
 import { getTokens } from '../../ops/AuthenticateOps';
 import { FrodoCommand } from '../FrodoCommand';
 
-const program = new FrodoCommand('frodo something describe');
+export default function setup() {
+  const program = new FrodoCommand('frodo something describe');
 
-program
-  .description('Describe something.')
-  .addOption(new Option('-i, --something-id <something-id>', '[Something] id.'))
-  .action(
-    // implement command logic inside action handler
-    async (host, realm, user, password, options, command) => {
-      command.handleDefaultArgsAndOpts(
-        host,
-        realm,
-        user,
-        password,
-        options,
-        command
-      );
-      if (await getTokens()) {
-        // code goes here
-      } else {
-        process.exitCode = 1;
+  program
+    .description('Describe something.')
+    .addOption(
+      new Option('-i, --something-id <something-id>', '[Something] id.')
+    )
+    .action(
+      // implement command logic inside action handler
+      async (host, realm, user, password, options, command) => {
+        command.handleDefaultArgsAndOpts(
+          host,
+          realm,
+          user,
+          password,
+          options,
+          command
+        );
+        if (await getTokens()) {
+          // code goes here
+        } else {
+          process.exitCode = 1;
+        }
       }
-    }
-    // end command logic inside action handler
-  );
+      // end command logic inside action handler
+    );
 
-program.parse();
+  return program;
+}
diff --git a/src/cli/_template/something-else-delete.ts b/src/cli/_template/something-else-delete.ts
@@ -3,41 +3,43 @@ import { Option } from 'commander';
 import { getTokens } from '../../ops/AuthenticateOps';
 import { FrodoCommand } from '../FrodoCommand';
 
-const program = new FrodoCommand('frodo something else delete');
+export default function setup() {
+  const program = new FrodoCommand('frodo something else delete');
 
-program
-  .description('Delete something else.')
-  .addOption(
-    new Option(
-      '-i, --else-id <else-id>',
-      '[Else] id. If specified, -a and -A are ignored.'
+  program
+    .description('Delete something else.')
+    .addOption(
+      new Option(
+        '-i, --else-id <else-id>',
+        '[Else] id. If specified, -a and -A are ignored.'
+      )
     )
-  )
-  .addOption(new Option('-a, --all', 'Delete all [elses]. Ignored with -i.'))
-  .addOption(
-    new Option(
-      '--no-deep',
-      'No deep delete. This leaves orphaned configuration artifacts behind.'
+    .addOption(new Option('-a, --all', 'Delete all [elses]. Ignored with -i.'))
+    .addOption(
+      new Option(
+        '--no-deep',
+        'No deep delete. This leaves orphaned configuration artifacts behind.'
+      )
     )
-  )
-  .action(
-    // implement command logic inside action handler
-    async (host, realm, user, password, options, command) => {
-      command.handleDefaultArgsAndOpts(
-        host,
-        realm,
-        user,
-        password,
-        options,
-        command
-      );
-      if (await getTokens()) {
-        // code goes here
-      } else {
-        process.exitCode = 1;
+    .action(
+      // implement command logic inside action handler
+      async (host, realm, user, password, options, command) => {
+        command.handleDefaultArgsAndOpts(
+          host,
+          realm,
+          user,
+          password,
+          options,
+          command
+        );
+        if (await getTokens()) {
+          // code goes here
+        } else {
+          process.exitCode = 1;
+        }
       }
-    }
-    // end command logic inside action handler
-  );
+      // end command logic inside action handler
+    );
 
-program.parse();
+  return program;
+}
diff --git a/src/cli/_template/something-else-describe.ts b/src/cli/_template/something-else-describe.ts
@@ -3,29 +3,31 @@ import { Option } from 'commander';
 import { getTokens } from '../../ops/AuthenticateOps';
 import { FrodoCommand } from '../FrodoCommand';
 
-const program = new FrodoCommand('frodo something else describe');
+export default function setup() {
+  const program = new FrodoCommand('frodo something else describe');
 
-program
-  .description('Describe something else.')
-  .addOption(new Option('-i, --else-id <else-id>', '[Else] id.'))
-  .action(
-    // implement command logic inside action handler
-    async (host, realm, user, password, options, command) => {
-      command.handleDefaultArgsAndOpts(
-        host,
-        realm,
-        user,
-        password,
-        options,
-        command
-      );
-      if (await getTokens()) {
-        // code goes here
-      } else {
-        process.exitCode = 1;
+  program
+    .description('Describe something else.')
+    .addOption(new Option('-i, --else-id <else-id>', '[Else] id.'))
+    .action(
+      // implement command logic inside action handler
+      async (host, realm, user, password, options, command) => {
+        command.handleDefaultArgsAndOpts(
+          host,
+          realm,
+          user,
+          password,
+          options,
+          command
+        );
+        if (await getTokens()) {
+          // code goes here
+        } else {
+          process.exitCode = 1;
+        }
       }
-    }
-    // end command logic inside action handler
-  );
+      // end command logic inside action handler
+    );
 
-program.parse();
+  return program;
+}