@villedemontreal/caporal 3.1.7

package/dist/src/command/__tests__/scan.spec.d.ts

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

package/dist/src/command/__tests__/scan.spec.d.ts.map

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

package/dist/src/command/__tests__/scan.spec.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const scan_1 = require("../scan");
+const program_1 = require("../../program");
+const path_1 = __importDefault(require("path"));
+const __1 = require("..");
+const vitest_1 = require("vitest");
+(0, vitest_1.describe)("scanCommands()", () => {
+    const prog = new program_1.Program();
+    (0, vitest_1.it)("should scan commands", async () => {
+        const commands = await (0, scan_1.scanCommands)(prog, path_1.default.join(__dirname, "../__fixtures__/"));
+        commands.forEach((cmd) => {
+            (0, vitest_1.expect)(cmd).toBeInstanceOf(__1.Command);
+        });
+    });
+});
+//# sourceMappingURL=scan.spec.js.map

package/dist/src/command/__tests__/scan.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scan.spec.js","sourceRoot":"","sources":["../../../../src/command/__tests__/scan.spec.ts"],"names":[],"mappings":";;;;;AAAA,kCAAsC;AACtC,2CAAuC;AACvC,gDAAuB;AACvB,0BAA4B;AAC5B,mCAA6C;AAE7C,IAAA,iBAAQ,EAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,MAAM,IAAI,GAAG,IAAI,iBAAO,EAAE,CAAA;IAE1B,IAAA,WAAE,EAAC,sBAAsB,EAAE,KAAK,IAAI,EAAE;QACpC,MAAM,QAAQ,GAAG,MAAM,IAAA,mBAAY,EAAC,IAAI,EAAE,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC,CAAA;QACnF,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACvB,IAAA,eAAM,EAAC,GAAG,CAAC,CAAC,cAAc,CAAC,WAAO,CAAC,CAAA;QACrC,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/src/command/find.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @packageDocumentation
+ * @internal
+ */
+import type { Program } from "../program";
+import type { Command } from ".";
+export declare function findCommand(program: Program, argv: string[]): Promise<Command | undefined>;
+//# sourceMappingURL=find.d.ts.map

package/dist/src/command/find.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"find.d.ts","sourceRoot":"","sources":["../../../src/command/find.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AACzC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,GAAG,CAAA;AAKhC,wBAAsB,WAAW,CAC/B,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,MAAM,EAAE,GACb,OAAO,CAAC,OAAO,GAAG,SAAS,CAAC,CAmB9B"}

package/dist/src/command/find.js

@@ -0,0 +1,47 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findCommand = findCommand;
+const import_1 = require("./import");
+const _1 = require(".");
+const path_1 = __importDefault(require("path"));
+async function findCommand(program, argv) {
+    const commands = program.getCommands();
+    const findRegisteredCommand = (search) => commands.find((c) => c.name === search || c.hasAlias(search));
+    let foundCommand;
+    let i;
+    for (i = 0; i < argv.length; i++) {
+        const cmd = argv.slice(0, i + 1).join(" ");
+        // break as soon as possible
+        if (argv[i].startsWith("-")) {
+            break;
+        }
+        const potentialCmd = findRegisteredCommand(cmd) || (await discoverCommand(program, cmd));
+        foundCommand = potentialCmd || foundCommand;
+    }
+    return foundCommand;
+}
+/**
+ * Search for a command in discovery path
+ */
+async function discoverCommand(program, cmd) {
+    if (program.discoveryPath === undefined) {
+        return undefined;
+    }
+    const filename = cmd.split(" ").join("/");
+    try {
+        const fullPath = path_1.default.join(program.discoveryPath, filename);
+        const cmdBuilder = await (0, import_1.importCommand)(fullPath);
+        const options = {
+            createCommand: _1.createCommand.bind(null, program, cmd),
+            program,
+        };
+        return cmdBuilder(options);
+        // eslint-disable-next-line no-empty
+    }
+    catch (e) { }
+    return undefined;
+}
+//# sourceMappingURL=find.js.map

package/dist/src/command/find.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"find.js","sourceRoot":"","sources":["../../../src/command/find.ts"],"names":[],"mappings":";;;;;AAUA,kCAsBC;AA1BD,qCAAwC;AACxC,wBAAiC;AACjC,gDAAuB;AAEhB,KAAK,UAAU,WAAW,CAC/B,OAAgB,EAChB,IAAc;IAEd,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAA;IACtC,MAAM,qBAAqB,GAAG,CAAC,MAAc,EAAuB,EAAE,CACpE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAA;IAE/D,IAAI,YAAY,CAAA;IAChB,IAAI,CAAC,CAAA;IACL,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACjC,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAC1C,4BAA4B;QAC5B,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAC5B,MAAK;QACP,CAAC;QACD,MAAM,YAAY,GAChB,qBAAqB,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,eAAe,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAA;QACrE,YAAY,GAAG,YAAY,IAAI,YAAY,CAAA;IAC7C,CAAC;IAED,OAAO,YAAY,CAAA;AACrB,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,eAAe,CAC5B,OAAgB,EAChB,GAAW;IAEX,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;QACxC,OAAO,SAAS,CAAA;IAClB,CAAC;IACD,MAAM,QAAQ,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IACzC,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAA;QAC3D,MAAM,UAAU,GAAG,MAAM,IAAA,sBAAa,EAAC,QAAQ,CAAC,CAAA;QAChD,MAAM,OAAO,GAAG;YACd,aAAa,EAAE,gBAAa,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,CAAC;YACrD,OAAO;SACR,CAAA;QACD,OAAO,UAAU,CAAC,OAAO,CAAC,CAAA;QAC1B,oCAAoC;IACtC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC,CAAA,CAAC;IACd,OAAO,SAAS,CAAA;AAClB,CAAC"}

package/dist/src/command/import.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @packageDocumentation
+ * @internal
+ */
+import { CommandCreator } from "../types";
+export declare function importCommand(file: string): Promise<CommandCreator>;
+//# sourceMappingURL=import.d.ts.map

package/dist/src/command/import.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"import.d.ts","sourceRoot":"","sources":["../../../src/command/import.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAGzC,wBAAsB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAKzE"}

package/dist/src/command/import.js

@@ -0,0 +1,47 @@
+"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.importCommand = importCommand;
+const path_1 = __importDefault(require("path"));
+async function importCommand(file) {
+    const { dir, name } = path_1.default.parse(file);
+    const filename = path_1.default.join(dir, name);
+    const mod = await Promise.resolve(`${filename}`).then(s => __importStar(require(s)));
+    return mod.default ?? mod;
+}
+//# sourceMappingURL=import.js.map

package/dist/src/command/import.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"import.js","sourceRoot":"","sources":["../../../src/command/import.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAOA,sCAKC;AAPD,gDAAuB;AAEhB,KAAK,UAAU,aAAa,CAAC,IAAY;IAC9C,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,cAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IACtC,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;IACrC,MAAM,GAAG,GAAG,yBAAa,QAAQ,uCAAC,CAAA;IAClC,OAAO,GAAG,CAAC,OAAO,IAAI,GAAG,CAAA;AAC3B,CAAC"}

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

@@ -0,0 +1,211 @@
+import { Completer } from "../autocomplete/types";
+import type { Program } from "../program";
+import { Action, ParserOptions, ParserResult, Option, Argument, CreateArgumentOpts, CommandConfig, CreateOptionCommandOpts } from "../types";
+import { CustomizedHelpOpts } from "../help/types";
+/**
+ * @ignore
+ */
+export declare const PROG_CMD = "__self_cmd";
+/**
+ * @ignore
+ */
+export declare const HELP_CMD = "help";
+/**
+ * Command class
+ *
+ */
+export declare class Command {
+    private program;
+    private _action?;
+    private _lastAddedArgOrOpt?;
+    private _aliases;
+    private _name;
+    private _config;
+    /**
+     * Command description
+     *
+     * @internal
+     */
+    readonly description: string;
+    /**
+     * Command options array
+     *
+     * @internal
+     */
+    readonly options: Option[];
+    /**
+     * Command arguments array
+     *
+     * @internal
+     */
+    readonly args: Argument[];
+    /**
+     *
+     * @param program
+     * @param name
+     * @param description
+     * @internal
+     */
+    constructor(program: Program, name: string, description: string, config?: Partial<CommandConfig>);
+    /**
+     * Add one or more aliases so the command can be called by different names.
+     *
+     * @param aliases Command aliases
+     */
+    alias(...aliases: string[]): Command;
+    /**
+     * Name getter. Will return an empty string in the program-command context
+     *
+     * @internal
+     */
+    get name(): string;
+    /**
+     * Add an argument to the command.
+     * Synopsis is a string like `<my-argument>` or `[my-argument]`.
+     * Angled brackets (e.g. `<item>`) indicate required input. Square brackets (e.g. `[env]`) indicate optional input.
+     *
+     * Returns the {@link Command} object to facilitate chaining of methods.
+     *
+     * @param synopsis Argument synopsis.
+     * @param description - Argument description.
+     * @param [options] - Optional parameters including validator and default value.
+     */
+    argument(synopsis: string, description: string, options?: CreateArgumentOpts): Command;
+    /**
+     * Set the corresponding action to execute for this command
+     *
+     * @param action Action to execute
+     */
+    action(action: Action): Command;
+    /**
+     * Allow chaining command() calls. See {@link Program.command}.
+     *
+     */
+    command(name: string, description: string, config?: Partial<CommandConfig>): Command;
+    /**
+     * Makes the command the default one for the program.
+     */
+    default(): Command;
+    /**
+     * Checks if the command has the given alias registered.
+     *
+     * @param alias
+     * @internal
+     */
+    hasAlias(alias: string): boolean;
+    /**
+     * Get command aliases.
+     * @internal
+     */
+    getAliases(): string[];
+    /**
+     * @internal
+     */
+    isProgramCommand(): boolean;
+    /**
+     * @internal
+     */
+    isHelpCommand(): boolean;
+    /**
+     * Hide the command from help.
+     * Shortcut to calling `.configure({ visible: false })`.
+     */
+    hide(): Command;
+    /**
+     * Add an option to the current command.
+     *
+     * @param synopsis Option synopsis like '-f, --force', or '-f, --file \<file\>', or '--with-openssl [path]'
+     * @param description Option description
+     * @param options Additional parameters
+     */
+    option(synopsis: string, description: string, options?: CreateOptionCommandOpts): Command;
+    /**
+     * @internal
+     */
+    getParserConfig(): Partial<ParserOptions>;
+    /**
+     * Return a reformated synopsis string
+     * @internal
+     */
+    get synopsis(): string;
+    /**
+     * Customize command help. Can be called multiple times to add more paragraphs and/or sections.
+     *
+     * @param text Help contents
+     * @param options Display options
+     */
+    help(text: string, options?: Partial<CustomizedHelpOpts>): Command;
+    /**
+     * Configure some behavioral properties.
+     *
+     * @param props properties to set/update
+     */
+    configure(props: Partial<CommandConfig>): Command;
+    /**
+     * Get a configuration property value.
+     *
+     * @internal
+     * @param key Property key to get value for. See {@link CommandConfig}.
+     */
+    getConfigProperty<K extends keyof CommandConfig>(key: K): CommandConfig[K];
+    /**
+     * Get the auto-casting flag.
+     *
+     * @internal
+     */
+    get autoCast(): boolean;
+    /**
+     * Auto-complete
+     */
+    complete(completer: Completer): Command;
+    /**
+     * Toggle strict mode.
+     * Shortcut to calling: `.configure({ strictArgsCount: strict, strictOptions: strict }).
+     * By default, strict settings are not defined for commands, and inherit from the
+     * program settings. Calling `.strict(value)` on a command will override the program
+     * settings.
+     *
+     * @param strict boolean enabled flag
+     */
+    strict(strict?: boolean): Command;
+    /**
+     * Computed strictOptions flag.
+     *
+     * @internal
+     */
+    get strictOptions(): boolean;
+    /**
+     * Computed strictArgsCount flag.
+     *
+     * @internal
+     */
+    get strictArgsCount(): boolean;
+    /**
+     * Enable or disable auto casting of arguments & options for the command.
+     * This is basically a shortcut to calling `command.configure({ autoCast: enabled })`.
+     * By default, auto-casting is inherited from the program configuration.
+     * This method allows overriding what's been set on the program level.
+     *
+     * @param enabled
+     */
+    cast(enabled: boolean): Command;
+    /**
+     * Visible flag
+     *
+     * @internal
+     */
+    get visible(): boolean;
+    /**
+     * Run the action associated with the command
+     *
+     * @internal
+     */
+    run(parsed: Partial<ParserResult>): Promise<unknown>;
+}
+/**
+ * Create a new command
+ *
+ * @internal
+ */
+export declare function createCommand(...args: ConstructorParameters<typeof Command>): InstanceType<typeof Command>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/command/index.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AAGjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAEzC,OAAO,EACL,MAAM,EACN,aAAa,EACb,YAAY,EACZ,MAAM,EACN,QAAQ,EACR,kBAAkB,EAElB,aAAa,EACb,uBAAuB,EACxB,MAAM,UAAU,CAAA;AACjB,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAIlD;;GAEG;AACH,eAAO,MAAM,QAAQ,eAAe,CAAA;AAEpC;;GAEG;AACH,eAAO,MAAM,QAAQ,SAAS,CAAA;AAE9B;;;GAGG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAC,CAAQ;IACxB,OAAO,CAAC,kBAAkB,CAAC,CAAmB;IAC9C,OAAO,CAAC,QAAQ,CAAe;IAC/B,OAAO,CAAC,KAAK,CAAQ;IACrB,OAAO,CAAC,OAAO,CAA6B;IAC5C;;;;OAIG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,CAAK;IAC/B;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAK;IAE9B;;;;;;OAMG;gBAED,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EACnB,MAAM,GAAE,OAAO,CAAC,aAAa,CAAM;IAQrC;;;;OAIG;IACH,KAAK,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO;IAKpC;;;;OAIG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CACN,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,kBAAuB,GAC/B,OAAO;IAMV;;;;OAIG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAK/B;;;OAGG;IACH,OAAO,CACL,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EACnB,MAAM,GAAE,OAAO,CAAC,aAAa,CAAM,GAClC,OAAO;IAIV;;OAEG;IACH,OAAO,IAAI,OAAO;IAKlB;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAIhC;;;OAGG;IACH,UAAU,IAAI,MAAM,EAAE;IAItB;;OAEG;IACH,gBAAgB,IAAI,OAAO;IAI3B;;OAEG;IACH,aAAa,IAAI,OAAO;IAIxB;;;OAGG;IACH,IAAI,IAAI,OAAO;IAIf;;;;;;OAMG;IACH,MAAM,CACJ,QAAQ,EAAE,MAAM,EAChB,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,uBAA4B,GACpC,OAAO;IAMV;;OAEG;IACH,eAAe,IAAI,OAAO,CAAC,aAAa,CAAC;IAyCzC;;;OAGG;IACH,IAAI,QAAQ,IAAI,MAAM,CAgBrB;IAED;;;;;OAKG;IACH,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,GAAE,OAAO,CAAC,kBAAkB,CAAM,GAAG,OAAO;IAKtE;;;;OAIG;IACH,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,OAAO;IAKjD;;;;;OAKG;IACH,iBAAiB,CAAC,CAAC,SAAS,MAAM,aAAa,EAAE,GAAG,EAAE,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC;IAI1E;;;;OAIG;IACH,IAAI,QAAQ,IAAI,OAAO,CAItB;IAED;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO;IAUvC;;;;;;;;OAQG;IACH,MAAM,CAAC,MAAM,UAAO,GAAG,OAAO;IAO9B;;;;OAIG;IACH,IAAI,aAAa,IAAI,OAAO,CAK3B;IACD;;;;OAIG;IACH,IAAI,eAAe,IAAI,OAAO,CAK7B;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO;IAI/B;;;;OAIG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;;;OAIG;IACG,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;CA6C3D;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAC3B,GAAG,IAAI,EAAE,qBAAqB,CAAC,OAAO,OAAO,CAAC,GAC7C,YAAY,CAAC,OAAO,OAAO,CAAC,CAE9B"}