@villedemontreal/caporal 3.1.7

package/dist/src/command/index.js

@@ -0,0 +1,374 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Command = exports.HELP_CMD = exports.PROG_CMD = void 0;
+exports.createCommand = createCommand;
+/**
+ * @packageDocumentation
+ * @module caporal/command
+ */
+const validate_call_1 = require("./validate-call");
+const logger_1 = require("../logger");
+const argument_1 = require("../argument");
+const option_1 = require("../option");
+const autocomplete_1 = require("../autocomplete");
+const mapping_1 = require("../option/mapping");
+const utils_1 = require("../validator/utils");
+const error_1 = require("../error");
+const help_1 = require("../help");
+const config_1 = require("../config");
+/**
+ * @ignore
+ */
+exports.PROG_CMD = "__self_cmd";
+/**
+ * @ignore
+ */
+exports.HELP_CMD = "help";
+/**
+ * Command class
+ *
+ */
+class Command {
+    /**
+     *
+     * @param program
+     * @param name
+     * @param description
+     * @internal
+     */
+    constructor(program, name, description, config = {}) {
+        this._aliases = [];
+        /**
+         * Command options array
+         *
+         * @internal
+         */
+        this.options = [];
+        /**
+         * Command arguments array
+         *
+         * @internal
+         */
+        this.args = [];
+        this.program = program;
+        this._name = name;
+        this.description = description;
+        this._config = (0, config_1.createConfigurator)({ visible: true, ...config });
+    }
+    /**
+     * Add one or more aliases so the command can be called by different names.
+     *
+     * @param aliases Command aliases
+     */
+    alias(...aliases) {
+        this._aliases.push(...aliases);
+        return this;
+    }
+    /**
+     * Name getter. Will return an empty string in the program-command context
+     *
+     * @internal
+     */
+    get name() {
+        return this.isProgramCommand() ? "" : this._name;
+    }
+    /**
+     * 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, description, options = {}) {
+        this._lastAddedArgOrOpt = (0, argument_1.createArgument)(synopsis, description, options);
+        this.args.push(this._lastAddedArgOrOpt);
+        return this;
+    }
+    /**
+     * Set the corresponding action to execute for this command
+     *
+     * @param action Action to execute
+     */
+    action(action) {
+        this._action = action;
+        return this;
+    }
+    /**
+     * Allow chaining command() calls. See {@link Program.command}.
+     *
+     */
+    command(name, description, config = {}) {
+        return this.program.command(name, description, config);
+    }
+    /**
+     * Makes the command the default one for the program.
+     */
+    default() {
+        this.program.defaultCommand = this;
+        return this;
+    }
+    /**
+     * Checks if the command has the given alias registered.
+     *
+     * @param alias
+     * @internal
+     */
+    hasAlias(alias) {
+        return this._aliases.includes(alias);
+    }
+    /**
+     * Get command aliases.
+     * @internal
+     */
+    getAliases() {
+        return this._aliases;
+    }
+    /**
+     * @internal
+     */
+    isProgramCommand() {
+        return this._name === exports.PROG_CMD;
+    }
+    /**
+     * @internal
+     */
+    isHelpCommand() {
+        return this._name === exports.HELP_CMD;
+    }
+    /**
+     * Hide the command from help.
+     * Shortcut to calling `.configure({ visible: false })`.
+     */
+    hide() {
+        return this.configure({ visible: false });
+    }
+    /**
+     * 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, description, options = {}) {
+        const opt = (this._lastAddedArgOrOpt = (0, option_1.createOption)(synopsis, description, options));
+        this.options.push(opt);
+        return this;
+    }
+    /**
+     * @internal
+     */
+    getParserConfig() {
+        const defaults = {
+            boolean: [],
+            string: [],
+            alias: (0, mapping_1.getOptsMapping)(this),
+            autoCast: this.autoCast,
+            variadic: [],
+            ddash: false,
+        };
+        let parserOpts = this.options.reduce((parserOpts, opt) => {
+            if (opt.boolean) {
+                parserOpts.boolean.push(opt.name);
+            }
+            if ((0, utils_1.isStringValidator)(opt.validator)) {
+                parserOpts.string.push(opt.name);
+            }
+            if (opt.variadic) {
+                parserOpts.variadic.push(opt.name);
+            }
+            return parserOpts;
+        }, defaults);
+        parserOpts = this.args.reduce((parserOpts, arg, index) => {
+            if (!this.isProgramCommand()) {
+                index++;
+            }
+            if ((0, utils_1.isBoolValidator)(arg.validator)) {
+                parserOpts.boolean.push(index);
+            }
+            if ((0, utils_1.isStringValidator)(arg.validator)) {
+                parserOpts.string.push(index);
+            }
+            if (arg.variadic) {
+                parserOpts.variadic.push(index);
+            }
+            return parserOpts;
+        }, parserOpts);
+        return parserOpts;
+    }
+    /**
+     * Return a reformated synopsis string
+     * @internal
+     */
+    get synopsis() {
+        const opts = this.options.length
+            ? this.options.some((f) => f.required)
+                ? "<OPTIONS...>"
+                : "[OPTIONS...]"
+            : "";
+        const name = this._name !== exports.PROG_CMD ? " " + this._name : "";
+        return (this.program.getBin() +
+            name +
+            " " +
+            this.args.map((a) => a.synopsis).join(" ") +
+            " " +
+            opts).trim();
+    }
+    /**
+     * 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, options = {}) {
+        (0, help_1.customizeHelp)(this, text, options);
+        return this;
+    }
+    /**
+     * Configure some behavioral properties.
+     *
+     * @param props properties to set/update
+     */
+    configure(props) {
+        this._config.set(props);
+        return this;
+    }
+    /**
+     * Get a configuration property value.
+     *
+     * @internal
+     * @param key Property key to get value for. See {@link CommandConfig}.
+     */
+    getConfigProperty(key) {
+        return this._config.get(key);
+    }
+    /**
+     * Get the auto-casting flag.
+     *
+     * @internal
+     */
+    get autoCast() {
+        return (this.getConfigProperty("autoCast") ?? this.program.getConfigProperty("autoCast"));
+    }
+    /**
+     * Auto-complete
+     */
+    complete(completer) {
+        if (!this._lastAddedArgOrOpt) {
+            throw new Error("Caporal setup error: you should only call `.complete()` after .argument() or .option().");
+        }
+        (0, autocomplete_1.registerCompletion)(this._lastAddedArgOrOpt, completer);
+        return this;
+    }
+    /**
+     * 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 = true) {
+        return this.configure({
+            strictArgsCount: strict,
+            strictOptions: strict,
+        });
+    }
+    /**
+     * Computed strictOptions flag.
+     *
+     * @internal
+     */
+    get strictOptions() {
+        return (this.getConfigProperty("strictOptions") ??
+            this.program.getConfigProperty("strictOptions"));
+    }
+    /**
+     * Computed strictArgsCount flag.
+     *
+     * @internal
+     */
+    get strictArgsCount() {
+        return (this.getConfigProperty("strictArgsCount") ??
+            this.program.getConfigProperty("strictArgsCount"));
+    }
+    /**
+     * 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) {
+        return this.configure({ autoCast: enabled });
+    }
+    /**
+     * Visible flag
+     *
+     * @internal
+     */
+    get visible() {
+        return this.getConfigProperty("visible");
+    }
+    /**
+     * Run the action associated with the command
+     *
+     * @internal
+     */
+    async run(parsed) {
+        const data = {
+            args: [],
+            options: {},
+            line: "",
+            rawOptions: {},
+            rawArgv: [],
+            ddash: [],
+            ...parsed,
+        };
+        try {
+            // Validate args and options, including global options
+            const result = await (0, validate_call_1.validateCall)(this, data);
+            const { args, options, ddash, errors } = result;
+            // Process any global options
+            const shouldStop = await (0, option_1.processGlobalOptions)(result, this.program, this);
+            if (shouldStop) {
+                return -1;
+            }
+            if (errors.length) {
+                throw new error_1.ValidationSummaryError(this, errors);
+            }
+            if (!this._action) {
+                throw new error_1.NoActionError(this);
+            }
+            return await this._action({
+                args,
+                options,
+                ddash,
+                logger: logger_1.logger,
+                program: this.program,
+                command: this,
+            });
+        }
+        catch (err) {
+            const ctor = Object.getPrototypeOf(err).constructor.name;
+            throw err instanceof error_1.BaseError && ctor !== "Error"
+                ? err
+                : new error_1.ActionError(err);
+        }
+    }
+}
+exports.Command = Command;
+/**
+ * Create a new command
+ *
+ * @internal
+ */
+function createCommand(...args) {
+    return new Command(...args);
+}
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/command/index.ts"],"names":[],"mappings":";;;AAqcA,sCAIC;AAzcD;;;GAGG;AACH,mDAA8C;AAC9C,sCAAkC;AAClC,0CAA4C;AAC5C,sCAA8D;AAC9D,kDAAoD;AAEpD,+CAAkD;AAClD,8CAAuE;AAEvE,oCAAwF;AAaxF,kCAAuC;AACvC,sCAA8C;AAE9C;;GAEG;AACU,QAAA,QAAQ,GAAG,YAAY,CAAA;AAEpC;;GAEG;AACU,QAAA,QAAQ,GAAG,MAAM,CAAA;AAE9B;;;GAGG;AACH,MAAa,OAAO;IA0BlB;;;;;;OAMG;IACH,YACE,OAAgB,EAChB,IAAY,EACZ,WAAmB,EACnB,SAAiC,EAAE;QAjC7B,aAAQ,GAAa,EAAE,CAAA;QAS/B;;;;WAIG;QACM,YAAO,GAAa,EAAE,CAAA;QAC/B;;;;WAIG;QACM,SAAI,GAAe,EAAE,CAAA;QAe5B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACjB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,IAAI,CAAC,OAAO,GAAG,IAAA,2BAAkB,EAAC,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAAC,CAAA;IACjE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAG,OAAiB;QACxB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAA;QAC9B,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;OAIG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAA;IAClD,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CACN,QAAgB,EAChB,WAAmB,EACnB,UAA8B,EAAE;QAEhC,IAAI,CAAC,kBAAkB,GAAG,IAAA,yBAAc,EAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,CAAA;QACxE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAA;QACvC,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,MAAc;QACnB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAA;QACrB,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;OAGG;IACH,OAAO,CACL,IAAY,EACZ,WAAmB,EACnB,SAAiC,EAAE;QAEnC,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,CAAC,CAAA;IACxD,CAAC;IAED;;OAEG;IACH,OAAO;QACL,IAAI,CAAC,OAAO,CAAC,cAAc,GAAG,IAAI,CAAA;QAClC,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,KAAa;QACpB,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;IACtC,CAAC;IAED;;;OAGG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAED;;OAEG;IACH,gBAAgB;QACd,OAAO,IAAI,CAAC,KAAK,KAAK,gBAAQ,CAAA;IAChC,CAAC;IAED;;OAEG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,KAAK,KAAK,gBAAQ,CAAA;IAChC,CAAC;IAED;;;OAGG;IACH,IAAI;QACF,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAA;IAC3C,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CACJ,QAAgB,EAChB,WAAmB,EACnB,UAAmC,EAAE;QAErC,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,kBAAkB,GAAG,IAAA,qBAAY,EAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC,CAAA;QACpF,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QACtB,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;OAEG;IACH,eAAe;QACb,MAAM,QAAQ,GAAkB;YAC9B,OAAO,EAAE,EAAE;YACX,MAAM,EAAE,EAAE;YACV,KAAK,EAAE,IAAA,wBAAc,EAAC,IAAI,CAAC;YAC3B,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,QAAQ,EAAE,EAAE;YACZ,KAAK,EAAE,KAAK;SACb,CAAA;QACD,IAAI,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,GAAG,EAAE,EAAE;YACvD,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;gBAChB,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;YACnC,CAAC;YACD,IAAI,IAAA,yBAAiB,EAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;gBACrC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;YAClC,CAAC;YACD,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;gBACjB,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;YACpC,CAAC;YACD,OAAO,UAAU,CAAA;QACnB,CAAC,EAAE,QAAQ,CAAC,CAAA;QAEZ,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;YACvD,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,CAAC;gBAC7B,KAAK,EAAE,CAAA;YACT,CAAC;YACD,IAAI,IAAA,uBAAe,EAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;gBACnC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YAChC,CAAC;YACD,IAAI,IAAA,yBAAiB,EAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;gBACrC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YAC/B,CAAC;YACD,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;gBACjB,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YACjC,CAAC;YACD,OAAO,UAAU,CAAA;QACnB,CAAC,EAAE,UAAU,CAAC,CAAA;QAEd,OAAO,UAAU,CAAA;IACnB,CAAC;IAED;;;OAGG;IACH,IAAI,QAAQ;QACV,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM;YAC9B,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;gBACpC,CAAC,CAAC,cAAc;gBAChB,CAAC,CAAC,cAAc;YAClB,CAAC,CAAC,EAAE,CAAA;QACN,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,KAAK,gBAAQ,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAA;QAE5D,OAAO,CACL,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;YACrB,IAAI;YACJ,GAAG;YACH,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;YAC1C,GAAG;YACH,IAAI,CACL,CAAC,IAAI,EAAE,CAAA;IACV,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAC,IAAY,EAAE,UAAuC,EAAE;QAC1D,IAAA,oBAAa,EAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;QAClC,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,KAA6B;QACrC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;QACvB,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CAAgC,GAAM;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;IAC9B,CAAC;IAED;;;;OAIG;IACH,IAAI,QAAQ;QACV,OAAO,CACL,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC,CACjF,CAAA;IACH,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,SAAoB;QAC3B,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CACb,yFAAyF,CAC1F,CAAA;QACH,CAAC;QACD,IAAA,iCAAkB,EAAC,IAAI,CAAC,kBAAkB,EAAE,SAAS,CAAC,CAAA;QACtD,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;;;OAQG;IACH,MAAM,CAAC,MAAM,GAAG,IAAI;QAClB,OAAO,IAAI,CAAC,SAAS,CAAC;YACpB,eAAe,EAAE,MAAM;YACvB,aAAa,EAAE,MAAM;SACtB,CAAC,CAAA;IACJ,CAAC;IAED;;;;OAIG;IACH,IAAI,aAAa;QACf,OAAO,CACL,IAAI,CAAC,iBAAiB,CAAC,eAAe,CAAC;YACvC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAChD,CAAA;IACH,CAAC;IACD;;;;OAIG;IACH,IAAI,eAAe;QACjB,OAAO,CACL,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC;YACzC,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAClD,CAAA;IACH,CAAC;IAED;;;;;;;OAOG;IACH,IAAI,CAAC,OAAgB;QACnB,OAAO,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAA;IAC9C,CAAC;IAED;;;;OAIG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAA;IAC1C,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAG,CAAC,MAA6B;QACrC,MAAM,IAAI,GAAiB;YACzB,IAAI,EAAE,EAAE;YACR,OAAO,EAAE,EAAE;YACX,IAAI,EAAE,EAAE;YACR,UAAU,EAAE,EAAE;YACd,OAAO,EAAE,EAAE;YACX,KAAK,EAAE,EAAE;YACT,GAAG,MAAM;SACV,CAAA;QAED,IAAI,CAAC;YACH,sDAAsD;YACtD,MAAM,MAAM,GAAG,MAAM,IAAA,4BAAY,EAAC,IAAI,EAAE,IAAI,CAAC,CAAA;YAC7C,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;YAE/C,6BAA6B;YAC7B,MAAM,UAAU,GAAG,MAAM,IAAA,6BAAoB,EAAC,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAA;YACzE,IAAI,UAAU,EAAE,CAAC;gBACf,OAAO,CAAC,CAAC,CAAA;YACX,CAAC;YAED,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBAClB,MAAM,IAAI,8BAAsB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;YAChD,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;gBAClB,MAAM,IAAI,qBAAa,CAAC,IAAI,CAAC,CAAA;YAC/B,CAAC;YAED,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;gBACxB,IAAI;gBACJ,OAAO;gBACP,KAAK;gBACL,MAAM,EAAN,eAAM;gBACN,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,OAAO,EAAE,IAAI;aACd,CAAC,CAAA;QACJ,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,GAAG,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC,IAAI,CAAA;YACxD,MAAM,GAAG,YAAY,iBAAS,IAAI,IAAI,KAAK,OAAO;gBAChD,CAAC,CAAC,GAAG;gBACL,CAAC,CAAC,IAAI,mBAAW,CAAC,GAAY,CAAC,CAAA;QACnC,CAAC;IACH,CAAC;CACF;AAnZD,0BAmZC;AAED;;;;GAIG;AACH,SAAgB,aAAa,CAC3B,GAAG,IAA2C;IAE9C,OAAO,IAAI,OAAO,CAAC,GAAG,IAAI,CAAC,CAAA;AAC7B,CAAC"}

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

@@ -0,0 +1,4 @@
+import type { Command } from ".";
+import type { Program } from "../program";
+export declare function scanCommands(program: Program, dirPath: string): Promise<Command[]>;
+//# sourceMappingURL=scan.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"scan.d.ts","sourceRoot":"","sources":["../../../src/command/scan.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,GAAG,CAAA;AAChC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAEzC,wBAAsB,YAAY,CAChC,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,OAAO,EAAE,CAAC,CAapB"}

package/dist/src/command/scan.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.scanCommands = scanCommands;
+/**
+ * @packageDocumentation
+ * @internal
+ */
+const path_1 = __importDefault(require("path"));
+const zipObject_1 = __importDefault(require("lodash/zipObject"));
+const map_1 = __importDefault(require("lodash/map"));
+const fs_1 = require("../utils/fs");
+const import_1 = require("./import");
+const _1 = require(".");
+async function scanCommands(program, dirPath) {
+    const files = await (0, fs_1.readdir)(dirPath);
+    const imp = await Promise.all(files.map((f) => (0, import_1.importCommand)(path_1.default.join(dirPath, f))));
+    const data = (0, zipObject_1.default)(files, imp);
+    return (0, map_1.default)(data, (cmdBuilder, filename) => {
+        const { dir, name } = path_1.default.parse(filename);
+        const cmd = dir ? [...dir.split("/"), name].join(" ") : name;
+        const options = {
+            createCommand: _1.createCommand.bind(null, program, cmd),
+            program,
+        };
+        return cmdBuilder(options);
+    });
+}
+//# sourceMappingURL=scan.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"scan.js","sourceRoot":"","sources":["../../../src/command/scan.ts"],"names":[],"mappings":";;;;;AAaA,oCAgBC;AA7BD;;;GAGG;AACH,gDAAuB;AACvB,iEAAwC;AACxC,qDAA4B;AAC5B,oCAAqC;AACrC,qCAAwC;AACxC,wBAAiC;AAI1B,KAAK,UAAU,YAAY,CAChC,OAAgB,EAChB,OAAe;IAEf,MAAM,KAAK,GAAG,MAAM,IAAA,YAAO,EAAC,OAAO,CAAC,CAAA;IACpC,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,sBAAa,EAAC,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IACrF,MAAM,IAAI,GAAG,IAAA,mBAAS,EAAC,KAAK,EAAE,GAAG,CAAC,CAAA;IAClC,OAAO,IAAA,aAAG,EAAC,IAAI,EAAE,CAAC,UAAU,EAAE,QAAQ,EAAE,EAAE;QACxC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,cAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAA;QAC1C,MAAM,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QAC5D,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;IAC5B,CAAC,CAAC,CAAA;AACJ,CAAC"}

package/dist/src/command/validate-call.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @packageDocumentation
+ * @internal
+ */
+import { ParserResult, ParserProcessedResult } from "../types";
+import type { Command } from ".";
+export declare function validateCall(cmd: Command, result: ParserResult): Promise<ParserProcessedResult>;
+//# sourceMappingURL=validate-call.d.ts.map

package/dist/src/command/validate-call.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-call.d.ts","sourceRoot":"","sources":["../../../src/command/validate-call.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,YAAY,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAA;AAG9D,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,GAAG,CAAA;AAEhC,wBAAsB,YAAY,CAChC,GAAG,EAAE,OAAO,EACZ,MAAM,EAAE,YAAY,GACnB,OAAO,CAAC,qBAAqB,CAAC,CAMhC"}

package/dist/src/command/validate-call.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateCall = validateCall;
+const validate_1 = require("../argument/validate");
+const validate_2 = require("../option/validate");
+async function validateCall(cmd, result) {
+    const { args: parsedArgs, options: parsedFlags } = result;
+    // check if there are some global flags to handle
+    const { options: flags, errors: flagsErrors } = await (0, validate_2.validateOptions)(cmd, parsedFlags);
+    const { args, errors: argsErrors } = await (0, validate_1.validateArgs)(cmd, parsedArgs);
+    return { ...result, args, options: flags, errors: [...argsErrors, ...flagsErrors] };
+}
+//# sourceMappingURL=validate-call.js.map

package/dist/src/command/validate-call.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate-call.js","sourceRoot":"","sources":["../../../src/command/validate-call.ts"],"names":[],"mappings":";;AASA,oCASC;AAbD,mDAAmD;AACnD,iDAAoD;AAG7C,KAAK,UAAU,YAAY,CAChC,GAAY,EACZ,MAAoB;IAEpB,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,MAAM,CAAA;IACzD,iDAAiD;IACjD,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,IAAA,0BAAe,EAAC,GAAG,EAAE,WAAW,CAAC,CAAA;IACvF,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,IAAA,uBAAY,EAAC,GAAG,EAAE,UAAU,CAAC,CAAA;IACxE,OAAO,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,GAAG,UAAU,EAAE,GAAG,WAAW,CAAC,EAAE,CAAA;AACrF,CAAC"}

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

@@ -0,0 +1,7 @@
+/**
+ * @packageDocumentation
+ * @internal
+ */
+import type { BaseConfig, Configurator } from "../types";
+export declare function createConfigurator<T extends BaseConfig>(defaults: T): Configurator<T>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/config/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAExD,wBAAgB,kBAAkB,CAAC,CAAC,SAAS,UAAU,EAAE,QAAQ,EAAE,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAmBrF"}

package/dist/src/config/index.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createConfigurator = createConfigurator;
+function createConfigurator(defaults) {
+    const _defaults = defaults;
+    let config = defaults;
+    return {
+        reset() {
+            config = _defaults;
+            return config;
+        },
+        get(key) {
+            return config[key];
+        },
+        getAll() {
+            return config;
+        },
+        set(props) {
+            config = { ...config, ...props };
+            return config;
+        },
+    };
+}
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/config/index.ts"],"names":[],"mappings":";;AAMA,gDAmBC;AAnBD,SAAgB,kBAAkB,CAAuB,QAAW;IAClE,MAAM,SAAS,GAAG,QAAQ,CAAA;IAC1B,IAAI,MAAM,GAAG,QAAQ,CAAA;IACrB,OAAO;QACL,KAAK;YACH,MAAM,GAAG,SAAS,CAAA;YAClB,OAAO,MAAM,CAAA;QACf,CAAC;QACD,GAAG,CAAoB,GAAM;YAC3B,OAAO,MAAM,CAAC,GAAG,CAAC,CAAA;QACpB,CAAC;QACD,MAAM;YACJ,OAAO,MAAM,CAAA;QACf,CAAC;QACD,GAAG,CAAC,KAAiB;YACnB,MAAM,GAAG,EAAE,GAAG,MAAM,EAAE,GAAG,KAAK,EAAE,CAAA;YAChC,OAAO,MAAM,CAAA;QACf,CAAC;KACF,CAAA;AACH,CAAC"}

package/dist/src/error/__tests__/fatal.spec.d.ts

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

package/dist/src/error/__tests__/fatal.spec.d.ts.map

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

package/dist/src/error/__tests__/fatal.spec.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fatal_1 = require("../fatal");
+const base_1 = require("../base");
+const logger_1 = require("../../logger");
+const vitest_1 = require("vitest");
+(0, vitest_1.describe)("fatalError()", () => {
+    const loggerLogSpy = vitest_1.vi.spyOn(logger_1.logger, "log");
+    const loggerErrSpy = vitest_1.vi.spyOn(logger_1.logger, "error");
+    (0, vitest_1.afterEach)(() => {
+        logger_1.logger.level = "info";
+    });
+    (0, vitest_1.it)("should always call process.exit(1)", () => {
+        const err = new base_1.BaseError("my error");
+        (0, fatal_1.fatalError)(err);
+        (0, vitest_1.expect)(process.exitCode).toEqual(1);
+    });
+    (0, vitest_1.it)("should always logger.error in normal situation", () => {
+        const err = new base_1.BaseError("my error");
+        (0, fatal_1.fatalError)(err);
+        (0, vitest_1.expect)(loggerErrSpy).toHaveBeenCalledWith(err.message);
+    });
+    (0, vitest_1.it)("should always logger.log in debug mode, with more info", () => {
+        const err = new base_1.BaseError("my error");
+        logger_1.logger.level = "debug";
+        (0, fatal_1.fatalError)(err);
+        (0, vitest_1.expect)(loggerLogSpy).toHaveBeenCalledWith(vitest_1.expect.objectContaining({
+            message: vitest_1.expect.stringContaining("my error"),
+            stack: err.stack,
+            name: "BaseError",
+        }));
+    });
+});
+//# sourceMappingURL=fatal.spec.js.map

package/dist/src/error/__tests__/fatal.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fatal.spec.js","sourceRoot":"","sources":["../../../../src/error/__tests__/fatal.spec.ts"],"names":[],"mappings":";;AAAA,oCAAqC;AACrC,kCAAmC;AACnC,yCAAqC;AACrC,mCAA4D;AAE5D,IAAA,iBAAQ,EAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,MAAM,YAAY,GAAG,WAAE,CAAC,KAAK,CAAC,eAAM,EAAE,KAAK,CAAC,CAAA;IAC5C,MAAM,YAAY,GAAG,WAAE,CAAC,KAAK,CAAC,eAAM,EAAE,OAAO,CAAC,CAAA;IAE9C,IAAA,kBAAS,EAAC,GAAG,EAAE;QACb,eAAM,CAAC,KAAK,GAAG,MAAM,CAAA;IACvB,CAAC,CAAC,CAAA;IAEF,IAAA,WAAE,EAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,MAAM,GAAG,GAAG,IAAI,gBAAS,CAAC,UAAU,CAAC,CAAA;QACrC,IAAA,kBAAU,EAAC,GAAG,CAAC,CAAA;QACf,IAAA,eAAM,EAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;IACrC,CAAC,CAAC,CAAA;IAEF,IAAA,WAAE,EAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,MAAM,GAAG,GAAG,IAAI,gBAAS,CAAC,UAAU,CAAC,CAAA;QACrC,IAAA,kBAAU,EAAC,GAAG,CAAC,CAAA;QACf,IAAA,eAAM,EAAC,YAAY,CAAC,CAAC,oBAAoB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;IACxD,CAAC,CAAC,CAAA;IAEF,IAAA,WAAE,EAAC,wDAAwD,EAAE,GAAG,EAAE;QAChE,MAAM,GAAG,GAAG,IAAI,gBAAS,CAAC,UAAU,CAAC,CAAA;QACrC,eAAM,CAAC,KAAK,GAAG,OAAO,CAAA;QACtB,IAAA,kBAAU,EAAC,GAAG,CAAC,CAAA;QACf,IAAA,eAAM,EAAC,YAAY,CAAC,CAAC,oBAAoB,CACvC,eAAM,CAAC,gBAAgB,CAAC;YACtB,OAAO,EAAE,eAAM,CAAC,gBAAgB,CAAC,UAAU,CAAC;YAC5C,KAAK,EAAE,GAAG,CAAC,KAAK;YAChB,IAAI,EAAE,WAAW;SAClB,CAAC,CACH,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/src/error/action.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @packageDocumentation
+ * @internal
+ */
+import { BaseError } from "./base";
+export declare class ActionError extends BaseError {
+    constructor(error: string | Error);
+}
+//# sourceMappingURL=action.d.ts.map

package/dist/src/error/action.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../../src/error/action.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAA;AAElC,qBAAa,WAAY,SAAQ,SAAS;gBAC5B,KAAK,EAAE,MAAM,GAAG,KAAK;CAIlC"}

package/dist/src/error/action.js

@@ -0,0 +1,16 @@
+"use strict";
+/**
+ * @packageDocumentation
+ * @internal
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionError = void 0;
+const base_1 = require("./base");
+class ActionError extends base_1.BaseError {
+    constructor(error) {
+        const message = typeof error === "string" ? error : error.message;
+        super(message, { error });
+    }
+}
+exports.ActionError = ActionError;
+//# sourceMappingURL=action.js.map

package/dist/src/error/action.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"action.js","sourceRoot":"","sources":["../../../src/error/action.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,iCAAkC;AAElC,MAAa,WAAY,SAAQ,gBAAS;IACxC,YAAY,KAAqB;QAC/B,MAAM,OAAO,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAA;QACjE,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;IAC3B,CAAC;CACF;AALD,kCAKC"}

package/dist/src/error/base.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @packageDocumentation
+ * @internal
+ */
+import { ErrorMetadata } from "../types";
+export type CommonError = Error | BaseError;
+export declare class BaseError extends Error {
+    meta: ErrorMetadata;
+    constructor(message: string, meta?: ErrorMetadata);
+}
+//# sourceMappingURL=base.d.ts.map

package/dist/src/error/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../../src/error/base.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,SAAS,CAAA;AAE3C,qBAAa,SAAU,SAAQ,KAAK;IAC3B,IAAI,EAAE,aAAa,CAAA;gBAEd,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE,aAAkB;CAOtD"}

package/dist/src/error/base.js

@@ -0,0 +1,18 @@
+"use strict";
+/**
+ * @packageDocumentation
+ * @internal
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseError = void 0;
+class BaseError extends Error {
+    constructor(message, meta = {}) {
+        super(message);
+        Object.setPrototypeOf(this, new.target.prototype);
+        this.name = this.constructor.name;
+        this.meta = meta;
+        Error.captureStackTrace(this, this.constructor);
+    }
+}
+exports.BaseError = BaseError;
+//# sourceMappingURL=base.js.map

package/dist/src/error/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../src/error/base.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAMH,MAAa,SAAU,SAAQ,KAAK;IAGlC,YAAY,OAAe,EAAE,OAAsB,EAAE;QACnD,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;QACjD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;QACjC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;IACjD,CAAC;CACF;AAVD,8BAUC"}

package/dist/src/error/fatal.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @packageDocumentation
+ * @internal
+ */
+import type { BaseError } from "./base";
+/**
+ * @param err - Error object
+ */
+export declare function fatalError(error: BaseError): void;
+//# sourceMappingURL=fatal.d.ts.map

package/dist/src/error/fatal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fatal.d.ts","sourceRoot":"","sources":["../../../src/error/fatal.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAA;AAEvC;;GAEG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,SAAS,GAAG,IAAI,CAajD"}