@villedemontreal/caporal 3.1.7

package/dist/src/help/__tests__/help.spec.js

@@ -0,0 +1,130 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = require("..");
+const program_1 = require("../../program");
+const command_1 = require("../../command");
+const find_1 = require("../../command/find");
+const strip_ansi_1 = __importDefault(require("strip-ansi"));
+const vitest_1 = require("vitest");
+(0, vitest_1.describe)("help", () => {
+    let prog = new program_1.Program();
+    (0, vitest_1.beforeEach)(() => {
+        prog = new program_1.Program();
+        prog.name("test-prog");
+        prog.bin("test-prog");
+    });
+    (0, vitest_1.describe)("tpl()", () => {
+        (0, vitest_1.it)("should compile template with given context", () => {
+            const cmd = (0, command_1.createCommand)(prog, "test", "test command");
+            const ctx = (0, __1.getContext)(prog, cmd);
+            return (0, vitest_1.expect)((0, __1.tpl)("header", ctx)).resolves.toMatchSnapshot();
+        });
+        (0, vitest_1.it)("should compile a custom template with given context", async () => {
+            const cmd = (0, command_1.createCommand)(prog, "test", "test command");
+            const ctx = (0, __1.getContext)(prog, cmd);
+            (0, __1.registerTemplate)("mine", () => "template-contents");
+            (0, vitest_1.expect)(await (0, __1.tpl)("mine", ctx)).toBe("template-contents");
+        });
+        (0, vitest_1.it)("should fail if template does not exist", () => {
+            const cmd = (0, command_1.createCommand)(prog, "test", "test command");
+            const ctx = (0, __1.getContext)(prog, cmd);
+            return (0, vitest_1.expect)((0, __1.tpl)("unknown", ctx)).rejects.toBeInstanceOf(Error);
+        });
+    });
+    (0, vitest_1.describe)("getHelp()", () => {
+        (0, vitest_1.it)("should display help for a basic program", async () => {
+            return (0, vitest_1.expect)((0, strip_ansi_1.default)(await (0, __1.getHelp)(prog))).toMatchSnapshot();
+        });
+        (0, vitest_1.it)("should display help for a program-command", async () => {
+            prog
+                .argument("<foo>", "Mandarory foo arg")
+                .argument("[other]", "Other args")
+                .option("-f, --file <file>", "Output file");
+            return (0, vitest_1.expect)((0, strip_ansi_1.default)(await (0, __1.getHelp)(prog))).toMatchSnapshot();
+        });
+        (0, vitest_1.it)("should display help for a program having at least one command (with args & options)", async () => {
+            prog
+                .command("test-command", "Test command")
+                .argument("<foo>", "Mandarory foo arg")
+                .argument("[other]", "Other args")
+                .option("-f, --file <file>", "Output file");
+            return (0, vitest_1.expect)((0, strip_ansi_1.default)(await (0, __1.getHelp)(prog))).toMatchSnapshot();
+        });
+        (0, vitest_1.it)("should display help for a program having at least one command (with args only)", async () => {
+            prog
+                .command("test-command", "Test command")
+                .argument("<foo>", "Mandarory foo arg")
+                .argument("[other]", "Other args");
+            return (0, vitest_1.expect)((0, strip_ansi_1.default)(await (0, __1.getHelp)(prog))).toMatchSnapshot();
+        });
+        (0, vitest_1.it)("should display help for a program having at least one command (with options only)", async () => {
+            prog
+                .command("test-command", "Test command")
+                .option("-f, --file <file>", "Output file");
+            return (0, vitest_1.expect)((0, strip_ansi_1.default)(await (0, __1.getHelp)(prog))).toMatchSnapshot();
+        });
+        (0, vitest_1.it)("should handle required options", async () => {
+            prog
+                .command("test-command", "Test command")
+                .option("-f, --file <file>", "Output file", { required: true });
+            const cmd = await (0, find_1.findCommand)(prog, ["test-command"]);
+            (0, vitest_1.expect)((0, strip_ansi_1.default)(await (0, __1.getHelp)(prog, cmd))).toContain("required");
+            return (0, vitest_1.expect)((0, strip_ansi_1.default)(await (0, __1.getHelp)(prog, cmd))).toMatchSnapshot();
+        });
+        (0, vitest_1.it)("should handle type hints", async () => {
+            prog
+                .command("test-command", "Test command")
+                .argument("<foo>", "Desc", { validator: prog.NUMBER })
+                .option("-f, --file <file>", "Output file", {
+                required: true,
+                validator: prog.NUMBER,
+            });
+            const cmd = await (0, find_1.findCommand)(prog, ["test-command"]);
+            return (0, vitest_1.expect)((0, strip_ansi_1.default)(await (0, __1.getHelp)(prog, cmd))).toMatchSnapshot();
+        });
+        (0, vitest_1.it)("should work with a program without a specified name", async () => {
+            prog = new program_1.Program();
+            prog.bin("test-prog");
+            prog
+                .command("test-command", "Test command")
+                .option("-f, --file <file>", "Output file");
+            return (0, vitest_1.expect)((0, strip_ansi_1.default)(await (0, __1.getHelp)(prog))).toMatchSnapshot();
+        });
+        (0, vitest_1.it)("should work with a program without a version", async () => {
+            prog = new program_1.Program();
+            prog.bin("test-prog");
+            prog.version("");
+            prog
+                .command("test-command", "Test command")
+                .option("-f, --file <file>", "Output file");
+            (0, vitest_1.expect)((0, strip_ansi_1.default)(await (0, __1.getHelp)(prog))).toMatchSnapshot();
+        });
+        (0, vitest_1.it)("should display program description", async () => {
+            prog.description("Description test");
+            prog
+                .command("test-command", "Test command")
+                .option("-f, --file <file>", "Output file");
+            (0, vitest_1.expect)((0, strip_ansi_1.default)(await (0, __1.getHelp)(prog))).toMatchSnapshot();
+        });
+        (0, vitest_1.it)("should display customized program help", async () => {
+            prog.description("Description test");
+            prog
+                .help("My custom help")
+                .command("test-command", "Test command")
+                .option("-f, --file <file>", "Output file");
+            (0, vitest_1.expect)((0, strip_ansi_1.default)(await (0, __1.getHelp)(prog))).toMatchSnapshot();
+        });
+        (0, vitest_1.it)("should display customized program help on multiple lines", async () => {
+            prog.description("Description test");
+            prog
+                .command("test-command", "Test command")
+                .option("-f, --file <file>", "Output file")
+                .help("My custom help\nAnother line\nOne last line");
+            (0, vitest_1.expect)((0, strip_ansi_1.default)(await (0, __1.getHelp)(prog))).toMatchSnapshot();
+        });
+    });
+});
+//# sourceMappingURL=help.spec.js.map

package/dist/src/help/__tests__/help.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"help.spec.js","sourceRoot":"","sources":["../../../../src/help/__tests__/help.spec.ts"],"names":[],"mappings":";;;;;AAAA,0BAA+D;AAC/D,2CAAuC;AACvC,2CAA6C;AAC7C,6CAAgD;AAChD,4DAA8B;AAC9B,mCAAyD;AAEzD,IAAA,iBAAQ,EAAC,MAAM,EAAE,GAAG,EAAE;IACpB,IAAI,IAAI,GAAG,IAAI,iBAAO,EAAE,CAAA;IAExB,IAAA,mBAAU,EAAC,GAAG,EAAE;QACd,IAAI,GAAG,IAAI,iBAAO,EAAE,CAAA;QACpB,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACtB,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;IACvB,CAAC,CAAC,CAAA;IAEF,IAAA,iBAAQ,EAAC,OAAO,EAAE,GAAG,EAAE;QACrB,IAAA,WAAE,EAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,MAAM,GAAG,GAAG,IAAA,uBAAa,EAAC,IAAI,EAAE,MAAM,EAAE,cAAc,CAAC,CAAA;YACvD,MAAM,GAAG,GAAG,IAAA,cAAU,EAAC,IAAI,EAAE,GAAG,CAAC,CAAA;YACjC,OAAO,IAAA,eAAM,EAAC,IAAA,OAAG,EAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAA;QAC9D,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;YACnE,MAAM,GAAG,GAAG,IAAA,uBAAa,EAAC,IAAI,EAAE,MAAM,EAAE,cAAc,CAAC,CAAA;YACvD,MAAM,GAAG,GAAG,IAAA,cAAU,EAAC,IAAI,EAAE,GAAG,CAAC,CAAA;YACjC,IAAA,oBAAgB,EAAC,MAAM,EAAE,GAAG,EAAE,CAAC,mBAAmB,CAAC,CAAA;YACnD,IAAA,eAAM,EAAC,MAAM,IAAA,OAAG,EAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAA;QAC1D,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,wCAAwC,EAAE,GAAG,EAAE;YAChD,MAAM,GAAG,GAAG,IAAA,uBAAa,EAAC,IAAI,EAAE,MAAM,EAAE,cAAc,CAAC,CAAA;YACvD,MAAM,GAAG,GAAG,IAAA,cAAU,EAAC,IAAI,EAAE,GAAG,CAAC,CAAA;YACjC,OAAO,IAAA,eAAM,EAAC,IAAA,OAAG,EAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;QAClE,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAA,iBAAQ,EAAC,WAAW,EAAE,GAAG,EAAE;QACzB,IAAA,WAAE,EAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;YACvD,OAAO,IAAA,eAAM,EAAC,IAAA,oBAAK,EAAC,MAAM,IAAA,WAAO,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,EAAE,CAAA;QAC7D,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;YACzD,IAAI;iBACD,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC;iBACtC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;iBACjC,MAAM,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAA;YAE7C,OAAO,IAAA,eAAM,EAAC,IAAA,oBAAK,EAAC,MAAM,IAAA,WAAO,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,EAAE,CAAA;QAC7D,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,qFAAqF,EAAE,KAAK,IAAI,EAAE;YACnG,IAAI;iBACD,OAAO,CAAC,cAAc,EAAE,cAAc,CAAC;iBACvC,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC;iBACtC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;iBACjC,MAAM,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAA;YAC7C,OAAO,IAAA,eAAM,EAAC,IAAA,oBAAK,EAAC,MAAM,IAAA,WAAO,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,EAAE,CAAA;QAC7D,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,gFAAgF,EAAE,KAAK,IAAI,EAAE;YAC9F,IAAI;iBACD,OAAO,CAAC,cAAc,EAAE,cAAc,CAAC;iBACvC,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC;iBACtC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC,CAAA;YACpC,OAAO,IAAA,eAAM,EAAC,IAAA,oBAAK,EAAC,MAAM,IAAA,WAAO,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,EAAE,CAAA;QAC7D,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,mFAAmF,EAAE,KAAK,IAAI,EAAE;YACjG,IAAI;iBACD,OAAO,CAAC,cAAc,EAAE,cAAc,CAAC;iBACvC,MAAM,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAA;YAC7C,OAAO,IAAA,eAAM,EAAC,IAAA,oBAAK,EAAC,MAAM,IAAA,WAAO,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,EAAE,CAAA;QAC7D,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;YAC9C,IAAI;iBACD,OAAO,CAAC,cAAc,EAAE,cAAc,CAAC;iBACvC,MAAM,CAAC,mBAAmB,EAAE,aAAa,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAA;YACjE,MAAM,GAAG,GAAG,MAAM,IAAA,kBAAW,EAAC,IAAI,EAAE,CAAC,cAAc,CAAC,CAAC,CAAA;YAErD,IAAA,eAAM,EAAC,IAAA,oBAAK,EAAC,MAAM,IAAA,WAAO,EAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAA;YAC7D,OAAO,IAAA,eAAM,EAAC,IAAA,oBAAK,EAAC,MAAM,IAAA,WAAO,EAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,eAAe,EAAE,CAAA;QAClE,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;YACxC,IAAI;iBACD,OAAO,CAAC,cAAc,EAAE,cAAc,CAAC;iBACvC,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;iBACrD,MAAM,CAAC,mBAAmB,EAAE,aAAa,EAAE;gBAC1C,QAAQ,EAAE,IAAI;gBACd,SAAS,EAAE,IAAI,CAAC,MAAM;aACvB,CAAC,CAAA;YACJ,MAAM,GAAG,GAAG,MAAM,IAAA,kBAAW,EAAC,IAAI,EAAE,CAAC,cAAc,CAAC,CAAC,CAAA;YAErD,OAAO,IAAA,eAAM,EAAC,IAAA,oBAAK,EAAC,MAAM,IAAA,WAAO,EAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,eAAe,EAAE,CAAA;QAClE,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;YACnE,IAAI,GAAG,IAAI,iBAAO,EAAE,CAAA;YACpB,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;YACrB,IAAI;iBACD,OAAO,CAAC,cAAc,EAAE,cAAc,CAAC;iBACvC,MAAM,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAA;YAC7C,OAAO,IAAA,eAAM,EAAC,IAAA,oBAAK,EAAC,MAAM,IAAA,WAAO,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,EAAE,CAAA;QAC7D,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;YAC5D,IAAI,GAAG,IAAI,iBAAO,EAAE,CAAA;YACpB,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAA;YACrB,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;YAChB,IAAI;iBACD,OAAO,CAAC,cAAc,EAAE,cAAc,CAAC;iBACvC,MAAM,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAA;YAC7C,IAAA,eAAM,EAAC,IAAA,oBAAK,EAAC,MAAM,IAAA,WAAO,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,EAAE,CAAA;QACtD,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;YAClD,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAA;YACpC,IAAI;iBACD,OAAO,CAAC,cAAc,EAAE,cAAc,CAAC;iBACvC,MAAM,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAA;YAC7C,IAAA,eAAM,EAAC,IAAA,oBAAK,EAAC,MAAM,IAAA,WAAO,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,EAAE,CAAA;QACtD,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;YACtD,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAA;YACpC,IAAI;iBACD,IAAI,CAAC,gBAAgB,CAAC;iBACtB,OAAO,CAAC,cAAc,EAAE,cAAc,CAAC;iBACvC,MAAM,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAA;YAC7C,IAAA,eAAM,EAAC,IAAA,oBAAK,EAAC,MAAM,IAAA,WAAO,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,EAAE,CAAA;QACtD,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;YACxE,IAAI,CAAC,WAAW,CAAC,kBAAkB,CAAC,CAAA;YACpC,IAAI;iBACD,OAAO,CAAC,cAAc,EAAE,cAAc,CAAC;iBACvC,MAAM,CAAC,mBAAmB,EAAE,aAAa,CAAC;iBAC1C,IAAI,CAAC,6CAA6C,CAAC,CAAA;YACtD,IAAA,eAAM,EAAC,IAAA,oBAAK,EAAC,MAAM,IAAA,WAAO,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,EAAE,CAAA;QACtD,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/src/help/__tests__/utils.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=utils.spec.d.ts.map

package/dist/src/help/__tests__/utils.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.spec.d.ts","sourceRoot":"","sources":["../../../../src/help/__tests__/utils.spec.ts"],"names":[],"mappings":""}

package/dist/src/help/__tests__/utils.spec.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../utils");
+const argument_1 = require("../../argument");
+const caporal_1 = require("../../validator/caporal");
+const vitest_1 = require("vitest");
+(0, vitest_1.describe)("help/utils", () => {
+    (0, vitest_1.it)("getDefaultValueHint() should return the correct value hint", () => {
+        const arg = (0, argument_1.createArgument)("<arg>", "My arg", {
+            validator: caporal_1.CaporalValidator.BOOLEAN,
+            default: true,
+        });
+        (0, vitest_1.expect)((0, utils_1.getDefaultValueHint)(arg)).toBe("default: true");
+    });
+});
+//# sourceMappingURL=utils.spec.js.map

package/dist/src/help/__tests__/utils.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.spec.js","sourceRoot":"","sources":["../../../../src/help/__tests__/utils.spec.ts"],"names":[],"mappings":";;AAAA,oCAA8C;AAC9C,6CAA+C;AAC/C,qDAA0D;AAC1D,mCAA6C;AAE7C,IAAA,iBAAQ,EAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,IAAA,WAAE,EAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,MAAM,GAAG,GAAG,IAAA,yBAAc,EAAC,OAAO,EAAE,QAAQ,EAAE;YAC5C,SAAS,EAAE,0BAAgB,CAAC,OAAO;YACnC,OAAO,EAAE,IAAI;SACd,CAAC,CAAA;QACF,IAAA,eAAM,EAAC,IAAA,2BAAmB,EAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;IACxD,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/src/help/index.d.ts

@@ -0,0 +1,47 @@
+/**
+ * @packageDocumentation
+ * @module caporal/help
+ */
+import { Command } from "../command";
+import { Program } from "../program";
+import { CustomizedHelpOpts, TemplateContext, Template } from "./types";
+/**
+ * Customize the help
+ *
+ * @param obj
+ * @param text
+ * @param options
+ * @internal
+ */
+export declare function customizeHelp(obj: Command | Program, text: string, options: Partial<CustomizedHelpOpts>): void;
+/**
+ * Register a new help template
+ *
+ * @param name Template name
+ * @param template Template function
+ *
+ */
+export declare function registerTemplate(name: string, template: Template): Map<string, Template>;
+/**
+ * Helper to be used to call templates from within templates
+ *
+ * @param name Template name
+ * @param ctx Execution context
+ * @internal
+ */
+export declare function tpl(name: string, ctx: TemplateContext): Promise<string>;
+/**
+ * @internal
+ * @param program
+ * @param command
+ */
+export declare function getContext(program: Program, command?: Command): TemplateContext;
+/**
+ * Return the help text
+ *
+ * @param program Program instance
+ * @param command Command instance, if any
+ * @internal
+ */
+export declare function getHelp(program: Program, command?: Command): Promise<string>;
+//# sourceMappingURL=index.d.ts.map

package/dist/src/help/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/help/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAOpC,OAAO,EAAqB,kBAAkB,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AAK1F;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAC3B,GAAG,EAAE,OAAO,GAAG,OAAO,EACtB,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,OAAO,CAAC,kBAAkB,CAAC,GACnC,IAAI,CASN;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,QAAQ,GACjB,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAEvB;AAED;;;;;;GAMG;AACH,wBAAsB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,CAM7E;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,eAAe,CAoB/E;AAED;;;;;;GAMG;AACH,wBAAsB,OAAO,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAGlF"}

package/dist/src/help/index.js

@@ -0,0 +1,131 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.customizeHelp = customizeHelp;
+exports.registerTemplate = registerTemplate;
+exports.tpl = tpl;
+exports.getContext = getContext;
+exports.getHelp = getHelp;
+const replace_1 = __importDefault(require("lodash/replace"));
+const chalk_1 = __importDefault(require("chalk"));
+const utils_1 = require("./utils");
+const colorize_1 = require("../utils/colorize");
+const allTemplates = __importStar(require("./templates"));
+const option_1 = require("../option");
+const templates = new Map(Object.entries(allTemplates));
+const customHelpMap = new Map();
+/**
+ * Customize the help
+ *
+ * @param obj
+ * @param text
+ * @param options
+ * @internal
+ */
+function customizeHelp(obj, text, options) {
+    const opts = {
+        sectionName: "",
+        colorize: true,
+        ...options,
+    };
+    const data = customHelpMap.get(obj) || [];
+    data.push({ text, options: opts });
+    customHelpMap.set(obj, data);
+}
+/**
+ * Register a new help template
+ *
+ * @param name Template name
+ * @param template Template function
+ *
+ */
+function registerTemplate(name, template) {
+    return templates.set(name, template);
+}
+/**
+ * Helper to be used to call templates from within templates
+ *
+ * @param name Template name
+ * @param ctx Execution context
+ * @internal
+ */
+async function tpl(name, ctx) {
+    const template = templates.get(name);
+    if (!template) {
+        throw Error(`Caporal setup error: Unknown help template '${name}'`);
+    }
+    return template(ctx);
+}
+/**
+ * @internal
+ * @param program
+ * @param command
+ */
+function getContext(program, command) {
+    const spaces = " ".repeat(2);
+    const ctx = {
+        prog: program,
+        cmd: command,
+        chalk: chalk_1.default,
+        colorize: colorize_1.colorize,
+        customHelp: customHelpMap,
+        tpl,
+        globalOptions: (0, option_1.getGlobalOptions)(),
+        table: utils_1.buildTable,
+        spaces,
+        indent(str, sp = spaces) {
+            return sp + (0, replace_1.default)(str.trim(), /(\r\n|\r|\n)/g, "\n" + sp);
+        },
+        eol: "\n",
+        eol2: "\n\n",
+        eol3: "\n\n\n",
+    };
+    return ctx;
+}
+/**
+ * Return the help text
+ *
+ * @param program Program instance
+ * @param command Command instance, if any
+ * @internal
+ */
+async function getHelp(program, command) {
+    const ctx = getContext(program, command);
+    return [await tpl("header", ctx), await tpl("usage", ctx)].join("");
+}
+//# sourceMappingURL=index.js.map

package/dist/src/help/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/help/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,sCAaC;AASD,4CAKC;AASD,kBAMC;AAOD,gCAoBC;AASD,0BAGC;AApGD,6DAAoC;AACpC,kDAAyB;AACzB,mCAAoC;AACpC,gDAA4C;AAC5C,0DAA2C;AAC3C,sCAA4C;AAG5C,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAA;AACvD,MAAM,aAAa,GAAsB,IAAI,GAAG,EAAE,CAAA;AAElD;;;;;;;GAOG;AACH,SAAgB,aAAa,CAC3B,GAAsB,EACtB,IAAY,EACZ,OAAoC;IAEpC,MAAM,IAAI,GAAuB;QAC/B,WAAW,EAAE,EAAE;QACf,QAAQ,EAAE,IAAI;QACd,GAAG,OAAO;KACX,CAAA;IACD,MAAM,IAAI,GAAG,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAA;IACzC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAA;IAClC,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;AAC9B,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAC9B,IAAY,EACZ,QAAkB;IAElB,OAAO,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAA;AACtC,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,GAAG,CAAC,IAAY,EAAE,GAAoB;IAC1D,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;IACpC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,MAAM,KAAK,CAAC,+CAA+C,IAAI,GAAG,CAAC,CAAA;IACrE,CAAC;IACD,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAA;AACtB,CAAC;AAED;;;;GAIG;AACH,SAAgB,UAAU,CAAC,OAAgB,EAAE,OAAiB;IAC5D,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;IAC5B,MAAM,GAAG,GAAoB;QAC3B,IAAI,EAAE,OAAO;QACb,GAAG,EAAE,OAAO;QACZ,KAAK,EAAE,eAAK;QACZ,QAAQ,EAAE,mBAAQ;QAClB,UAAU,EAAE,aAAa;QACzB,GAAG;QACH,aAAa,EAAE,IAAA,yBAAgB,GAAE;QACjC,KAAK,EAAE,kBAAU;QACjB,MAAM;QACN,MAAM,CAAC,GAAW,EAAE,EAAE,GAAG,MAAM;YAC7B,OAAO,EAAE,GAAG,IAAA,iBAAO,EAAC,GAAG,CAAC,IAAI,EAAE,EAAE,eAAe,EAAE,IAAI,GAAG,EAAE,CAAC,CAAA;QAC7D,CAAC;QACD,GAAG,EAAE,IAAI;QACT,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,QAAQ;KACf,CAAA;IACD,OAAO,GAAG,CAAA;AACZ,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,OAAO,CAAC,OAAgB,EAAE,OAAiB;IAC/D,MAAM,GAAG,GAAG,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IACxC,OAAO,CAAC,MAAM,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;AACrE,CAAC"}

package/dist/src/help/templates/command.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @packageDocumentation
+ * @internal
+ */
+import type { Template } from "../types";
+export declare const command: Template;
+//# sourceMappingURL=command.d.ts.map

package/dist/src/help/templates/command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.d.ts","sourceRoot":"","sources":["../../../../src/help/templates/command.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAmB,QAAQ,EAAE,MAAM,UAAU,CAAA;AAIzD,eAAO,MAAM,OAAO,EAAE,QAiBrB,CAAA"}

package/dist/src/help/templates/command.js

@@ -0,0 +1,23 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.command = void 0;
+const utils_1 = require("../utils");
+const sortBy_1 = __importDefault(require("lodash/sortBy"));
+const command = async (ctx) => {
+    const { cmd, globalOptions: globalFlags, eol, eol3, colorize, tpl } = ctx;
+    const options = (0, sortBy_1.default)(cmd.options, "name"), globalOptions = Array.from(globalFlags.keys());
+    const help = cmd.synopsis +
+        eol3 +
+        (await tpl("custom", ctx)) +
+        (0, utils_1.getArgumentsTable)(cmd.args, ctx) +
+        eol +
+        (0, utils_1.getOptionsTable)(options, ctx) +
+        eol +
+        (0, utils_1.getOptionsTable)(globalOptions, ctx, "GLOBAL OPTIONS");
+    return colorize(help);
+};
+exports.command = command;
+//# sourceMappingURL=command.js.map

package/dist/src/help/templates/command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"command.js","sourceRoot":"","sources":["../../../../src/help/templates/command.ts"],"names":[],"mappings":";;;;;;AAMA,oCAA6D;AAC7D,2DAAkC;AAE3B,MAAM,OAAO,GAAa,KAAK,EAAE,GAAoB,EAAE,EAAE;IAC9D,MAAM,EAAE,GAAG,EAAE,aAAa,EAAE,WAAW,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,GAAG,CAAA;IAEzE,MAAM,OAAO,GAAG,IAAA,gBAAM,EAAC,GAAI,CAAC,OAAO,EAAE,MAAM,CAAC,EAC1C,aAAa,GAAG,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAA;IAEhD,MAAM,IAAI,GACR,GAAI,CAAC,QAAQ;QACb,IAAI;QACJ,CAAC,MAAM,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QAC1B,IAAA,yBAAiB,EAAC,GAAI,CAAC,IAAI,EAAE,GAAG,CAAC;QACjC,GAAG;QACH,IAAA,uBAAe,EAAC,OAAO,EAAE,GAAG,CAAC;QAC7B,GAAG;QACH,IAAA,uBAAe,EAAC,aAAa,EAAE,GAAG,EAAE,gBAAgB,CAAC,CAAA;IAEvD,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAA;AACvB,CAAC,CAAA;AAjBY,QAAA,OAAO,WAiBnB"}

package/dist/src/help/templates/custom.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @packageDocumentation
+ * @internal
+ */
+import type { Template } from "../types";
+export declare const custom: Template;
+//# sourceMappingURL=custom.d.ts.map

package/dist/src/help/templates/custom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom.d.ts","sourceRoot":"","sources":["../../../../src/help/templates/custom.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAmB,QAAQ,EAAE,MAAM,UAAU,CAAA;AAEzD,eAAO,MAAM,MAAM,EAAE,QAkBpB,CAAA"}

package/dist/src/help/templates/custom.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.custom = void 0;
+const custom = (ctx) => {
+    const { prog, cmd, eol2, eol3, chalk, colorize, customHelp, indent } = ctx;
+    const data = customHelp.get(cmd || prog);
+    if (data) {
+        const txt = data
+            .map(({ text, options }) => {
+            let str = "";
+            if (options.sectionName) {
+                str += chalk.bold(options.sectionName) + eol2;
+            }
+            const subtxt = options.colorize ? colorize(text) : text;
+            str += options.sectionName ? indent(subtxt) : subtxt;
+            return str + eol3;
+        })
+            .join("");
+        return indent(txt) + eol3;
+    }
+    return "";
+};
+exports.custom = custom;
+//# sourceMappingURL=custom.js.map

package/dist/src/help/templates/custom.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom.js","sourceRoot":"","sources":["../../../../src/help/templates/custom.ts"],"names":[],"mappings":";;;AAMO,MAAM,MAAM,GAAa,CAAC,GAAoB,EAAE,EAAE;IACvD,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,GAAG,CAAA;IAC1E,MAAM,IAAI,GAAG,UAAU,CAAC,GAAG,CAAC,GAAG,IAAI,IAAI,CAAC,CAAA;IACxC,IAAI,IAAI,EAAE,CAAC;QACT,MAAM,GAAG,GAAG,IAAI;aACb,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE;YACzB,IAAI,GAAG,GAAG,EAAE,CAAA;YACZ,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;gBACxB,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,IAAI,CAAA;YAC/C,CAAC;YACD,MAAM,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;YACvD,GAAG,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;YACpD,OAAO,GAAG,GAAG,IAAI,CAAA;QACnB,CAAC,CAAC;aACD,IAAI,CAAC,EAAE,CAAC,CAAA;QACX,OAAO,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAA;IAC3B,CAAC;IACD,OAAO,EAAE,CAAA;AACX,CAAC,CAAA;AAlBY,QAAA,MAAM,UAkBlB"}

package/dist/src/help/templates/header.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @packageDocumentation
+ * @internal
+ */
+import type { Template } from "../types";
+export declare const header: Template;
+//# sourceMappingURL=header.d.ts.map

package/dist/src/help/templates/header.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"header.d.ts","sourceRoot":"","sources":["../../../../src/help/templates/header.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAmB,QAAQ,EAAE,MAAM,UAAU,CAAA;AAEzD,eAAO,MAAM,MAAM,EAAE,QAYpB,CAAA"}

package/dist/src/help/templates/header.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.header = void 0;
+const header = (ctx) => {
+    const { prog, chalk: c, spaces, eol, eol2 } = ctx;
+    const version = process.env?.NODE_ENV === "test" ? "" : prog.getVersion();
+    return (eol +
+        spaces +
+        (prog.getName() || prog.getBin()) +
+        " " +
+        (version || "") +
+        (prog.getDescription() ? " \u2014 " + c.dim(prog.getDescription()) : "") +
+        eol2);
+};
+exports.header = header;
+//# sourceMappingURL=header.js.map

package/dist/src/help/templates/header.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"header.js","sourceRoot":"","sources":["../../../../src/help/templates/header.ts"],"names":[],"mappings":";;;AAMO,MAAM,MAAM,GAAa,CAAC,GAAoB,EAAE,EAAE;IACvD,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,GAAG,CAAA;IACjD,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,EAAE,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,EAAE,CAAA;IACzE,OAAO,CACL,GAAG;QACH,MAAM;QACN,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;QACjC,GAAG;QACH,CAAC,OAAO,IAAI,EAAE,CAAC;QACf,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,UAAU,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACxE,IAAI,CACL,CAAA;AACH,CAAC,CAAA;AAZY,QAAA,MAAM,UAYlB"}

package/dist/src/help/templates/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @packageDocumentation
+ * @internal
+ */
+export * from "./command";
+export * from "./header";
+export * from "./program";
+export * from "./usage";
+export * from "./custom";
+//# sourceMappingURL=index.d.ts.map

package/dist/src/help/templates/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/help/templates/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA;AACvB,cAAc,UAAU,CAAA"}

package/dist/src/help/templates/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * @packageDocumentation
+ * @internal
+ */
+__exportStar(require("./command"), exports);
+__exportStar(require("./header"), exports);
+__exportStar(require("./program"), exports);
+__exportStar(require("./usage"), exports);
+__exportStar(require("./custom"), exports);
+//# sourceMappingURL=index.js.map

package/dist/src/help/templates/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/help/templates/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;;GAGG;AACH,4CAAyB;AACzB,2CAAwB;AACxB,4CAAyB;AACzB,0CAAuB;AACvB,2CAAwB"}

package/dist/src/help/templates/program.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @packageDocumentation
+ * @internal
+ */
+import type { Template } from "../types";
+export declare const program: Template;
+//# sourceMappingURL=program.d.ts.map

package/dist/src/help/templates/program.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"program.d.ts","sourceRoot":"","sources":["../../../../src/help/templates/program.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAmB,QAAQ,EAAE,MAAM,UAAU,CAAA;AAGzD,eAAO,MAAM,OAAO,EAAE,QAarB,CAAA"}

package/dist/src/help/templates/program.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.program = void 0;
+const utils_1 = require("../utils");
+const program = async (ctx) => {
+    const { prog, globalOptions, eol, eol3, colorize, tpl } = ctx;
+    const commands = await prog.getAllCommands();
+    const options = Array.from(globalOptions.keys());
+    const help = (await prog.getSynopsis()) +
+        eol3 +
+        (await tpl("custom", ctx)) +
+        (0, utils_1.getCommandsTable)(commands, ctx) +
+        eol +
+        (0, utils_1.getOptionsTable)(options, ctx, "GLOBAL OPTIONS");
+    return colorize(help);
+};
+exports.program = program;
+//# sourceMappingURL=program.js.map

package/dist/src/help/templates/program.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"program.js","sourceRoot":"","sources":["../../../../src/help/templates/program.ts"],"names":[],"mappings":";;;AAKA,oCAA4D;AAErD,MAAM,OAAO,GAAa,KAAK,EAAE,GAAoB,EAAE,EAAE;IAC9D,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,GAAG,CAAA;IAC7D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAA;IAC5C,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAA;IAChD,MAAM,IAAI,GACR,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAC1B,IAAI;QACJ,CAAC,MAAM,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QAC1B,IAAA,wBAAgB,EAAC,QAAQ,EAAE,GAAG,CAAC;QAC/B,GAAG;QACH,IAAA,uBAAe,EAAC,OAAO,EAAE,GAAG,EAAE,gBAAgB,CAAC,CAAA;IAEjD,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAA;AACvB,CAAC,CAAA;AAbY,QAAA,OAAO,WAanB"}

package/dist/src/help/templates/usage.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @packageDocumentation
+ * @internal
+ */
+import type { Template } from "../types";
+export declare const usage: Template;
+//# sourceMappingURL=usage.d.ts.map

package/dist/src/help/templates/usage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage.d.ts","sourceRoot":"","sources":["../../../../src/help/templates/usage.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAmB,QAAQ,EAAE,MAAM,UAAU,CAAA;AAEzD,eAAO,MAAM,KAAK,EAAE,QAiBnB,CAAA"}

package/dist/src/help/templates/usage.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.usage = void 0;
+const usage = async (ctx) => {
+    const { tpl, prog, chalk: c, spaces, eol } = ctx;
+    let { cmd } = ctx;
+    // if help is asked without a `cmd` and that no command exists
+    // within the program, override `cmd` with the program-command
+    if (!cmd && !(await prog.hasCommands())) {
+        ctx.cmd = cmd = prog.progCommand;
+    }
+    // usage
+    const usage = `${spaces + c.bold("USAGE")} ${cmd?.name ? "— " + c.dim(cmd.name) : ""}
+  ${eol + spaces + spaces + c.dim("\u25B8")} `;
+    const next = cmd ? await tpl("command", ctx) : await tpl("program", ctx);
+    return usage + next;
+};
+exports.usage = usage;
+//# sourceMappingURL=usage.js.map

package/dist/src/help/templates/usage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"usage.js","sourceRoot":"","sources":["../../../../src/help/templates/usage.ts"],"names":[],"mappings":";;;AAMO,MAAM,KAAK,GAAa,KAAK,EAAE,GAAoB,EAAE,EAAE;IAC5D,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,CAAA;IAChD,IAAI,EAAE,GAAG,EAAE,GAAG,GAAG,CAAA;IAEjB,8DAA8D;IAC9D,8DAA8D;IAC9D,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;QACxC,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,IAAI,CAAC,WAAW,CAAA;IAClC,CAAC;IAED,QAAQ;IACR,MAAM,KAAK,GAAG,GAAG,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;IAClF,GAAG,GAAG,MAAM,GAAG,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAA;IAE5C,MAAM,IAAI,GAAG,GAAG,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,CAAA;IAExE,OAAO,KAAK,GAAG,IAAI,CAAA;AACrB,CAAC,CAAA;AAjBY,QAAA,KAAK,SAiBjB"}