@villedemontreal/caporal 3.1.7

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

@@ -0,0 +1,53 @@
+/**
+ * @packageDocumentation
+ * @module caporal/types
+ */
+import { Command } from "../command";
+import { Program } from "../program";
+import chalk from "chalk";
+import { colorize } from "../utils/colorize";
+import { buildTable } from "./utils";
+import type { GlobalOptions } from "../types";
+export interface CustomizedHelpOpts {
+    /**
+     * Name of the section to be added in help.
+     */
+    sectionName: string;
+    /**
+     * Enable or disable the automatic coloration of text.
+     */
+    colorize: boolean;
+}
+export interface CustomizedHelp {
+    /**
+     * Various display options.
+     */
+    options: CustomizedHelpOpts;
+    /**
+     * Help text. Padding of the text is automatically handled for you.
+     */
+    text: string;
+}
+export type CustomizedHelpMap = Map<Command | Program, CustomizedHelp[]>;
+export interface Template {
+    (ctx: TemplateContext): Promise<string> | string;
+}
+export interface TemplateFunction {
+    (name: string, ctx: TemplateContext): Promise<string> | string;
+}
+export interface TemplateContext {
+    prog: Program;
+    cmd?: Command;
+    customHelp: CustomizedHelpMap;
+    globalOptions: GlobalOptions;
+    chalk: typeof chalk;
+    colorize: typeof colorize;
+    tpl: TemplateFunction;
+    table: typeof buildTable;
+    indent: (str: string) => string;
+    eol: string;
+    eol2: string;
+    eol3: string;
+    spaces: string;
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/help/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AACpC,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AACpC,OAAO,KAAK,MAAM,OAAO,CAAA;AACzB,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AACpC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAE7C,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAA;CAClB;AACD,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,EAAE,kBAAkB,CAAA;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,MAAM,iBAAiB,GAAG,GAAG,CAAC,OAAO,GAAG,OAAO,EAAE,cAAc,EAAE,CAAC,CAAA;AAExE,MAAM,WAAW,QAAQ;IACvB,CAAC,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAA;CACjD;AAED,MAAM,WAAW,gBAAgB;IAC/B,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAA;CAC/D;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,OAAO,CAAA;IACb,GAAG,CAAC,EAAE,OAAO,CAAA;IACb,UAAU,EAAE,iBAAiB,CAAA;IAC7B,aAAa,EAAE,aAAa,CAAA;IAC5B,KAAK,EAAE,OAAO,KAAK,CAAA;IACnB,QAAQ,EAAE,OAAO,QAAQ,CAAA;IACzB,GAAG,EAAE,gBAAgB,CAAA;IACrB,KAAK,EAAE,OAAO,UAAU,CAAA;IACxB,MAAM,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAA;IAC/B,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;CACf"}

package/dist/src/help/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

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

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

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

@@ -0,0 +1,9 @@
+import type { TemplateContext } from "./types";
+import type { Option, Argument } from "../types";
+import type { Command } from "../command";
+export declare function buildTable(data: string[][], options?: {}): string;
+export declare function getDefaultValueHint(obj: Argument | Option): string | undefined;
+export declare function getOptionsTable(options: Option[], ctx: TemplateContext, title?: string): string;
+export declare function getArgumentsTable(args: Argument[], ctx: TemplateContext, title?: string): string;
+export declare function getCommandsTable(commands: Command[], ctx: TemplateContext, title?: string): string;
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/help/utils.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAC9C,OAAO,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAChD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAEzC,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,KAAK,GAAG,MAAM,CAuBjE;AAED,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAK9E;AAYD,wBAAgB,eAAe,CAC7B,OAAO,EAAE,MAAM,EAAE,EACjB,GAAG,EAAE,eAAe,EACpB,KAAK,SAAY,GAChB,MAAM,CAeR;AAED,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,QAAQ,EAAE,EAChB,GAAG,EAAE,eAAe,EACpB,KAAK,SAAc,GAClB,MAAM,CAaR;AAED,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,OAAO,EAAE,EACnB,GAAG,EAAE,eAAe,EACpB,KAAK,SAAa,GACjB,MAAM,CAYR"}

package/dist/src/help/utils.js

@@ -0,0 +1,92 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildTable = buildTable;
+exports.getDefaultValueHint = getDefaultValueHint;
+exports.getOptionsTable = getOptionsTable;
+exports.getArgumentsTable = getArgumentsTable;
+exports.getCommandsTable = getCommandsTable;
+/**
+ * @packageDocumentation
+ * @internal
+ */
+const table_1 = require("table");
+const filter_1 = __importDefault(require("lodash/filter"));
+function buildTable(data, options = {}) {
+    return (0, table_1.table)(data, {
+        border: (0, table_1.getBorderCharacters)(`void`),
+        columnDefault: {
+            paddingLeft: 0,
+            paddingRight: 2,
+        },
+        columns: {
+            0: {
+                paddingLeft: 4,
+                width: 35,
+            },
+            1: {
+                width: 55,
+                wrapWord: true,
+                paddingRight: 0,
+            },
+        },
+        drawHorizontalLine: () => {
+            return false;
+        },
+        ...options,
+    });
+}
+function getDefaultValueHint(obj) {
+    return obj.default !== undefined &&
+        !("boolean" in obj && obj.boolean && obj.default === false)
+        ? "default: " + JSON.stringify(obj.default)
+        : undefined;
+}
+function getOptionSynopsisHelp(opt, { eol: crlf, chalk: c }) {
+    return (opt.synopsis +
+        (opt.required && opt.default === undefined ? crlf + c.dim("required") : ""));
+}
+function getOptionsTable(options, ctx, title = "OPTIONS") {
+    options = (0, filter_1.default)(options, "visible");
+    if (!options.length) {
+        return "";
+    }
+    const { chalk: c, eol: crlf, table, spaces } = ctx;
+    const help = spaces + c.bold(title) + crlf + crlf;
+    const rows = options.map((opt) => {
+        const def = getDefaultValueHint(opt);
+        const more = [opt.typeHint, def].filter((d) => d).join(", ");
+        const syno = getOptionSynopsisHelp(opt, ctx);
+        const desc = opt.description + (more.length ? crlf + c.dim(more) : "");
+        return [syno, desc];
+    });
+    return help + table(rows);
+}
+function getArgumentsTable(args, ctx, title = "ARGUMENTS") {
+    if (!args.length) {
+        return "";
+    }
+    const { chalk: c, eol, eol2, table, spaces } = ctx;
+    const help = spaces + c.bold(title) + eol2;
+    const rows = args.map((a) => {
+        const def = getDefaultValueHint(a);
+        const more = [a.typeHint, def].filter((d) => d).join(", ");
+        const desc = a.description + (more.length ? eol + c.dim(more) : "");
+        return [a.synopsis, desc];
+    });
+    return help + table(rows);
+}
+function getCommandsTable(commands, ctx, title = "COMMANDS") {
+    const { chalk, prog, eol2, table, spaces } = ctx;
+    const cmdHint = `Type '${prog.getBin()} help <command>' to get some help about a command`;
+    const help = spaces + chalk.bold(title) + ` ${chalk.dim("\u2014")} ` + chalk.dim(cmdHint) + eol2;
+    const rows = commands
+        .filter((c) => c.visible)
+        .map((cmd) => {
+        return [chalk.hex("#ff9900")(cmd.name), cmd.description || ""];
+    });
+    return help + table(rows);
+}
+//# sourceMappingURL=utils.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/help/utils.ts"],"names":[],"mappings":";;;;;AAUA,gCAuBC;AAED,kDAKC;AAYD,0CAmBC;AAED,8CAiBC;AAED,4CAgBC;AA5GD;;;GAGG;AACH,iCAAkD;AAClD,2DAAkC;AAKlC,SAAgB,UAAU,CAAC,IAAgB,EAAE,OAAO,GAAG,EAAE;IACvD,OAAO,IAAA,aAAK,EAAC,IAAI,EAAE;QACjB,MAAM,EAAE,IAAA,2BAAmB,EAAC,MAAM,CAAC;QACnC,aAAa,EAAE;YACb,WAAW,EAAE,CAAC;YACd,YAAY,EAAE,CAAC;SAChB;QACD,OAAO,EAAE;YACP,CAAC,EAAE;gBACD,WAAW,EAAE,CAAC;gBACd,KAAK,EAAE,EAAE;aACV;YACD,CAAC,EAAE;gBACD,KAAK,EAAE,EAAE;gBACT,QAAQ,EAAE,IAAI;gBACd,YAAY,EAAE,CAAC;aAChB;SACF;QACD,kBAAkB,EAAE,GAAG,EAAE;YACvB,OAAO,KAAK,CAAA;QACd,CAAC;QACD,GAAG,OAAO;KACX,CAAC,CAAA;AACJ,CAAC;AAED,SAAgB,mBAAmB,CAAC,GAAsB;IACxD,OAAO,GAAG,CAAC,OAAO,KAAK,SAAS;QAC9B,CAAC,CAAC,SAAS,IAAI,GAAG,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,KAAK,KAAK,CAAC;QAC3D,CAAC,CAAC,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC;QAC3C,CAAC,CAAC,SAAS,CAAA;AACf,CAAC;AAED,SAAS,qBAAqB,CAC5B,GAAW,EACX,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAmB;IAExC,OAAO,CACL,GAAG,CAAC,QAAQ;QACZ,CAAC,GAAG,CAAC,QAAQ,IAAI,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAC5E,CAAA;AACH,CAAC;AAED,SAAgB,eAAe,CAC7B,OAAiB,EACjB,GAAoB,EACpB,KAAK,GAAG,SAAS;IAEjB,OAAO,GAAG,IAAA,gBAAM,EAAC,OAAO,EAAE,SAAS,CAAC,CAAA;IACpC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QACpB,OAAO,EAAE,CAAA;IACX,CAAC;IACD,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,GAAG,CAAA;IAClD,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,GAAG,IAAI,CAAA;IACjD,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QAC/B,MAAM,GAAG,GAAG,mBAAmB,CAAC,GAAG,CAAC,CAAA;QACpC,MAAM,IAAI,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC5D,MAAM,IAAI,GAAG,qBAAqB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;QAC5C,MAAM,IAAI,GAAG,GAAG,CAAC,WAAW,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;QACtE,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;IACrB,CAAC,CAAC,CAAA;IACF,OAAO,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAA;AAC3B,CAAC;AAED,SAAgB,iBAAiB,CAC/B,IAAgB,EAChB,GAAoB,EACpB,KAAK,GAAG,WAAW;IAEnB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;QACjB,OAAO,EAAE,CAAA;IACX,CAAC;IACD,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,GAAG,CAAA;IAClD,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAA;IAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QAC1B,MAAM,GAAG,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAA;QAClC,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC1D,MAAM,IAAI,GAAG,CAAC,CAAC,WAAW,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAA;QACnE,OAAO,CAAC,CAAC,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;IAC3B,CAAC,CAAC,CAAA;IACF,OAAO,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAA;AAC3B,CAAC;AAED,SAAgB,gBAAgB,CAC9B,QAAmB,EACnB,GAAoB,EACpB,KAAK,GAAG,UAAU;IAElB,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,GAAG,CAAA;IAChD,MAAM,OAAO,GAAG,SAAS,IAAI,CAAC,MAAM,EAAE,mDAAmD,CAAA;IACzF,MAAM,IAAI,GACR,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,IAAI,CAAA;IACrF,MAAM,IAAI,GAAG,QAAQ;SAClB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;SACxB,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACX,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,WAAW,IAAI,EAAE,CAAC,CAAA;IAChE,CAAC,CAAC,CAAA;IAEJ,OAAO,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAA;AAC3B,CAAC"}

package/dist/src/index.d.ts

@@ -0,0 +1,90 @@
+/**
+ * Main Caporal module.
+ *
+ * ## program
+ *
+ * This represents your program. You don't have to instanciate the {@link Program} class,
+ * it's already done for you.
+ *
+ * **Usage**
+ *
+ * ```ts
+ * // The Program instance generated for you
+ * import program from "@caporal/core"
+ *
+ * program
+ *  .command(...)
+ *  .action(...)
+ * [...]
+ * ```
+ *
+ *
+ * ## parseArgv()
+ *
+ *  This is the command line parser internaly used by Caporal.
+ *
+ * ::: tip Advanced usage
+ * Usually, **you won't need to use the parser** directly, but if you
+ * just want to parse some args without all capabilities brought
+ * by Caporal, feel free to play with it.
+ * :::
+ *
+ * **Usage**
+ *
+ * ```ts
+ * import { parseArgv } from "@caporal/core"
+ *
+ * const {args, options} = parseArgv({
+ *  // ... options
+ * })
+ * ```
+ *
+ * Checkout `parseArgv()` [documentation here](/api/modules/parser.md).
+ *
+ *
+ * ## chalk
+ *
+ * `chalk` npm module re-export
+ *
+ * **Usage**
+ *
+ * ```ts
+ * import { program, chalk } from "caporal"
+ *
+ * program
+ *  .command('pay')
+ *  .argument('<amount>', 'Amount to pay', Validator.NUMBER)
+ *  .action(({logger, args}) => {
+ *    logger.info("You paid $%s", chalk.red(args.amount))
+ *  })
+ * [...]
+ * ```
+ *
+ *
+ * @packageDocumentation
+ * @module @villedemontreal/caporal
+ */
+import { Program } from "./program";
+export { Command } from "./command";
+export * from "./types";
+/**
+ * @ignore
+ */
+export { default as chalk } from "chalk";
+/**
+ * @ignore
+ */
+export { parseArgv, parseLine } from "./parser";
+/**
+ * @ignore
+ */
+export declare const program: Program;
+/**
+ * @ignore
+ */
+export default program;
+/**
+ * @ignore
+ */
+export { Program };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AACH,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,cAAc,SAAS,CAAA;AAEvB;;GAEG;AACH,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,OAAO,CAAA;AACxC;;GAEG;AACH,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,UAAU,CAAA;AAE/C;;GAEG;AACH,eAAO,MAAM,OAAO,SAAgB,CAAA;AAEpC;;GAEG;AACH,eAAe,OAAO,CAAA;AAEtB;;GAEG;AACH,OAAO,EAAE,OAAO,EAAE,CAAA"}

package/dist/src/index.js

@@ -0,0 +1,111 @@
+"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);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Program = exports.program = exports.parseLine = exports.parseArgv = exports.chalk = exports.Command = void 0;
+/**
+ * Main Caporal module.
+ *
+ * ## program
+ *
+ * This represents your program. You don't have to instanciate the {@link Program} class,
+ * it's already done for you.
+ *
+ * **Usage**
+ *
+ * ```ts
+ * // The Program instance generated for you
+ * import program from "@caporal/core"
+ *
+ * program
+ *  .command(...)
+ *  .action(...)
+ * [...]
+ * ```
+ *
+ *
+ * ## parseArgv()
+ *
+ *  This is the command line parser internaly used by Caporal.
+ *
+ * ::: tip Advanced usage
+ * Usually, **you won't need to use the parser** directly, but if you
+ * just want to parse some args without all capabilities brought
+ * by Caporal, feel free to play with it.
+ * :::
+ *
+ * **Usage**
+ *
+ * ```ts
+ * import { parseArgv } from "@caporal/core"
+ *
+ * const {args, options} = parseArgv({
+ *  // ... options
+ * })
+ * ```
+ *
+ * Checkout `parseArgv()` [documentation here](/api/modules/parser.md).
+ *
+ *
+ * ## chalk
+ *
+ * `chalk` npm module re-export
+ *
+ * **Usage**
+ *
+ * ```ts
+ * import { program, chalk } from "caporal"
+ *
+ * program
+ *  .command('pay')
+ *  .argument('<amount>', 'Amount to pay', Validator.NUMBER)
+ *  .action(({logger, args}) => {
+ *    logger.info("You paid $%s", chalk.red(args.amount))
+ *  })
+ * [...]
+ * ```
+ *
+ *
+ * @packageDocumentation
+ * @module @villedemontreal/caporal
+ */
+const program_1 = require("./program");
+Object.defineProperty(exports, "Program", { enumerable: true, get: function () { return program_1.Program; } });
+var command_1 = require("./command");
+Object.defineProperty(exports, "Command", { enumerable: true, get: function () { return command_1.Command; } });
+__exportStar(require("./types"), exports);
+/**
+ * @ignore
+ */
+var chalk_1 = require("chalk");
+Object.defineProperty(exports, "chalk", { enumerable: true, get: function () { return __importDefault(chalk_1).default; } });
+/**
+ * @ignore
+ */
+var parser_1 = require("./parser");
+Object.defineProperty(exports, "parseArgv", { enumerable: true, get: function () { return parser_1.parseArgv; } });
+Object.defineProperty(exports, "parseLine", { enumerable: true, get: function () { return parser_1.parseLine; } });
+/**
+ * @ignore
+ */
+exports.program = new program_1.Program();
+/**
+ * @ignore
+ */
+exports.default = exports.program;
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AACH,uCAAmC;AA0B1B,wFA1BA,iBAAO,OA0BA;AAzBhB,qCAAmC;AAA1B,kGAAA,OAAO,OAAA;AAChB,0CAAuB;AAEvB;;GAEG;AACH,+BAAwC;AAA/B,+GAAA,OAAO,OAAS;AACzB;;GAEG;AACH,mCAA+C;AAAtC,mGAAA,SAAS,OAAA;AAAE,mGAAA,SAAS,OAAA;AAE7B;;GAEG;AACU,QAAA,OAAO,GAAG,IAAI,iBAAO,EAAE,CAAA;AAEpC;;GAEG;AACH,kBAAe,eAAO,CAAA"}

package/dist/src/logger/__tests__/logger.spec.d.ts

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

package/dist/src/logger/__tests__/logger.spec.d.ts.map

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

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

@@ -0,0 +1,56 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable no-console */
+const index_1 = require("../../index");
+const program_1 = require("../../program");
+const __1 = require("..");
+const chalk_1 = __importDefault(require("chalk"));
+const strip_ansi_1 = __importDefault(require("strip-ansi"));
+const vitest_1 = require("vitest");
+const os_1 = require("os");
+(0, vitest_1.describe)("logger", () => {
+    // @ts-expect-error TS says _stdout does note exist on console but it does
+    const logStdoutSpy = vitest_1.vi.spyOn(console._stdout, "write"); // winston use this
+    let prog = index_1.program;
+    (0, vitest_1.beforeEach)(() => {
+        prog = new program_1.Program();
+        prog.name("test-prog");
+        prog.bin("test-prog");
+        prog.version("xyz");
+        logStdoutSpy.mockClear();
+        __1.logger.level = "info";
+    });
+    (0, vitest_1.it)("logger should handle metadata", () => {
+        __1.logger.info("foo", { blabla: "joe" });
+        (0, vitest_1.expect)((0, strip_ansi_1.default)(logStdoutSpy.mock.calls[0][0])).toBe(`info: foo${os_1.EOL}info: { blabla: 'joe' }${os_1.EOL}`);
+    });
+    (0, vitest_1.it)("level string should be colorized by default", () => {
+        __1.logger.info("my-info");
+        (0, vitest_1.expect)(logStdoutSpy).toHaveBeenLastCalledWith(`${chalk_1.default.hex("#569cd6")("info")}: my-info${os_1.EOL}`);
+        __1.logger.warn("my-warn");
+        (0, vitest_1.expect)(logStdoutSpy).toHaveBeenLastCalledWith(`${chalk_1.default.hex("#FF9900")("warn")}: my-warn${os_1.EOL}`);
+        __1.logger.error("my-error");
+        (0, vitest_1.expect)(logStdoutSpy).toHaveBeenLastCalledWith(`${os_1.EOL}${chalk_1.default.bold.redBright("error")}: my-error${os_1.EOL}${os_1.EOL}`);
+        // set level to "debug" for the next test
+        __1.logger.level = "debug";
+        __1.logger.debug("my-debug");
+        (0, vitest_1.expect)(logStdoutSpy).toHaveBeenLastCalledWith(`${chalk_1.default.dim("debug")}: my-debug${os_1.EOL}`);
+        // set level to "silly" for the next test
+        __1.logger.level = "silly";
+        __1.logger.silly("my-silly");
+        (0, vitest_1.expect)(logStdoutSpy).toHaveBeenLastCalledWith(`${chalk_1.default.dim("silly")}: my-silly${os_1.EOL}`);
+        __1.logger.http("foo");
+        (0, vitest_1.expect)(logStdoutSpy).toHaveBeenLastCalledWith(`http: foo${os_1.EOL}`);
+    });
+    (0, vitest_1.it)("logger.disableColors() should disable colors", () => {
+        __1.logger.disableColors();
+        __1.logger.info("my-info");
+        (0, vitest_1.expect)(logStdoutSpy).toHaveBeenLastCalledWith(`info: my-info${os_1.EOL}`);
+        // revert back
+        __1.logger.colorsEnabled = true;
+    });
+});
+//# sourceMappingURL=logger.spec.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"logger.spec.js","sourceRoot":"","sources":["../../../../src/logger/__tests__/logger.spec.ts"],"names":[],"mappings":";;;;;AAAA,+BAA+B;AAC/B,uCAAqC;AACrC,2CAAuC;AACvC,0BAA2B;AAC3B,kDAAqB;AACrB,4DAAkC;AAClC,mCAA6D;AAC7D,2BAAwB;AAExB,IAAA,iBAAQ,EAAC,QAAQ,EAAE,GAAG,EAAE;IACtB,0EAA0E;IAC1E,MAAM,YAAY,GAAG,WAAE,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA,CAAC,mBAAmB;IAC3E,IAAI,IAAI,GAAG,eAAO,CAAA;IAElB,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;QACrB,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QACnB,YAAY,CAAC,SAAS,EAAE,CAAA;QACxB,UAAM,CAAC,KAAK,GAAG,MAAM,CAAA;IACvB,CAAC,CAAC,CAAA;IAEF,IAAA,WAAE,EAAC,+BAA+B,EAAE,GAAG,EAAE;QACvC,UAAM,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAA;QACrC,IAAA,eAAM,EAAC,IAAA,oBAAS,EAAC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAsB,CAAC,CAAC,CAAC,IAAI,CACxE,YAAY,QAAG,0BAA0B,QAAG,EAAE,CAC/C,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,IAAA,WAAE,EAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,UAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACtB,IAAA,eAAM,EAAC,YAAY,CAAC,CAAC,wBAAwB,CAC3C,GAAG,eAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,YAAY,QAAG,EAAE,CAC7C,CAAA;QACD,UAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACtB,IAAA,eAAM,EAAC,YAAY,CAAC,CAAC,wBAAwB,CAC3C,GAAG,eAAC,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,YAAY,QAAG,EAAE,CAC7C,CAAA;QACD,UAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;QACxB,IAAA,eAAM,EAAC,YAAY,CAAC,CAAC,wBAAwB,CAC3C,GAAG,QAAG,GAAG,eAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,aAAa,QAAG,GAAG,QAAG,EAAE,CAC3D,CAAA;QACD,yCAAyC;QACzC,UAAM,CAAC,KAAK,GAAG,OAAO,CAAA;QACtB,UAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;QACxB,IAAA,eAAM,EAAC,YAAY,CAAC,CAAC,wBAAwB,CAAC,GAAG,eAAC,CAAC,GAAG,CAAC,OAAO,CAAC,aAAa,QAAG,EAAE,CAAC,CAAA;QAElF,yCAAyC;QACzC,UAAM,CAAC,KAAK,GAAG,OAAO,CAAA;QACtB,UAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;QACxB,IAAA,eAAM,EAAC,YAAY,CAAC,CAAC,wBAAwB,CAAC,GAAG,eAAC,CAAC,GAAG,CAAC,OAAO,CAAC,aAAa,QAAG,EAAE,CAAC,CAAA;QAElF,UAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAClB,IAAA,eAAM,EAAC,YAAY,CAAC,CAAC,wBAAwB,CAAC,YAAY,QAAG,EAAE,CAAC,CAAA;IAClE,CAAC,CAAC,CAAA;IAEF,IAAA,WAAE,EAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,UAAM,CAAC,aAAa,EAAE,CAAA;QACtB,UAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACtB,IAAA,eAAM,EAAC,YAAY,CAAC,CAAC,wBAAwB,CAAC,gBAAgB,QAAG,EAAE,CAAC,CAAA;QACpE,cAAc;QACd,UAAM,CAAC,aAAa,GAAG,IAAI,CAAA;IAC7B,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

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

@@ -0,0 +1,6 @@
+import type { Logger } from "../types";
+export declare let logger: Logger;
+export declare function setLogger(loggerObj: Logger): void;
+export declare function getLogger(): Logger;
+export declare function createDefaultLogger(): Logger;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/logger/index.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AA8DtC,eAAO,IAAI,MAAM,EAAE,MAA8B,CAAA;AAEjD,wBAAgB,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAEjD;AAED,wBAAgB,SAAS,IAAI,MAAM,CAElC;AAED,wBAAgB,mBAAmB,IAAI,MAAM,CAiB5C"}

package/dist/src/logger/index.js

@@ -0,0 +1,128 @@
+"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.logger = void 0;
+exports.setLogger = setLogger;
+exports.getLogger = getLogger;
+exports.createDefaultLogger = createDefaultLogger;
+/**
+ * @packageDocumentation
+ * @internal
+ */
+const winston_1 = require("winston");
+const util_1 = require("util");
+const chalk_1 = __importStar(require("chalk"));
+const replace_1 = __importDefault(require("lodash/replace"));
+const os_1 = require("os");
+const caporalFormat = winston_1.format.printf((data) => {
+    const { level, ...meta } = data;
+    let { message } = data;
+    let prefix = "";
+    const levelStr = getLevelString(level);
+    const metaStr = formatMeta(meta);
+    if (metaStr !== "") {
+        message += `${os_1.EOL}${levelStr}: ${metaStr}`;
+    }
+    if (level === "error") {
+        const spaces = " ".repeat(Number(meta.paddingLeft) || 7);
+        prefix = os_1.EOL;
+        message = `${(0, replace_1.default)(message.toString(), new RegExp(os_1.EOL, "g"), os_1.EOL + spaces)}${os_1.EOL}`;
+    }
+    return `${prefix}${levelStr}: ${message}`;
+});
+function formatMeta(meta) {
+    delete meta.message;
+    delete meta[Symbol.for("level")];
+    delete meta[Symbol.for("message")];
+    delete meta[Symbol.for("splat")];
+    if (Object.keys(meta).length) {
+        return (0, util_1.inspect)(meta, {
+            showHidden: false,
+            colors: exports.logger.colorsEnabled,
+        });
+    }
+    return "";
+}
+function getLevelString(level) {
+    if (!exports.logger.colorsEnabled) {
+        return level;
+    }
+    let levelStr = level;
+    switch (level) {
+        case "error":
+            levelStr = chalk_1.default.bold.redBright(level);
+            break;
+        case "warn":
+            levelStr = chalk_1.default.hex("#FF9900")(level);
+            break;
+        case "info":
+            levelStr = chalk_1.default.hex("#569cd6")(level);
+            break;
+        case "debug":
+        case "silly":
+            levelStr = chalk_1.default.dim(level);
+            break;
+    }
+    return levelStr;
+}
+exports.logger = createDefaultLogger();
+function setLogger(loggerObj) {
+    exports.logger = loggerObj;
+}
+function getLogger() {
+    return exports.logger;
+}
+function createDefaultLogger() {
+    const logger = (0, winston_1.createLogger)({
+        transports: [
+            new winston_1.transports.Console({
+                format: winston_1.format.combine(winston_1.format.splat(), caporalFormat),
+            }),
+        ],
+    });
+    // disableColors() disable on the logger level,
+    // while chalk supports the --color/--no-color flag
+    // as well as the FORCE_COLOR env var
+    logger.disableColors = () => {
+        logger.transports[0].format = caporalFormat;
+        logger.colorsEnabled = false;
+    };
+    logger.colorsEnabled = chalk_1.supportsColor !== false;
+    return logger;
+}
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/logger/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuEA,8BAEC;AAED,8BAEC;AAED,kDAiBC;AAhGD;;;GAGG;AACH,qCAAiF;AACjF,+BAA8B;AAC9B,+CAAuD;AAEvD,6DAAoC;AACpC,2BAAwB;AAExB,MAAM,aAAa,GAAG,gBAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;IAC3C,MAAM,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,GAAG,IAAI,CAAA;IAC/B,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;IACtB,IAAI,MAAM,GAAG,EAAE,CAAA;IAEf,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,CAAA;IACtC,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,CAAC,CAAA;IAEhC,IAAI,OAAO,KAAK,EAAE,EAAE,CAAC;QACnB,OAAO,IAAI,GAAG,QAAG,GAAG,QAAQ,KAAK,OAAO,EAAE,CAAA;IAC5C,CAAC;IAED,IAAI,KAAK,KAAK,OAAO,EAAE,CAAC;QACtB,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAA;QACxD,MAAM,GAAG,QAAG,CAAA;QACZ,OAAO,GAAG,GAAG,IAAA,iBAAO,EAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,IAAI,MAAM,CAAC,QAAG,EAAE,GAAG,CAAC,EAAE,QAAG,GAAG,MAAM,CAAC,GAAG,QAAG,EAAE,CAAA;IACtF,CAAC;IAED,OAAO,GAAG,MAAM,GAAG,QAAQ,KAAK,OAAO,EAAE,CAAA;AAC3C,CAAC,CAAC,CAAA;AAEF,SAAS,UAAU,CAAC,IAA6B;IAC/C,OAAO,IAAI,CAAC,OAAO,CAAA;IACnB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAsB,CAAC,CAAA;IACrD,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAsB,CAAC,CAAA;IACvD,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAsB,CAAC,CAAA;IACrD,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;QAC7B,OAAO,IAAA,cAAO,EAAC,IAAI,EAAE;YACnB,UAAU,EAAE,KAAK;YACjB,MAAM,EAAE,cAAM,CAAC,aAAa;SAC7B,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,EAAE,CAAA;AACX,CAAC;AAED,SAAS,cAAc,CAAC,KAAa;IACnC,IAAI,CAAC,cAAM,CAAC,aAAa,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAA;IACd,CAAC;IACD,IAAI,QAAQ,GAAG,KAAK,CAAA;IACpB,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,OAAO;YACV,QAAQ,GAAG,eAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAA;YACtC,MAAK;QACP,KAAK,MAAM;YACT,QAAQ,GAAG,eAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAA;YACtC,MAAK;QACP,KAAK,MAAM;YACT,QAAQ,GAAG,eAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAA;YACtC,MAAK;QACP,KAAK,OAAO,CAAC;QACb,KAAK,OAAO;YACV,QAAQ,GAAG,eAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;YAC3B,MAAK;IACT,CAAC;IACD,OAAO,QAAQ,CAAA;AACjB,CAAC;AAEU,QAAA,MAAM,GAAW,mBAAmB,EAAE,CAAA;AAEjD,SAAgB,SAAS,CAAC,SAAiB;IACzC,cAAM,GAAG,SAAS,CAAA;AACpB,CAAC;AAED,SAAgB,SAAS;IACvB,OAAO,cAAM,CAAA;AACf,CAAC;AAED,SAAgB,mBAAmB;IACjC,MAAM,MAAM,GAAG,IAAA,sBAAmB,EAAC;QACjC,UAAU,EAAE;YACV,IAAI,oBAAU,CAAC,OAAO,CAAC;gBACrB,MAAM,EAAE,gBAAM,CAAC,OAAO,CAAC,gBAAM,CAAC,KAAK,EAAE,EAAE,aAAa,CAAC;aACtD,CAAC;SACH;KACF,CAAW,CAAA;IACZ,+CAA+C;IAC/C,mDAAmD;IACnD,qCAAqC;IACrC,MAAM,CAAC,aAAa,GAAG,GAAG,EAAE;QAC1B,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,aAAa,CAAA;QAC3C,MAAM,CAAC,aAAa,GAAG,KAAK,CAAA;IAC9B,CAAC,CAAA;IACD,MAAM,CAAC,aAAa,GAAG,qBAAa,KAAK,KAAK,CAAA;IAC9C,OAAO,MAAM,CAAA;AACf,CAAC"}

package/dist/src/option/__tests__/global.spec.d.ts

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

package/dist/src/option/__tests__/global.spec.d.ts.map

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