@bemoje/cli 0.2.1 → 0.3.0

package/cjs/cmd/CommandBuilder.js

@@ -1,1277 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CLI = exports.CommandBuilder = void 0;
-const tslib_1 = require("tslib");
-/* eslint-disable @typescript-eslint/ban-types */
-const ansi_colors_1 = tslib_1.__importDefault(require("ansi-colors"));
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-const is_async_function_1 = tslib_1.__importDefault(require("is-async-function"));
-const os_1 = tslib_1.__importDefault(require("os"));
-const path_1 = tslib_1.__importDefault(require("path"));
-const extra_typings_1 = require("@commander-js/extra-typings");
-const ArgumentBuilder_1 = require("../arg/ArgumentBuilder");
-const object_1 = require("@bemoje/object");
-const array_1 = require("@bemoje/array");
-const array_2 = require("@bemoje/array");
-const array_3 = require("@bemoje/array");
-const CommandBuilderMetaData_1 = require("./CommandBuilderMetaData");
-const commanderBackRefs_1 = require("./commanderBackRefs");
-const CommandFeatureSelector_1 = require("./CommandFeatureSelector");
-const DefaultHelpConfig_1 = require("./DefaultHelpConfig");
-const is_1 = require("@bemoje/is");
-const node_1 = require("@bemoje/node");
-const extra_typings_2 = require("@commander-js/extra-typings");
-const is_2 = require("@bemoje/is");
-const is_3 = require("@bemoje/is");
-const is_4 = require("@bemoje/is");
-const is_5 = require("@bemoje/is");
-const is_6 = require("@bemoje/is");
-const JsonFile_1 = require("../db/JsonFile");
-const object_2 = require("@bemoje/object");
-const OptionBuilder_1 = require("../opt/OptionBuilder");
-const OptionHelpers_1 = require("../opt/OptionHelpers");
-const OutputManager_1 = require("../core/OutputManager");
-const object_3 = require("@bemoje/object");
-const fs_1 = require("@bemoje/fs");
-const object_4 = require("@bemoje/object");
-const string_1 = require("@bemoje/string");
-/**
- * Wrapper around the @see Command class, for more intuitive construction.
- */
-class CommandBuilder {
-    static dataDirectory = path_1.default.join(os_1.default.homedir(), 'config', 'cli');
-    features = new CommandFeatureSelector_1.CommandFeatureSelector(this);
-    parent = null;
-    $;
-    meta = new CommandBuilderMetaData_1.CommandBuilderMetaData();
-    get db() {
-        return (0, object_3.realizeLazyProperty)(this, 'db', new JsonFile_1.JsonFile(this));
-    }
-    constructor(name, callback, parent, isNative = false, isDefault = false) {
-        this.meta.isNative = isNative;
-        this.$ = new extra_typings_1.Command(name);
-        commanderBackRefs_1.commanderBackRefs.set(this.$, this);
-        if (parent) {
-            this.parent = parent;
-            this.parent.meta.subcommands.push(this);
-            this.parent.$.addCommand(this.$, { isDefault });
-        }
-        this.initializeHelp();
-        if (callback)
-            callback.call(this, this);
-        if (this.parent) {
-            this.$.copyInheritedSettings(this.parent.$);
-            this.features.inheritFrom(this.parent.features);
-            this.inheritParentHiddenGlobals();
-        }
-        if (!this.meta.isNative) {
-            this.assertCommandNameNotReserved(this.name);
-            this.addUtilCommands();
-        }
-        if (this.isRoot) {
-            for (const child of this.getChildrenIterator({ inclusive: true })) {
-                if (child.features.isAutoAssignAliasEnabled) {
-                    child.assignAlias();
-                    if (!child.meta.isNative) {
-                        child.assertNoDuplicateCommandNames();
-                    }
-                }
-                if (child.features.isAutoAssignOptionFlagsEnabled) {
-                    child.assignOptionFlags();
-                    if (!child.meta.isNative) {
-                        child.assertNoDuplicateOptionNames();
-                    }
-                }
-            }
-            if (this.features.isConfigEnabled) {
-                this.db.config;
-            }
-        }
-    }
-    setRecommended() {
-        this.enableBuiltinOptions({ debug: true, noStderr: true, noStdout: true });
-        this.autoAssignOptionFlags();
-        this.autoAssignAlias();
-        this.presetsEnabled();
-    }
-    setName(name) {
-        this.$.name(name);
-        return this;
-    }
-    deleteDataFile() {
-        const filepath = this.jsonFilepath;
-        if (fs_extra_1.default.existsSync(filepath))
-            (0, fs_1.removeFile)(filepath);
-    }
-    /**
-     * Set the program version to `str`.
-     *
-     * This method auto-registers the "-V, --version" flag
-     * which will print the version number when passed.
-     *
-     * You can optionally supply the  flags and description to override the defaults.
-     */
-    version(string) {
-        this.$.version(string);
-        return this;
-    }
-    /**
-     * Set the description. If more than one sentence or string is given,
-     * then the first will be used as summary and the whole text as description.
-     * @param lines - description lines
-     */
-    description(...lines) {
-        const description = lines.join('\n');
-        const summary = description.split(/(\.(\s|\r|\n|$)+)/)[0];
-        this.$.summary(summary + '.');
-        this.$.description(description);
-        return this;
-    }
-    /**
-     * Set an alias for the command.
-     * You may call more than once to add multiple aliases.
-     * Only the first alias is shown in the auto-generated help.
-     */
-    alias(alias) {
-        this.assertCommandNameNotReserved(alias);
-        this.$.alias(alias);
-        return this;
-    }
-    /**
-     * Set aliases for the command. This overwrites all previously set aliases.
-     * Only the first alias is shown in the auto-generated help.
-     */
-    aliases(...aliases) {
-        aliases.forEach((alias) => this.assertCommandNameNotReserved(alias));
-        this.$.aliases(aliases);
-        return this;
-    }
-    /**
-     * Set the command usage.
-     */
-    usage(str) {
-        this.$.usage(str);
-        return this;
-    }
-    enableBuiltinOptions(options) {
-        if (!options || options.debug)
-            this.globalOption('-D, --debug', 'Output debugging information.');
-        if (!options || options.noColor)
-            this.globalOption('-C, --noColor', 'Disable color in terminal output.');
-        if (!options || options.noStderr)
-            this.globalOption('-E, --noStderr', 'Mute all output to stderr.');
-        if (!options || options.noStdout)
-            this.globalOption('-O, --noStdout', 'Mute all output to stdout.');
-        return this;
-    }
-    argument(name, ...args) {
-        let description = '';
-        let callback;
-        if (typeof args[0] === 'string') {
-            description = args[0];
-            callback = args[1];
-        }
-        else {
-            callback = args[0];
-        }
-        const ins = new ArgumentBuilder_1.ArgumentBuilder(this, name);
-        this.$.addArgument(ins.$);
-        if (description) {
-            ins.description(description);
-        }
-        if (typeof callback === 'function') {
-            callback(ins, this);
-        }
-        if (ins.$.variadic && !ins.hasParser && !ins.hasValidators) {
-            ins.parser.string();
-            ins.validator.isStringArray();
-        }
-        return this;
-    }
-    option(flags, ...args) {
-        let description = '';
-        let callback;
-        if (typeof args[0] === 'string') {
-            description = args[0];
-            callback = args[1];
-        }
-        else {
-            callback = args[0];
-        }
-        const ins = new OptionBuilder_1.OptionBuilder(this, flags);
-        if (this.hasIdenticalParentOption(ins.$))
-            return this;
-        this.$.addOption(ins.$);
-        if (description) {
-            ins.description(description);
-        }
-        if (typeof callback === 'function') {
-            callback(ins, this);
-        }
-        if (ins.$.variadic && !ins.hasParser && !ins.hasValidators) {
-            ins.parser.string();
-            ins.validator.isStringArray();
-        }
-        return this;
-    }
-    globalOption(flags, ...args) {
-        let description = '';
-        let callback;
-        if (typeof args[0] === 'string') {
-            description = args[0];
-            callback = args[1];
-        }
-        else {
-            callback = args[0];
-        }
-        return this.option(flags, (ins) => {
-            if (description)
-                ins.description(description);
-            this.meta.globalOptions.push(ins.$);
-            if (callback)
-                callback(ins, this);
-            if (ins.$.hidden)
-                this.meta.hiddenGlobalOptions.add(ins.$);
-        });
-    }
-    command(name, ...args) {
-        const [description, callback] = this.handleCommandArgs(args);
-        const cmd = new CommandBuilder(name, callback, this, false, false);
-        if (description)
-            cmd.description(description);
-        return this;
-    }
-    defaultCommand(name, ...args) {
-        const [description, callback] = this.handleCommandArgs(args);
-        const cmd = new CommandBuilder(name, callback, this, false, true);
-        if (description)
-            cmd.description(description);
-        return this;
-    }
-    nativeCommand(name, ...args) {
-        const [description, callback] = this.handleCommandArgs(args);
-        const cmd = new CommandBuilder(name, callback, this, true, false);
-        if (description)
-            cmd.description(description);
-        return this;
-    }
-    handleCommandArgs(args) {
-        let description = '';
-        let callback;
-        if (typeof args[0] === 'string') {
-            description = args[0];
-            callback = args[1];
-        }
-        else {
-            callback = args[0];
-        }
-        return [description, callback];
-    }
-    /**
-     * Register callback function for the command to execute when invoked.
-     */
-    action(fn) {
-        const isAsync = (0, is_async_function_1.default)(fn) || /^\(.+\) ?=> ?tslib_1\.__awaiter\(/.test(fn.toString().trim());
-        this.meta.isActionAsync = isAsync;
-        Object.defineProperty(this.meta, 'actionHandler', { value: fn, configurable: false, writable: false });
-        this.initializeActionWrapper(isAsync);
-        return this;
-    }
-    usageExamples(...examples) {
-        const table = examples.map(({ command, description }) => {
-            if (command.length + (description?.length || 0) > 100) {
-                throw new Error(`Usage example description too long: ${command}`);
-            }
-            return [command, description ?? ''];
-        });
-        this.description(this.$.description() + '\n\n' + 'Usage Examples:\n' + (0, node_1.formatTableForTerminal)(table));
-        return this;
-    }
-    errorHandler(fn) {
-        Object.defineProperty(this.meta, 'errorHandler', { value: fn, configurable: true });
-        return this;
-    }
-    appData(key, value) {
-        this.features.appData(true);
-        this.db.appData.defineProperty(key, value);
-        return this;
-    }
-    config(key, entry) {
-        this.features.config(true);
-        this.db.config.defineProperty(key, entry);
-        return this;
-    }
-    preset(name, preset) {
-        this.features.presets();
-        this.db.presets.defineProperty(name, {
-            description: preset.description,
-            presets: preset.presets ?? [],
-            args: preset.args ?? [],
-            options: preset.options ?? {},
-        });
-        return this;
-    }
-    presetsEnabled(boolean = true) {
-        this.features.presets(boolean);
-        return this;
-    }
-    autoAssignOptionFlags(boolean = true) {
-        this.features.autoAssignOptionFlags(boolean);
-        return this;
-    }
-    autoAssignAlias(boolean = true) {
-        this.features.autoAssignAlias(boolean);
-        return this;
-    }
-    /**
-     * Allow excess command-arguments on the command line. Pass false to make excess arguments an error.
-     *
-     * @returns `this` command for chaining
-     */
-    allowExcessArguments(bool = true) {
-        this.$.allowExcessArguments(bool);
-        return this;
-    }
-    /**
-     * Allow unknown options on the command line.
-     *
-     * @returns `this` command for chaining
-     */
-    allowUnknownOption(bool = true) {
-        this.$.allowUnknownOption(bool);
-        return this;
-    }
-    /**
-     * Enable positional options. Positional means global options are specified before subcommands which lets
-     * subcommands reuse the same option names, and also enables subcommands to turn on passThroughOptions.
-     *
-     * The default behaviour is non-positional and global options may appear anywhere on the command line.
-     *
-     * @returns `this` command for chaining
-     */
-    enablePositionalOptions(positional) {
-        this.$.enablePositionalOptions(positional);
-        return this;
-    }
-    /**
-     * Pass through options that come after command-arguments rather than treat them as command-options,
-     * so actual command-options come before command-arguments. Turning this on for a subcommand requires
-     * positional options to have been enabled on the program (parent commands).
-     *
-     * The default behaviour is non-positional and options may appear before or after command-arguments.
-     *
-     * @returns `this` command for chaining
-     */
-    passThroughOptions(passThrough) {
-        this.$.passThroughOptions(passThrough);
-        return this;
-    }
-    /**
-     * Register callback to use as replacement for calling process.exit.
-     */
-    exitOverride(callback) {
-        this.$.exitOverride(callback);
-        return this;
-    }
-    /**
-     * Add hook for life cycle event.
-     */
-    hook(event, listener) {
-        this.$.hook(event, listener);
-        return this;
-    }
-    /**
-     * You can customise the help by overriding Help properties using configureHelp(),
-     * or with a subclass of Help by overriding createHelp().
-     */
-    configureHelp(configuration) {
-        this.$.configureHelp(configuration);
-        return this;
-    }
-    /**
-     * Display the help or a custom message after an error occurs.
-     */
-    showHelpAfterError(displayHelp) {
-        this.$.showHelpAfterError(displayHelp);
-        return this;
-    }
-    /**
-     * Display suggestion of similar commands for unknown commands, or options for unknown options.
-     */
-    showSuggestionAfterError(displaySuggestion) {
-        this.$.showSuggestionAfterError(displaySuggestion);
-        return this;
-    }
-    /**
-     * Override default decision whether to add implicit help command.
-     * @example ```
-     * addHelpCommand() // force on
-     * addHelpCommand(false); // force off
-     * addHelpCommand('help [cmd]', 'display help for [cmd]'); // force on with custom details
-     * ```
-     * @returns `this` command for chaining
-     */
-    addHelpCommand(enableOrNameAndArgs, description) {
-        this.$.addHelpCommand(enableOrNameAndArgs, description);
-        return this;
-    }
-    /**
-     * Add additional text to be displayed with the built-in help.
-     *
-     * Position is 'before' or 'after' to affect just this command,
-     * and 'beforeAll' or 'afterAll' to affect this command and all its subcommands.
-     */
-    addHelpText(title, ...lines) {
-        title = (0, string_1.strFirstCharToUpperCase)((0, string_1.strEnsureEndsWith)(title, ':'));
-        this.description(this.$.description() + '\n\n' + title + '\n' + lines.join('\n'));
-        return this;
-    }
-    /**
-     * Set the order in which the help sections are displayed.
-     * Subcommands inherit this order.
-     * Defaults to: Usage, Version, Description, Commands, Arguments, Options, Global Options, Presets, Usage Examples
-     */
-    helpSectionOrdering(headers) {
-        this.meta.helpSectionOrder = headers.map((h) => {
-            return (0, string_1.strEnsureEndsWith)((0, string_1.strFirstCharToUpperCase)(h), ':');
-        });
-        return this;
-    }
-    throwCommanderError(message, exitCode = 1, type = 'error') {
-        throw new extra_typings_1.CommanderError(exitCode, type, message);
-    }
-    hideGlobalOptions(...names) {
-        const globals = this.getGlobalOptions();
-        names = names.length ? names : globals.map((opt) => opt.attributeName());
-        for (const name of names) {
-            if (!name)
-                continue;
-            let found = false;
-            for (const opt of globals) {
-                if (opt.attributeName() === name) {
-                    this.meta.hiddenGlobalOptions.add(opt);
-                    found = true;
-                    break;
-                }
-            }
-            if (!found)
-                throw new Error(`Unknown global option name: ${name} for command, ${this.name}`);
-        }
-        return this;
-    }
-    unhideGlobalOptions(...names) {
-        const globals = this.getGlobalOptions();
-        names = names.length ? names : globals.map((opt) => opt.attributeName());
-        for (const name of names) {
-            if (!name)
-                continue;
-            let found = false;
-            for (const opt of globals) {
-                if (opt.attributeName() === name) {
-                    this.meta.hiddenGlobalOptions.delete(opt);
-                    found = true;
-                    break;
-                }
-            }
-            if (!found)
-                this.throwCommanderError(`Unknown global option name: ${name} for command, ${this.name}`);
-        }
-        return this;
-    }
-    /**
-     * Set the directory for searching for executable subcommands of this command.
-     */
-    executableDir(path) {
-        this.$.executableDir(path);
-        return this;
-    }
-    /**
-     * Store option value.
-     */
-    setOptionValue(key, value) {
-        this.$.setOptionValue(key, value);
-        return this;
-    }
-    /**
-     * Store option value and where the value came from.
-     */
-    setOptionValueWithSource(key, value, source) {
-        this.$.setOptionValueWithSource(key, value, source);
-        return this;
-    }
-    setDataFilepath(filepath) {
-        Object.defineProperty(this, 'dataFilepath', { value: filepath });
-        if (Object.hasOwn(this, 'db') && Object.hasOwn(this.db, 'db')) {
-            this.db.db.setFilepath(filepath);
-        }
-    }
-    /**
-     * Display error message and exit (or call exitOverride).
-     */
-    outputError(message, options) {
-        this.$.error(message, options);
-    }
-    /**
-     * Output help information for this command.
-     */
-    outputHelp() {
-        console.log(this.getHelpInformation());
-    }
-    /**
-     * Display error message and exit (or call exitOverride).
-     */
-    outputDebugMessage(event, getProps = () => ({})) {
-        OutputManager_1.OutputManager.getInstance().outputDebug(() => ({ event, cmd: this.getPrefixString(), ...getProps() }));
-    }
-    parseArguments(args) {
-        const last = this.arguments.length - 1;
-        return args.map((arg, i) => {
-            if (!arg)
-                return arg;
-            const parse = this.meta.argParsers[i > last ? last : i];
-            return parse ? (Array.isArray(arg) ? arg.map((a) => parse(a)) : parse(arg)) : arg;
-        });
-    }
-    /**
-     * Parses (and validates) options using the parsers defined in the command builder.
-     */
-    parseOptions(opts) {
-        for (const [key, value] of Object.entries(opts)) {
-            const parse = this.meta.optParsers[key];
-            opts[key] = parse ? (Array.isArray(value) ? value.map((o) => parse(o)) : parse(value)) : value;
-        }
-        return opts;
-    }
-    /**
-     * Validate ALREADY PARSED args using the validators defined in the command builder.
-     */
-    assertValidArguments(parsedArgs) {
-        const last = this.arguments.length - 1;
-        parsedArgs.forEach((arg, i) => {
-            if (arg == null)
-                return;
-            const index = i > last ? last : i;
-            const validators = this.meta.argValidators[index];
-            if (!validators)
-                return;
-            for (const isValid of validators) {
-                (0, is_1.ensureThat)(arg, isValid, { Err: extra_typings_2.InvalidArgumentError });
-            }
-        });
-        return parsedArgs;
-    }
-    /**
-     * Validate ALREADY PARSED options using the validators defined in the command builder.
-     */
-    assertValidOptions(parsedOptions) {
-        for (const [key, value] of Object.entries(parsedOptions)) {
-            if (!this.meta.optValidators[key])
-                continue;
-            if (value == null)
-                continue;
-            for (const isValid of this.meta.optValidators[key]) {
-                (0, is_1.ensureThat)(value, isValid);
-            }
-        }
-        return parsedOptions;
-    }
-    assertValidPreset(key, preset) {
-        const { description, presets, args, options } = preset;
-        (0, is_1.ensureThat)(key, is_6.isStringWithNoSpacesOrDashes);
-        (0, is_1.ensureThat)(description, is_4.isString);
-        (0, is_1.ensureThat)(presets, is_5.isStringArray);
-        (0, is_1.ensureThat)(args, is_2.isArray);
-        this.assertPresetArgsOptional(args);
-        this.assertValidArguments(args);
-        (0, is_1.ensureThat)(options, is_3.isObject);
-        this.assertValidOptions(options);
-    }
-    throwRatherThanExitProcess() {
-        const throwError = (error) => {
-            throw error;
-        };
-        this.errorHandler(throwError);
-        this.exitOverride(throwError);
-    }
-    get name() {
-        return this.$.name();
-    }
-    /**
-     * Get the command at the root of the command tree.
-     */
-    get root() {
-        if (this.isRoot)
-            return this;
-        return this.getAncestors().pop();
-    }
-    get isRoot() {
-        return !this.parent;
-    }
-    get arguments() {
-        return this.$.registeredArguments;
-    }
-    get options() {
-        return this.$.options;
-    }
-    get commander() {
-        return this.$;
-    }
-    get hasGrandChildren() {
-        return this.meta.subcommands.some((sub) => !!sub.meta.subcommands.length);
-    }
-    /**
-     * Returns whether a command's last argument is variadic.
-     */
-    get isLastArgVariadic() {
-        if (!this.arguments.length)
-            return false;
-        return (0, array_1.arrLast)(this.arguments).variadic;
-    }
-    get jsonFilepath() {
-        return path_1.default.join(CommandBuilder.dataDirectory, this.root.name + '.json');
-    }
-    /**
-     * Get the executable search directory.
-     */
-    getExecutableDir() {
-        return this.$.executableDir();
-    }
-    /**
-     * Retrieve option value.
-     */
-    getOptionValue(key) {
-        return this.$.getOptionValue(key);
-    }
-    /**
-     * Get source of option value.
-     */
-    getOptionValueSource(key) {
-        return this.$.getOptionValueSource(key);
-    }
-    /**
-     * Get source of option value. See also .optsWithGlobals().
-     */
-    getOptionValueSourceWithGlobals(key) {
-        return this.$.getOptionValueSourceWithGlobals(key);
-    }
-    getActionHandler() {
-        return this.meta.actionHandler;
-    }
-    getDescription() {
-        return this.$.description();
-    }
-    getSummary() {
-        return this.$.summary();
-    }
-    getVersion() {
-        return this.$.version();
-    }
-    getAlias() {
-        return this.$.alias();
-    }
-    getAliases() {
-        return this.$.aliases();
-    }
-    /**
-     * Get a commands prefix array based on all its parent/ancestor commands.
-     */
-    getPrefixArray() {
-        return this.getAncestors({ inclusive: true })
-            .reverse()
-            .map((node) => node.name);
-    }
-    /**
-     * Get a commands prefix string based on all its parent/ancestor commands.
-     */
-    getPrefixString() {
-        return this.getPrefixArray().join(' ');
-    }
-    getGlobalOptions() {
-        const result = [];
-        for (const anc of this.getAncestors({ inclusive: true }).reverse()) {
-            for (const gopt of anc.meta.globalOptions) {
-                if (!this.meta.hiddenGlobalOptions.has(gopt)) {
-                    result.push(gopt);
-                }
-            }
-        }
-        return result;
-    }
-    getOwnAndGlobalOptions() {
-        return this.options.concat(this.getGlobalOptions());
-    }
-    *getChildrenIterator(options) {
-        if (options?.inclusive)
-            yield this;
-        for (const sub of this.meta.subcommands) {
-            yield sub;
-            yield* sub.getChildrenIterator();
-        }
-    }
-    getChildren(options) {
-        return [...this.getChildrenIterator(options)];
-    }
-    *getAncestorsIterator(options) {
-        if (options?.inclusive)
-            yield this;
-        let node = this.parent;
-        while (node) {
-            yield node;
-            node = node.parent;
-        }
-    }
-    /**
-     * Get a command's ancestors, optionally starting from the command itself.
-     */
-    getAncestors(options) {
-        return [...this.getAncestorsIterator(options)];
-    }
-    *getSiblingsIterator() {
-        if (!this.parent)
-            return;
-        for (const sub of this.parent.meta.subcommands) {
-            if (sub === this)
-                continue;
-            yield sub;
-        }
-    }
-    /**
-     * Returns an array of sibling CommandBuilder objects.
-     */
-    getSiblings() {
-        return [...this.getSiblingsIterator()];
-    }
-    /**
-     * Render the help string for the command.
-     */
-    getHelpInformation() {
-        return this.$.helpInformation();
-    }
-    getOptsWithGlobals() {
-        return (0, object_2.objAssign)({}, ...this.options.map((opt) => ({ [opt.attributeName()]: opt.defaultValue })), this.parseOptions(this.$.optsWithGlobals()));
-    }
-    /**
-     * Parse `argv`, setting options and invoking commands when defined.
-     *
-     * The default expectation is that the arguments are from node and have the application as argv[0]
-     * and the script being run in argv[1], with user parameters after that.
-     *
-     * @example
-     * ```
-     * program.parse(process.argv);
-     * program.parse(); // implicitly use process.argv and auto-detect node vs electron conventions
-     * program.parse(my-args, { from: 'user' }); // just user supplied arguments, nothing special about argv[0]
-     * ```
-     *
-     * @returns `this` command for chaining
-     */
-    parse(argv, options) {
-        this.$.parse(argv, options);
-        return this;
-    }
-    /**
-     * Parse `argv`, setting options and invoking commands when defined.
-     *
-     * Use parseAsync instead of parse if any of your action handlers are async. Returns a Promise.
-     *
-     * The default expectation is that the arguments are from node and have the application as argv[0]
-     * and the script being run in argv[1], with user parameters after that.
-     *
-     * @example
-     * ```
-     * program.parseAsync(process.argv);
-     * program.parseAsync(); // implicitly use process.argv and auto-detect node vs electron conventions
-     * program.parseAsync(my-args, { from: 'user' }); // just user supplied arguments, nothing special about argv[0]
-     * ```
-     *
-     * @returns Promise
-     */
-    async parseAsync(argv, options) {
-        await this.$.parseAsync(argv, options);
-        return this;
-    }
-    execute(argv, options) {
-        return this.meta.isActionAsync ? this.parseAsync(argv, options) : this.parse(argv, options);
-    }
-    getParsedValidArgsOptsWithPresets() {
-        const [presetArgs, presetOpts, presetOrder] = this.getPresetArgsAndOpts();
-        const args = this.getParsedValidArgsWithPresets(presetArgs);
-        const opts = this.getParsedValidOptsWithPresets(presetOpts);
-        this.debugLogArgsOpts(args, opts, presetArgs, presetOpts, presetOrder);
-        return [args, opts];
-    }
-    getParsedValidArgsWithPresets(presetArgs) {
-        const result = (0, object_1.arrAssign)([], ...presetArgs, this.parseArguments(this.$.args));
-        this.combineVariadicArgs(result);
-        this.assertValidArguments(result);
-        return this.padArgsWithUndefinedUntilExpectedLength(result);
-    }
-    getParsedValidOptsWithPresets(presetOpts) {
-        const parsed = this.getOptsWithGlobals();
-        const opts = presetOpts.length ? (0, object_2.objAssign)({}, ...presetOpts, parsed) : parsed;
-        this.hideOptionsWithDefaultOrNoValue(opts, { defaults: true, undefined: true, invalid: true });
-        this.assertValidOptions(opts);
-        return opts;
-    }
-    getPresetArgsAndOpts() {
-        if (!this.features.isPresetsEnabled)
-            return [[], [], []];
-        const opts = this.$.optsWithGlobals();
-        if (!opts.presets)
-            return [[], [], []];
-        const presets = this.db.presets.getAll();
-        const presetOrder = (0, array_2.arrRemoveDuplicates)(opts.presets
-            .map((name) => {
-            if (!presets[name])
-                throw new Error(`Unknown preset name: ${name}`);
-            return presets[name].presets.concat(name);
-        })
-            .flat());
-        presetOrder.unshift('defaults');
-        const presetArgs = presetOrder.map((name) => presets[name].args);
-        const presetOpts = presetOrder.map((name) => presets[name].options);
-        return [presetArgs, presetOpts, presetOrder];
-    }
-    combineVariadicArgs(result) {
-        if (this.isLastArgVariadic) {
-            if (result.length && !Array.isArray((0, array_1.arrLast)(result))) {
-                const rest = result.splice(this.arguments.length - 1);
-                result.push(rest.filter((arg) => arg != null));
-            }
-            else {
-                result.push([]);
-            }
-        }
-        return result;
-    }
-    debugLogArgsOpts(args, opts, presetArgs, presetOpts, presetOrder) {
-        if (!opts['debug'])
-            return;
-        if (this.features.isPresetsEnabled) {
-            this.outputDebugMessage('parsePresets', () => ({ presetOrder, presetArgs, presetOpts }));
-        }
-        this.outputDebugMessage('parseArgsOpts', () => ({
-            args,
-            opts,
-            command: [this.root.name, ...this.root.meta.rawArgs].join(' '),
-        }));
-    }
-    hideOptionsWithDefaultOrNoValue(opts, options = {}) {
-        const allOpts = this.getOwnAndGlobalOptions();
-        const optMap = Object.fromEntries(allOpts.map((o) => [o.attributeName(), o]));
-        for (const [key, value] of Object.entries(opts)) {
-            if (value === false ||
-                (!options.undefined && value == null) ||
-                (!options.invalid && !optMap[key]) ||
-                (!options.defaults && optMap[key].defaultValue === value)) {
-                (0, object_4.setNonEnumerable)(opts, key);
-            }
-        }
-        return opts;
-    }
-    handleOutputOptions() {
-        const opts = this.$.optsWithGlobals();
-        const om = OutputManager_1.OutputManager.getInstance().reset();
-        if (opts['noColor'])
-            om.colors.enabled = false;
-        if (opts['noStderr'])
-            om.stderr.disable();
-        if (opts['noStdout'])
-            om.stdout.disable();
-        if (opts['debug']) {
-            om.debug.enable();
-            om.drainDebugMessageQueue();
-        }
-    }
-    padArgsWithUndefinedUntilExpectedLength(args) {
-        while (args.length < this.arguments.length)
-            args.push(undefined);
-        return args;
-    }
-    assertPresetArgsOptional(args) {
-        // args.forEach((arg, i) => {
-        //   if (arg != null && i < this.arguments.length && this.arguments[i].required) {
-        //     this.throwCommanderError(`Cannot preset required arguments.`)
-        //   }
-        // })
-    }
-    addUtilCommands() {
-        if (!this.hasGrandChildren &&
-            !this.features.isConfigEnabled &&
-            !this.features.isPresetsEnabled &&
-            !this.features.isAppDataEnabled) {
-            return;
-        }
-        this.nativeCommand('util', (u) => {
-            const cmd = u.parent;
-            u.alias('u');
-            u.description('Utility commands.');
-            if (cmd.features.isConfigEnabled) {
-                u.nativeCommand('config', createConfigCommand);
-            }
-            if (cmd.features.isPresetsEnabled && cmd.meta.hasCustomActionHandler) {
-                u.nativeCommand('presets', createPresetsCommand);
-            }
-            if (cmd.hasGrandChildren) {
-                u.nativeCommand('list', createUtilListCommand);
-            }
-            if (cmd.isRoot &&
-                (cmd.features.isConfigEnabled || cmd.features.isPresetsEnabled || cmd.features.isAppDataEnabled)) {
-                u.nativeCommand('filepath', createUtilFilepathCommand);
-            }
-            function createUtilFilepathCommand(f) {
-                f.alias('f');
-                f.description('Print filepath to JSON file containing user data, eg. config and presets.');
-                f.action(async () => {
-                    console.log(path_1.default.dirname(cmd.jsonFilepath));
-                    console.log(cmd.jsonFilepath);
-                });
-            }
-            function createUtilListCommand(l) {
-                l.alias('l');
-                l.description('List nested subcommands.');
-                l.option('--all', 'Include utility commands.');
-                l.option('--noBorders', (o) => 'Remove borders from output');
-                l.option('--plain-list', (o) => {
-                    o.description('Only a list of commands with no borders, colors, summaries or formatting.');
-                    o.implies({ noBorders: true, noColor: true });
-                });
-                l.action(async (opts) => {
-                    const filter = opts.all
-                        ? // ? (prefix: string) => {
-                            //     return !/ (config|presets)( .+)$/gi.test(prefix) && !/ util$/gi.test(prefix)
-                            //   }
-                            (prefix) => prefix
-                        : (prefix) => {
-                            return !/ (config|presets|util)( .+)?$/gi.test(prefix);
-                        };
-                    const table = [];
-                    for (const c of cmd.getChildrenIterator({ inclusive: true })) {
-                        const prefix = c.getPrefixString();
-                        if (filter && !filter(prefix))
-                            continue;
-                        table.push([prefix, c.getSummary()]);
-                    }
-                    const ansi = table.map((row) => {
-                        const arr = row[0].split(' ');
-                        const last = arr.pop();
-                        let col = ansi_colors_1.default.magenta;
-                        if (/ (util|config|presets) /.test(row[0])) {
-                            col = ansi_colors_1.default.gray;
-                        }
-                        else if (/ (util|config|presets)$/.test(row[0])) {
-                            col = ansi_colors_1.default.dim;
-                        }
-                        row[0] = arr.map(ansi_colors_1.default.dim).concat(col(last)).join(' ');
-                        return row;
-                    });
-                    let result = (0, node_1.formatTableForTerminal)(ansi, ['Command', 'Summary']);
-                    if (opts.noBorders) {
-                        result = result
-                            .replace(/[├┼┤┐┘└┌┬┴│─]/g, '')
-                            .split('\n')
-                            .map((line) => line.trim())
-                            .filter((line) => line !== '\x1B[90m\x1B[39m')
-                            .join('\n');
-                    }
-                    if (opts.plainList) {
-                        const lines = result.split('\n');
-                        const i = lines[0].indexOf('Summary');
-                        result = lines
-                            .map((line) => line.substring(0, i).trim())
-                            .slice(1)
-                            .join('\n');
-                    }
-                    console.log(result);
-                });
-            }
-            function createPresetsCommand(p) {
-                const db = cmd.db.presets;
-                p.alias('p');
-                p.description('Edit presets in your text editor.', 'A preset consists of pre-set arguments and/or options for a command.', 'Additionally, a preset can have other presets as dependencies.', 'When running the command, multiple presets can be stacked.', 'Required arguments cannot be pre-set.');
-                p.nativeCommand('edit', (e) => {
-                    e.alias('e');
-                    e.description('Edit as JSON in a text editor.');
-                    e.option('--editor [cmd]', 'The command to launch your preferred text editor.');
-                    e.action(async (opts) => {
-                        db.edit(opts.editor);
-                        console.info(db.getAll());
-                    });
-                });
-                p.nativeCommand('list', (l) => {
-                    l.alias('l');
-                    l.description('List all presets.');
-                    l.action(async () => console.dir(db.getAll(), { depth: null }));
-                });
-                // const presets = db.getAll()
-                cmd.option('-P, --presets <names...>', (o) => {
-                    o.description('Apply preset(s).');
-                });
-            }
-            function createConfigCommand(c) {
-                const db = cmd.db.config;
-                c.alias('c');
-                c.description('Manage configuration file.');
-                c.nativeCommand('edit', (e) => {
-                    e.alias('e');
-                    e.description('Edit as JSON in a text editor.');
-                    e.option('--editor [cmd]', 'The command to launch your preferred text editor.');
-                    e.action(async (opts) => {
-                        db.edit(opts.editor);
-                        console.info(db.getAll());
-                    });
-                });
-                c.nativeCommand('list', (l) => {
-                    l.alias('l');
-                    l.description('Print entire config with details.');
-                    l.action(async () => {
-                        const result = db.keys.map((key) => ({
-                            key,
-                            description: db.descriptions[key],
-                            value: db.get(key),
-                            defaultValue: db.defaultValues[key],
-                        }));
-                        console.dir(result, { depth: null });
-                    });
-                });
-                c.nativeCommand('get', (g) => {
-                    g.alias('g');
-                    g.description('Print value(s) from the config.');
-                    g.argument('[key]', 'The key to print the value of. Omit to print all values.');
-                    g.action(async (key) => console.log(key ? db.get(key) : db.getAll()));
-                });
-                c.nativeCommand('set', (s) => {
-                    s.alias('s');
-                    s.description('Set a value in the config.');
-                    s.argument('<key>', 'The key to set the value of.');
-                    s.argument('<value>', 'The new value.');
-                    s.action(async (key, val) => {
-                        const parse = db.parsers[key];
-                        const value = typeof parse === 'function' ? parse(val) : val;
-                        db.set(key, value);
-                        console.info({ [key]: value });
-                    });
-                });
-                c.nativeCommand('reset', (r) => {
-                    r.alias('r');
-                    r.description('Reset to defaults.');
-                    r.argument('[key]', 'The key for which to reset the value. Omit to reset entire config.');
-                    r.action(async (key) => {
-                        if (key)
-                            db.reset(key);
-                        else
-                            db.resetAll();
-                        console.info(db.getAll());
-                    });
-                });
-            }
-        });
-    }
-    /**
-     * Makes aliases for the command.
-     * The idea is to be able to navigate the command tree by only typing the first letter(s) of the command names.
-     *
-     * Example: A command 'cola' would get these aliases: ['c', 'co', 'col'].
-     * However, if there are namespace clashes with sibling subcommands that start with the same letter,
-     * eg. like 'cola' and 'coal' where the first two letters clash, cola's aliases are reduced to only ['col'] and similarly for 'coal'.
-     *
-     * This method creates the aliases, ensuring there are no clashes with sublings, why it is important that the
-     * entire command tree is built before invoking this method.
-     */
-    assignAlias() {
-        if (this.getAlias() || this.name.length <= 1)
-            return this;
-        const sibAliases = this.getSiblings()
-            .map((sib) => sib.getAliases())
-            .flat();
-        for (let i = 0; i < this.name.length - 1; i++) {
-            let cmdAlias = this.name.substring(0, i + 1);
-            let isClash = cmdAlias === 'u' ||
-                (0, array_3.arrSome)(sibAliases, (sibAlias) => {
-                    return cmdAlias === sibAlias;
-                });
-            if (isClash && i === 0) {
-                cmdAlias = cmdAlias.charAt(0).toUpperCase();
-                isClash = (0, array_3.arrSome)(sibAliases, (sibAlias) => {
-                    return cmdAlias === sibAlias;
-                });
-            }
-            if (isClash)
-                continue;
-            this.alias(cmdAlias);
-            return this;
-        }
-        return this;
-    }
-    /**
-     * Automatically set 'short' and 'long' names to options that don't have one assigned yet.
-     *
-     * First, it tries to assign a short name based on the first letter of the option's attribute name
-     * Both lower and upper case are tried. If these is not available, the next letter of the option name is tried.
-     *
-     * If none of the letters of the option name are available, the option is skipped until all other
-     * options have had letters from their names attempted assigned.
-     * Those that remain are assigned the first available letter of the alphabet + 0-9.
-     * If there are 64 options for the command and no more alphanumeric characters are available,
-     * the option is not assigned a short name.
-     */
-    assignOptionFlags() {
-        const taken = new Set();
-        for (const anc of this.getAncestorsIterator({ inclusive: true })) {
-            anc.options.forEach((opt) => {
-                if (!opt.short)
-                    return;
-                taken.add(opt.short.replace(/^-/g, ''));
-            });
-        }
-        const failed = new Set();
-        // assign letter from option name
-        this.options.forEach((opt) => {
-            if (opt.short)
-                return;
-            const name = opt.attributeName();
-            for (let c = 0; c < name.length; c++) {
-                let char = name.charAt(c).toLowerCase();
-                if (taken.has(char)) {
-                    char = char.toUpperCase();
-                    if (taken.has(char))
-                        continue;
-                }
-                OptionHelpers_1.OptionHelpers.setShort(opt, char);
-                taken.add(char);
-                return;
-            }
-            failed.add(opt);
-        });
-        // assign random alphanumeric character.
-        const name = 'abcdefghijklmnopqrstuvwxyz1234567890';
-        failed.forEach((opt) => {
-            for (let c = 0; c < name.length; c++) {
-                let char = name.charAt(c);
-                if (taken.has(char)) {
-                    char = char.toUpperCase();
-                    if (taken.has(char))
-                        continue;
-                }
-                OptionHelpers_1.OptionHelpers.setShort(opt, char);
-                taken.add(char);
-                return;
-            }
-        });
-    }
-    assertNoDuplicateCommandNames() {
-        const names = this.$.commands.map((sub) => sub.aliases().concat(sub.name())).flat();
-        if (names.length !== new Set(names).size) {
-            throw new Error(`Duplicate subcommand names/aliases found for command, ${this.name}: ${names.join(', ')}`);
-        }
-    }
-    hasIdenticalParentOption(option) {
-        const flags = option.flags;
-        for (const anc of this.getAncestorsIterator({ inclusive: true })) {
-            for (const opt of anc.$.options) {
-                if (flags === opt.flags) {
-                    return true;
-                }
-            }
-        }
-        return false;
-    }
-    assertNoDuplicateOptionNames() {
-        const throwErr = (cmd, opt, anc) => {
-            throw new Error(`Duplicate option names > cmd: ${cmd.name}, ${anc ? `anc: ${anc.name}, ` : ''}opt: ${opt}`);
-        };
-        const set = new Set();
-        for (const opt of this.options) {
-            if (opt.name() === 'help')
-                continue;
-            if (opt.short) {
-                if (set.has(opt.short))
-                    throwErr(this, opt.short);
-                set.add(opt.short);
-            }
-            if (opt.long) {
-                if (set.has(opt.long))
-                    throwErr(this, opt.long);
-                set.add(opt.long);
-            }
-            if (opt.attributeName()) {
-                if (set.has(opt.attributeName()))
-                    throwErr(this, opt.attributeName());
-                set.add(opt.attributeName());
-            }
-        }
-        for (const anc of this.getAncestorsIterator()) {
-            for (const opt of anc.$.options) {
-                if (opt.short && set.has(opt.short)) {
-                    if (opt.short !== 'V')
-                        continue;
-                    throwErr(this, opt.short, anc);
-                }
-                if (opt.long && set.has(opt.long)) {
-                    throwErr(this, opt.long, anc);
-                }
-                if (opt.attributeName() && set.has(opt.attributeName())) {
-                    throwErr(this, opt.attributeName(), anc);
-                }
-            }
-        }
-    }
-    initializeActionWrapper(isAsync = false) {
-        if (isAsync) {
-            this.$.action(async () => {
-                try {
-                    this.handleOutputOptions();
-                    const [args, opts] = this.getParsedValidArgsOptsWithPresets();
-                    if (opts['help'])
-                        return this.outputHelp();
-                    await this.meta.actionHandler.call(this, ...args, opts, this);
-                }
-                catch (error) {
-                    this.meta.errorHandler.call(this, error, this);
-                }
-            });
-        }
-        else {
-            this.$.action(() => {
-                try {
-                    this.handleOutputOptions();
-                    const [args, opts] = this.getParsedValidArgsOptsWithPresets();
-                    if (opts['help'])
-                        return this.outputHelp();
-                    this.meta.actionHandler.call(this, ...args, opts, this);
-                }
-                catch (error) {
-                    this.meta.errorHandler.call(this, error, this);
-                }
-            });
-        }
-    }
-    initializeHelp() {
-        if (this.isRoot)
-            this.globalOption('-h, --help', 'show help');
-        this.$.addHelpCommand('?', 'show help');
-        this.$.configureHelp(DefaultHelpConfig_1.DefaultHelpConfig);
-    }
-    inheritParentHiddenGlobals() {
-        if (!this.parent)
-            return;
-        for (const opt of this.parent.meta.hiddenGlobalOptions) {
-            this.meta.hiddenGlobalOptions.add(opt);
-        }
-    }
-    assertCommandNameNotReserved(name) {
-        if (this.isRoot)
-            return;
-        if (this.meta.isNative)
-            return;
-        if (name === 'u' || name === 'util') {
-            throw new Error(`Name '${name}' is reserved and is not available as name or alias.`);
-        }
-    }
-}
-exports.CommandBuilder = CommandBuilder;
-function CLI(name, cb) {
-    return new CommandBuilder(name, cb);
-}
-exports.CLI = CLI;
-//# sourceMappingURL=CommandBuilder.js.map