feat(command): add exit option help method (#275)

c4spar · Aug 22, 2021 · ab38cc7 · ab38cc7
1 parent a6138b2
commit ab38cc7
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 8 deletions.
diff --git a/command/README.md b/command/README.md
@@ -1249,6 +1249,8 @@ await new Command()
     hints: true, // default: true
     // Enable/disable colors.
     colors: false, // default: true
+    // Enable/disable exiting after print
+    exit: true, // default: true
   })
   .option("-f, --foo [val:number]", "Some description.", {
     required: true,

diff --git a/command/command.ts b/command/command.ts
@@ -34,7 +34,7 @@ import { NumberType } from "./types/number.ts";
 import { StringType } from "./types/string.ts";
 import { Type } from "./type.ts";
 import { HelpGenerator } from "./help/_help_generator.ts";
-import type { HelpOptions } from "./help/_help_generator.ts";
+import type { HelpGeneratorOptions } from "./help/_help_generator.ts";
 import type {
   IAction,
   IArgument,
@@ -89,6 +89,10 @@ type MapArgumentTypes<A extends Array<unknown>> = A extends Array<unknown>
   : // deno-lint-ignore no-explicit-any
   any;
 
+export interface HelpOptions extends HelpGeneratorOptions {
+  exit?: boolean;
+}
+
 export class Command<
   // deno-lint-ignore no-explicit-any
   CO extends Record<string, any> | void = any,
@@ -133,6 +137,7 @@ export class Command<
   private _versionOption?: IDefaultOption | false;
   private _helpOption?: IDefaultOption | false;
   private _help?: IHelpHandler;
+  private exitOnHelp: undefined | boolean;
 
   /** Disable version option. */
   public versionOption(enable: false): this;
@@ -432,7 +437,7 @@ export class Command<
 
   /**
    * Set command help.
-   * @param help Help string or method that returns the help string.
+   * @param help Help string, method, or config for generator that returns the help string.
    */
   public help(
     help:
@@ -445,6 +450,7 @@ export class Command<
     } else if (typeof help === "function") {
       this.cmd._help = help;
     } else {
+      this.cmd.exitOnHelp = help.exit;
       this.cmd._help = (cmd: Command): string =>
         HelpGenerator.generate(cmd, help);
     }
@@ -671,6 +677,12 @@ export class Command<
     return this.cmd.throwOnError || !!this.cmd._parent?.shouldThrowErrors();
   }
 
+  /** Check wether the command should exit after printing help */
+  protected shouldExitOnHelp(): boolean {
+    return this.cmd.exitOnHelp ??
+      (this.cmd._parent?.shouldExitOnHelp() ?? true);
+  }
+
   public globalOption<G extends Record<string, unknown> | void = CG>(
     flags: string,
     desc: string,
@@ -953,7 +965,9 @@ export class Command<
           prepend: true,
           action: function () {
             this.showVersion();
-            Deno.exit(0);
+            if (this.shouldExitOnHelp()) {
+              Deno.exit(0);
+            }
           },
           ...(this._versionOption?.opts ?? {}),
         },
@@ -970,7 +984,9 @@ export class Command<
           prepend: true,
           action: function () {
             this.showHelp();
-            Deno.exit(0);
+            if (this.shouldExitOnHelp()) {
+              Deno.exit(0);
+            }
           },
           ...(this._helpOption?.opts ?? {}),
         },

diff --git a/command/help/_help_generator.ts b/command/help/_help_generator.ts
@@ -18,7 +18,7 @@ import type { IArgument } from "../types.ts";
 import type { IEnvVar, IExample, IOption } from "../types.ts";
 import { Type } from "../type.ts";
 
-export interface HelpOptions {
+export interface HelpGeneratorOptions {
   types?: boolean;
   hints?: boolean;
   colors?: boolean;
@@ -27,14 +27,17 @@ export interface HelpOptions {
 /** Help text generator. */
 export class HelpGenerator {
   private indent = 2;
-  private options: Required<HelpOptions>;
+  private options: Required<HelpGeneratorOptions>;
 
   /** Generate help text for given command. */
-  public static generate(cmd: Command, options?: HelpOptions): string {
+  public static generate(cmd: Command, options?: HelpGeneratorOptions): string {
     return new HelpGenerator(cmd, options).generate();
   }
 
-  private constructor(private cmd: Command, options: HelpOptions = {}) {
+  private constructor(
+    private cmd: Command,
+    options: HelpGeneratorOptions = {},
+  ) {
     this.options = {
       types: false,
       hints: true,