inray 0.0.3 → 0.0.5

package/dist/cli/src/lib/command.d.ts

@@ -0,0 +1,1051 @@
+/**
+ * Original library: commander.js (v15.0.0)
+ * - Copyright (c) 2011 TJ Holowaychuk
+ * - Copyright (c) John Gee and "commander.js" authors
+ *
+ * Modified and integrated in "Inray":
+ * - Evgeniy Bushin
+ */
+/***/
+import { EventEmitter } from 'node:events';
+import { Argument, type ArgumentParseFunction } from './argument.ts';
+import { CommanderError } from './error.ts';
+import { Help } from './help.ts';
+import { Option } from './option.ts';
+export interface CommandOptions {
+    hidden?: boolean;
+    isDefault?: boolean;
+    /** @deprecated old name for hidden */
+    noHelp?: boolean;
+}
+export interface ExecutableCommandOptions extends CommandOptions {
+    executableFile?: string;
+}
+type LiteralUnion<LiteralType, BaseType extends string | number> = LiteralType | (BaseType & Record<never, never>);
+export type AddHelpTextPosition = 'beforeAll' | 'before' | 'after' | 'afterAll';
+export type HookEvent = 'preSubcommand' | 'preAction' | 'postAction';
+export type HookListener = (thisCommand: Command, actionCommand: Command) => void | Promise<void>;
+export type OptionValueSource = LiteralUnion<'default' | 'config' | 'env' | 'cli' | 'implied', string> | undefined;
+export type OptionValues = Record<string, any>;
+export type HelpConfiguration = Partial<Help>;
+export interface ParseOptions {
+    from: 'node' | 'electron' | 'user' | 'eval';
+}
+export interface HelpContext {
+    error?: boolean;
+    helpWidth?: number;
+    hasColors?: boolean;
+    write?: (str: string) => void;
+}
+export interface AddHelpTextContext {
+    error: boolean;
+    command: Command;
+}
+export interface OutputConfiguration {
+    writeOut(str: string): void;
+    writeErr(str: string): void;
+    outputError(str: string, write: (str: string) => void): void;
+    getOutHelpWidth(): number | undefined;
+    getErrHelpWidth(): number | undefined;
+    getOutHasColors(): boolean | undefined;
+    getErrHasColors(): boolean | undefined;
+    stripColor(str: string): string;
+}
+export interface ErrorOptions {
+    code?: string;
+    exitCode?: number;
+}
+export interface ParseOptionsResult {
+    operands: string[];
+    unknown: string[];
+}
+type SavedState = {
+    _name: string;
+    _optionValues: OptionValues;
+    _optionValueSources: Record<string, OptionValueSource>;
+};
+export declare class Command extends EventEmitter {
+    args: string[];
+    processedArgs: any[];
+    commands: Command[];
+    options: Option[];
+    registeredArguments: Argument[];
+    parent: Command | null;
+    _allowUnknownOption: boolean;
+    _allowExcessArguments: boolean;
+    _args: Argument[];
+    rawArgs: string[];
+    _version: string | undefined;
+    _scriptPath: string | null;
+    _name: string;
+    _optionValues: OptionValues;
+    _optionValueSources: Record<string, OptionValueSource>;
+    _storeOptionsAsProperties: boolean;
+    _actionHandler: ((args: any) => void | Promise<void>) | null;
+    _executableHandler: boolean;
+    _executableFile: string | null;
+    _executableDir: string | null;
+    _defaultCommandName: string | null;
+    _exitCallback: ((err: CommanderError) => never | void) | null;
+    _aliases: string[];
+    _combineFlagAndOptionalValue: boolean;
+    _description: string;
+    _summary: string;
+    _argsDescription?: Record<string, string>;
+    _enablePositionalOptions: boolean;
+    _passThroughOptions: boolean;
+    _lifeCycleHooks: Record<string, HookListener[]>;
+    _showHelpAfterError: boolean | string;
+    _showSuggestionAfterError: boolean;
+    _savedState: SavedState | null;
+    _outputConfiguration: OutputConfiguration;
+    _hidden: boolean;
+    _helpOption?: Option | null;
+    _addImplicitHelpCommand?: boolean;
+    _helpCommand?: Command;
+    _helpConfiguration: HelpConfiguration;
+    _helpGroupHeading?: string;
+    _defaultCommandGroup?: string;
+    _defaultOptionGroup?: string;
+    _usage?: string;
+    _versionOptionName?: string;
+    runningCommand?: any;
+    /**
+     * Initialize a new `Command`.
+     *
+     * @param {string} [name]
+     */
+    constructor(name?: string);
+    /**
+     * Copy settings that are useful to have in common across root command and subcommands.
+     *
+     * (Used internally when adding a command using `.command()` so subcommands inherit parent settings.)
+     *
+     * @param {Command} sourceCommand
+     * @return {Command} `this` command for chaining
+     */
+    copyInheritedSettings(sourceCommand: Command): this;
+    /**
+     * @returns {Command[]}
+     * @private
+     */
+    private _getCommandAndAncestors;
+    /**
+     * Define a command.
+     *
+     * There are two styles of command: pay attention to where to put the description.
+     *
+     * @example
+     * // Command implemented using action handler (description is supplied separately to `.command`)
+     * program
+     *   .command('clone <source> [destination]')
+     *   .description('clone a repository into a newly created directory')
+     *   .action((source, destination) => {
+     *     console.log('clone command called');
+     *   });
+     *
+     * // Command implemented using separate executable file (description is second parameter to `.command`)
+     * program
+     *   .command('start <service>', 'start named service')
+     *   .command('stop [service]', 'stop named service, or all if no name supplied');
+     *
+     * @param {string} nameAndArgs - command name and arguments, args are `<required>` or `[optional]` and last may also be `variadic...`
+     * @param {(object | string)} [actionOptsOrExecDesc] - configuration options (for action), or description (for executable)
+     * @param {object} [execOpts] - configuration options (for executable)
+     * @return {Command} returns new command for action handler, or `this` for executable command
+     */
+    command(nameAndArgs: string, opts?: CommandOptions): ReturnType<this['createCommand']>;
+    command(nameAndArgs: string, description: string, opts?: ExecutableCommandOptions): this;
+    /**
+     * Factory routine to create a new unattached command.
+     *
+     * See .command() for creating an attached subcommand, which uses this routine to
+     * create the command. You can override createCommand to customise subcommands.
+     *
+     * @param {string} [name]
+     * @return {Command} new command
+     */
+    createCommand(name?: string): Command;
+    /**
+     * You can customise the help with a subclass of Help by overriding createHelp,
+     * or by overriding Help properties using configureHelp().
+     *
+     * @return {Help}
+     */
+    createHelp(): Help;
+    /**
+     * You can customise the help by overriding Help properties using configureHelp(),
+     * or with a subclass of Help by overriding createHelp().
+     *
+     * @param {object} [configuration] - configuration options
+     * @return {(Command | object)} `this` command for chaining, or stored configuration
+     */
+    configureHelp(): HelpConfiguration;
+    configureHelp(configuration: HelpConfiguration): this;
+    /**
+     * The default output goes to stdout and stderr. You can customise this for special
+     * applications. You can also customise the display of errors by overriding outputError.
+     *
+     * The configuration properties are all functions:
+     *
+     *     // change how output being written, defaults to stdout and stderr
+     *     writeOut(str)
+     *     writeErr(str)
+     *     // change how output being written for errors, defaults to writeErr
+     *     outputError(str, write) // used for displaying errors and not used for displaying help
+     *     // specify width for wrapping help
+     *     getOutHelpWidth()
+     *     getErrHelpWidth()
+     *     // color support, currently only used with Help
+     *     getOutHasColors()
+     *     getErrHasColors()
+     *     stripColor() // used to remove ANSI escape codes if output does not have colors
+     *
+     * @param {object} [configuration] - configuration options
+     * @return {(Command | object)} `this` command for chaining, or stored configuration
+     */
+    configureOutput(): OutputConfiguration;
+    configureOutput(configuration: Partial<OutputConfiguration>): this;
+    /**
+     * Display the help or a custom message after an error occurs.
+     *
+     * @param {(boolean|string)} [displayHelp]
+     * @return {Command} `this` command for chaining
+     */
+    showHelpAfterError(displayHelp?: boolean | string): this;
+    /**
+     * Display suggestion of similar commands for unknown commands, or options for unknown options.
+     *
+     * @param {boolean} [displaySuggestion]
+     * @return {Command} `this` command for chaining
+     */
+    showSuggestionAfterError(displaySuggestion?: boolean): this;
+    /**
+     * Add a prepared subcommand.
+     *
+     * See .command() for creating an attached subcommand which inherits settings from its parent.
+     *
+     * @param {Command} cmd - new subcommand
+     * @param {object} [opts] - configuration options
+     * @return {Command} `this` command for chaining
+     */
+    addCommand(cmd: Command, opts?: CommandOptions): this;
+    /**
+     * Factory routine to create a new unattached argument.
+     *
+     * See .argument() for creating an attached argument, which uses this routine to
+     * create the argument. You can override createArgument to return a custom argument.
+     *
+     * @param {string} name
+     * @param {string} [description]
+     * @return {Argument} new argument
+     */
+    createArgument(name: string, description?: string): Argument;
+    /**
+     * Define argument syntax for command.
+     *
+     * The default is that the argument is required, and you can explicitly
+     * indicate this with <> around the name. Put [] around the name for an optional argument.
+     *
+     * @example
+     * program.argument('<input-file>');
+     * program.argument('[output-file]');
+     *
+     * @return {Command} `this` command for chaining
+     */
+    argument<T>(name: string, description?: string, parseArg?: ArgumentParseFunction | unknown, defaultValue?: T): this;
+    /**
+     * Define argument syntax for command, adding multiple at once (without descriptions).
+     *
+     * See also .argument().
+     *
+     * @example
+     * program.arguments('<cmd> [env]');
+     *
+     * @param {string} names
+     * @return {Command} `this` command for chaining
+     */
+    arguments(names: string): this;
+    /**
+     * Define argument syntax for command, adding a prepared argument.
+     *
+     * @param {Argument} argument
+     * @return {Command} `this` command for chaining
+     */
+    addArgument(argument: Argument): this;
+    /**
+     * Customise or override default help command. By default a help command is automatically added if your command has subcommands.
+     *
+     * @example
+     *    program.helpCommand('help [cmd]');
+     *    program.helpCommand('help [cmd]', 'show help');
+     *    program.helpCommand(false); // suppress default help command
+     *    program.helpCommand(true); // add help command even if no subcommands
+     *
+     * @param {string|boolean} enableOrNameAndArgs - enable with custom name and/or arguments, or boolean to override whether added
+     * @param {string} [description] - custom description
+     * @return {Command} `this` command for chaining
+     */
+    helpCommand(nameAndArgs: string, description?: string): this;
+    helpCommand(enable?: boolean): this;
+    /**
+     * Add prepared custom help command.
+     *
+     * @param {(Command|string|boolean)} helpCommand - custom help command, or deprecated enableOrNameAndArgs as for `.helpCommand()`
+     * @param {string} [deprecatedDescription] - deprecated custom description used with custom name only
+     * @return {Command} `this` command for chaining
+     */
+    addHelpCommand(cmd: Command): this;
+    addHelpCommand(nameAndArgs: string, description?: string): this;
+    addHelpCommand(enable?: boolean): this;
+    /**
+     * Lazy create help command.
+     *
+     * @return {(Command|null)}
+     * @package
+     */
+    _getHelpCommand(): Command | null;
+    /**
+     * Add hook for life cycle event.
+     *
+     * @param {string} event
+     * @param {Function} listener
+     * @return {Command} `this` command for chaining
+     */
+    hook(event: HookEvent, listener: (thisCommand: Command, actionCommand: Command) => any | void | Promise<void>): this;
+    /**
+     * Register callback to use as replacement for calling process.exit.
+     *
+     * @param {Function} [fn] optional callback which will be passed a CommanderError, defaults to throwing
+     * @return {Command} `this` command for chaining
+     */
+    exitOverride(fn?: (err: CommanderError) => never | void): this;
+    /**
+     * Call process.exit, and _exitCallback if defined.
+     *
+     * @param {number} exitCode exit code for using with process.exit
+     * @param {string} code an id string representing the error
+     * @param {string} message human-readable description of the error
+     * @return never
+     * @private
+     */
+    _exit(exitCode: number, code: string, message: string): never;
+    /**
+     * Register callback `fn` for the command.
+     *
+     * @example
+     * program
+     *   .command('serve')
+     *   .description('start service')
+     *   .action(function() {
+     *      // do work here
+     *   });
+     *
+     * @param {Function} fn
+     * @return {Command} `this` command for chaining
+     */
+    action(fn: (this: this, ...args: any[]) => any | void | Promise<void>): this;
+    /**
+     * Factory routine to create a new unattached option.
+     *
+     * See .option() for creating an attached option, which uses this routine to
+     * create the option. You can override createOption to return a custom option.
+     *
+     * @param {string} flags
+     * @param {string} [description]
+     * @return {Option} new option
+     */
+    createOption(flags: string, description?: string): Option;
+    /**
+     * Wrap parseArgs to catch 'commander.invalidArgument'.
+     *
+     * @param {(Option | Argument)} target
+     * @param {string} value
+     * @param {*} previous
+     * @param {string} invalidArgumentMessage
+     * @private
+     */
+    _callParseArg(target: Option | Argument, value: any, previous: any, invalidArgumentMessage: string): any;
+    /**
+     * Check for option flag conflicts.
+     * Register option if no conflicts found, or throw on conflict.
+     *
+     * @param {Option} option
+     * @private
+     */
+    _registerOption(option: Option): void;
+    /**
+     * Check for command name and alias conflicts with existing commands.
+     * Register command if no conflicts found, or throw on conflict.
+     *
+     * @param {Command} command
+     * @private
+     */
+    _registerCommand(command: Command): void;
+    /**
+     * Add an option.
+     *
+     * @param {Option} option
+     * @return {Command} `this` command for chaining
+     */
+    addOption(option: Option): this;
+    /**
+     * Internal implementation shared by .option() and .requiredOption()
+     *
+     * @return {Command} `this` command for chaining
+     * @private
+     */
+    private _optionEx;
+    /**
+     * Define option with `flags`, `description`, and optional argument parsing function or `defaultValue` or both.
+     *
+     * The `flags` string contains the short and/or long flags, separated by comma, a pipe or space. A required
+     * option-argument is indicated by `<>` and an optional option-argument by `[]`.
+     *
+     * See the README for more details, and see also addOption() and requiredOption().
+     *
+     * @example
+     * program
+     *     .option('-p, --pepper', 'add pepper')
+     *     .option('--pt, --pizza-type <TYPE>', 'type of pizza') // required option-argument
+     *     .option('-c, --cheese [CHEESE]', 'add extra cheese', 'mozzarella') // optional option-argument with default
+     *     .option('-t, --tip <VALUE>', 'add tip to purchase cost', parseFloat) // custom parse function
+     *
+     * @param {string} flags
+     * @param {string} [description]
+     * @param {(Function|*)} [parseArg] - custom option processing function or default value
+     * @param {*} [defaultValue]
+     * @return {Command} `this` command for chaining
+     */
+    option(flags: string, description?: string, defaultValue?: string | number | boolean | string[]): this;
+    option<T>(flags: string, description: string, parseArg: (value: string, previous: T) => T, defaultValue?: T): this;
+    /**
+     * Add a required option which must have a value after parsing. This usually means
+     * the option must be specified on the command line. (Otherwise the same as .option().)
+     *
+     * The `flags` string contains the short and/or long flags, separated by comma, a pipe or space.
+     *
+     * @param {string} flags
+     * @param {string} [description]
+     * @param {(Function|*)} [parseArg] - custom option processing function or default value
+     * @param {*} [defaultValue]
+     * @return {Command} `this` command for chaining
+     */
+    requiredOption(flags: string, description?: string, defaultValue?: string | boolean | string[]): this;
+    requiredOption<T>(flags: string, description: string, parseArg: ArgumentParseFunction, defaultValue?: T): this;
+    requiredOption(flags: string, description?: string, defaultValue?: string | boolean | string[]): this;
+    requiredOption<T>(flags: string, description: string, parseArg: ArgumentParseFunction, defaultValue?: T): this;
+    /**
+     * Alter parsing of short flags with optional values.
+     *
+     * @example
+     * // for `.option('-f,--flag [value]'):
+     * program.combineFlagAndOptionalValue(true);  // `-f80` is treated like `--flag=80`, this is the default behaviour
+     * program.combineFlagAndOptionalValue(false) // `-fb` is treated like `-f -b`
+     *
+     * @param {boolean} [combine] - if `true` or omitted, an optional value can be specified directly after the flag.
+     * @return {Command} `this` command for chaining
+     */
+    combineFlagAndOptionalValue(combine?: boolean): this;
+    /**
+     * Allow unknown options on the command line.
+     *
+     * @param {boolean} [allowUnknown] - if `true` or omitted, no error will be thrown for unknown options.
+     * @return {Command} `this` command for chaining
+     */
+    allowUnknownOption(allowUnknown?: boolean): this;
+    /**
+     * Allow excess command-arguments on the command line. Pass false to make excess arguments an error.
+     *
+     * @param {boolean} [allowExcess] - if `true` or omitted, no error will be thrown for excess arguments.
+     * @return {Command} `this` command for chaining
+     */
+    allowExcessArguments(allowExcess?: boolean): 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.
+     *
+     * @param {boolean} [positional]
+     * @return {Command} `this` command for chaining
+     */
+    enablePositionalOptions(positional?: boolean): 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.
+     *
+     * @param {boolean} [passThrough] for unknown options.
+     * @return {Command} `this` command for chaining
+     */
+    passThroughOptions(passThrough?: boolean): this;
+    /**
+     * @private
+     */
+    _checkForBrokenPassThrough(): void;
+    /**
+     * Whether to store option values as properties on command object,
+     * or store separately (specify false). In both cases the option values can be accessed using .opts().
+     *
+     * @param {boolean} [storeAsProperties=true]
+     * @return {Command} `this` command for chaining
+     */
+    storeOptionsAsProperties(storeAsProperties?: boolean): this;
+    /**
+     * Retrieve option value.
+     *
+     * @param {string} key
+     * @return {object} value
+     */
+    getOptionValue(key: string): any;
+    /**
+     * Store option value.
+     *
+     * @param {string} key
+     * @param {object} value
+     * @return {Command} `this` command for chaining
+     */
+    setOptionValue(key: string, value: unknown): this;
+    /**
+     * Store option value and where the value came from.
+     *
+     * @param {string} key
+     * @param {object} value
+     * @param {string} source - expected values are default/config/env/cli/implied
+     * @return {Command} `this` command for chaining
+     */
+    setOptionValueWithSource(key: string, value: unknown, source: OptionValueSource): this;
+    /**
+     * Get source of option value.
+     * Expected values are default | config | env | cli | implied
+     *
+     * @param {string} key
+     * @return {string}
+     */
+    getOptionValueSource(key: string): OptionValueSource | undefined;
+    /**
+     * Get source of option value. See also .optsWithGlobals().
+     * Expected values are default | config | env | cli | implied
+     *
+     * @param {string} key
+     * @return {string}
+     */
+    getOptionValueSourceWithGlobals(key: string): OptionValueSource | undefined;
+    /**
+     * Get user arguments from implied or explicit arguments.
+     * Side-effects: set _scriptPath if args included script. Used for default program name, and subcommand searches.
+     *
+     * @private
+     */
+    private _prepareUserArgs;
+    /**
+     * Parse `argv`, setting options and invoking commands when defined.
+     *
+     * Use parseAsync instead of parse if any of your action handlers are async.
+     *
+     * Call with no parameters to parse `process.argv`. Detects Electron and special node options like `node --eval`. Easy mode!
+     *
+     * Or call with an array of strings to parse, and optionally where the user arguments start by specifying where the arguments are `from`:
+     * - `'node'`: default, `argv[0]` is the application and `argv[1]` is the script being run, with user arguments after that
+     * - `'electron'`: `argv[0]` is the application and `argv[1]` varies depending on whether the electron application is packaged
+     * - `'user'`: just user arguments
+     *
+     * @example
+     * program.parse(); // parse process.argv and auto-detect electron and special node flags
+     * program.parse(process.argv); // assume argv[0] is app and argv[1] is script
+     * program.parse(my-args, { from: 'user' }); // just user supplied arguments, nothing special about argv[0]
+     *
+     * @param {string[]} [argv] - optional, defaults to process.argv
+     * @param {object} [parseOptions] - optionally specify style of options with from: node/user/electron
+     * @param {string} [parseOptions.from] - where the args are from: 'node', 'user', 'electron'
+     * @return {Command} `this` command for chaining
+     */
+    parse(argv?: readonly (string | number)[], parseOptions?: ParseOptions): this;
+    /**
+     * Parse `argv`, setting options and invoking commands when defined.
+     *
+     * Call with no parameters to parse `process.argv`. Detects Electron and special node options like `node --eval`. Easy mode!
+     *
+     * Or call with an array of strings to parse, and optionally where the user arguments start by specifying where the arguments are `from`:
+     * - `'node'`: default, `argv[0]` is the application and `argv[1]` is the script being run, with user arguments after that
+     * - `'electron'`: `argv[0]` is the application and `argv[1]` varies depending on whether the electron application is packaged
+     * - `'user'`: just user arguments
+     *
+     * @example
+     * await program.parseAsync(); // parse process.argv and auto-detect electron and special node flags
+     * await program.parseAsync(process.argv); // assume argv[0] is app and argv[1] is script
+     * await program.parseAsync(my-args, { from: 'user' }); // just user supplied arguments, nothing special about argv[0]
+     *
+     * @param {string[]} [argv]
+     * @param {object} [parseOptions]
+     * @param {string} parseOptions.from - where the args are from: 'node', 'user', 'electron'
+     * @return {Promise}
+     */
+    parseAsync(argv?: readonly string[], parseOptions?: ParseOptions): Promise<this>;
+    _prepareForParse(): void;
+    /**
+     * Called the first time parse is called to save state and allow a restore before subsequent calls to parse.
+     * Not usually called directly, but available for subclasses to save their custom state.
+     *
+     * This is called in a lazy way. Only commands used in parsing chain will have state saved.
+     */
+    saveStateBeforeParse(): void;
+    /**
+     * Restore state before parse for calls after the first.
+     * Not usually called directly, but available for subclasses to save their custom state.
+     *
+     * This is called in a lazy way. Only commands used in parsing chain will have state restored.
+     */
+    restoreStateBeforeParse(): void;
+    /**
+     * Throw if expected executable is missing. Add lots of help for author.
+     *
+     * @param {string} executableFile
+     * @param {string} executableDir
+     * @param {string} subcommandName
+     */
+    _checkForMissingExecutable(executableFile: string, executableDir: string, subcommandName: string): void;
+    /**
+     * Execute a sub-command executable.
+     *
+     * @private
+     */
+    _executeSubCommand(subcommand: Command, args: string[]): void;
+    /**
+     * @private
+     */
+    _dispatchSubcommand(commandName: string, operands: string[], unknown: string[]): any;
+    /**
+     * Invoke help directly if possible, or dispatch if necessary.
+     * e.g. help foo
+     *
+     * @private
+     */
+    _dispatchHelpCommand(subcommandName?: string): any;
+    /**
+     * Check this.args against expected this.registeredArguments.
+     *
+     * @private
+     */
+    _checkNumberOfArguments(): void;
+    /**
+     * Process this.args using this.registeredArguments and save as this.processedArgs!
+     *
+     * @private
+     */
+    _processArguments(): void;
+    /**
+     * Once we have a promise we chain, but call synchronously until then.
+     *
+     * @param {(Promise|undefined)} promise
+     * @param {Function} fn
+     * @return {(Promise|undefined)}
+     * @private
+     */
+    _chainOrCall(promise: any, fn: () => any): any;
+    /**
+     *
+     * @param {(Promise|undefined)} promise
+     * @param {string} event
+     * @return {(Promise|undefined)}
+     * @private
+     */
+    _chainOrCallHooks(promise: any, event: string): any;
+    /**
+     *
+     * @param {(Promise|undefined)} promise
+     * @param {Command} subCommand
+     * @param {string} event
+     * @return {(Promise|undefined)}
+     * @private
+     */
+    _chainOrCallSubCommandHook(promise: any, subCommand: Command, event: string): any;
+    /**
+     * Process arguments in context of this command.
+     * Returns action result, in case it is a promise.
+     *
+     * @private
+     */
+    _parseCommand(operands: string[], unknown: string[]): any;
+    /**
+     * Find matching command.
+     *
+     * @private
+     * @return {Command | undefined}
+     */
+    _findCommand(name?: string): Command | undefined;
+    /**
+     * Return an option matching `arg` if any.
+     *
+     * @param {string} arg
+     * @return {Option}
+     * @package
+     */
+    _findOption(arg: string): Option | undefined;
+    /**
+     * Display an error message if a mandatory option does not have a value.
+     * Called after checking for help flags in leaf subcommand.
+     *
+     * @private
+     */
+    _checkForMissingMandatoryOptions(): void;
+    /**
+     * Display an error message if conflicting options are used together in this.
+     *
+     * @private
+     */
+    _checkForConflictingLocalOptions(): void;
+    /**
+     * Display an error message if conflicting options are used together.
+     * Called after checking for help flags in leaf subcommand.
+     *
+     * @private
+     */
+    _checkForConflictingOptions(): void;
+    /**
+     * Parse options from `argv` removing known options,
+     * and return argv split into operands and unknown arguments.
+     *
+     * Side effects: modifies command by storing options. Does not reset state if called again.
+     *
+     * Examples:
+     *
+     *     argv => operands, unknown
+     *     --known kkk op => [op], []
+     *     op --known kkk => [op], []
+     *     sub --unknown uuu op => [sub], [--unknown uuu op]
+     *     sub -- --unknown uuu op => [sub --unknown uuu op], []
+     *
+     * @param {string[]} args
+     * @return {{operands: string[], unknown: string[]}}
+     */
+    parseOptions(args: string[]): ParseOptionsResult;
+    /**
+     * Return an object containing local option values as key-value pairs.
+     *
+     * @return {object}
+     */
+    opts<T extends OptionValues>(): T;
+    /**
+     * Return an object containing merged local and global option values as key-value pairs.
+     *
+     * @return {object}
+     */
+    optsWithGlobals<T extends OptionValues>(): T;
+    /**
+     * Display error message and exit (or call exitOverride).
+     *
+     * @param {string} message
+     * @param {object} [errorOptions]
+     * @param {string} [errorOptions.code] - an id string representing the error
+     * @param {number} [errorOptions.exitCode] - used with process.exit
+     */
+    error(message: string, errorOptions?: ErrorOptions): never;
+    /**
+     * Apply any option related environment variables, if option does
+     * not have a value from cli or client code.
+     *
+     * @private
+     */
+    _parseOptionsEnv(): void;
+    /**
+     * Apply any implied option values, if option is undefined or default value.
+     *
+     * @private
+     */
+    _parseOptionsImplied(): void;
+    /**
+     * Argument `name` is missing.
+     *
+     * @param {string} name
+     * @private
+     */
+    missingArgument(name: string): void;
+    /**
+     * `Option` is missing an argument.
+     *
+     * @param {Option} option
+     * @private
+     */
+    optionMissingArgument(option: Option): void;
+    /**
+     * `Option` does not have a value, and is a mandatory option.
+     *
+     * @param {Option} option
+     * @private
+     */
+    missingMandatoryOptionValue(option: Option): void;
+    /**
+     * `Option` conflicts with another option.
+     *
+     * @param {Option} option
+     * @param {Option} conflictingOption
+     * @private
+     */
+    _conflictingOption(option: Option, conflictingOption: Option): void;
+    /**
+     * Unknown option `flag`.
+     *
+     * @param {string} flag
+     * @private
+     */
+    private unknownOption;
+    /**
+     * Excess arguments, more than expected.
+     *
+     * @param {string[]} receivedArgs
+     * @private
+     */
+    private _excessArguments;
+    /**
+     * Unknown command.
+     *
+     * @private
+     */
+    private unknownCommand;
+    /**
+     * Get or set the program version.
+     *
+     * This method auto-registers the "-V, --version" option which will print the version number.
+     *
+     * You can optionally supply the flags and description to override the defaults.
+     *
+     * @param {string} [str]
+     * @param {string} [flags]
+     * @param {string} [description]
+     * @return {(this | string | undefined)} `this` command for chaining, or version string if no arguments
+     */
+    version(): string | undefined;
+    version(str: string, flags?: string, description?: string): this;
+    /**
+     * Set the description.
+     *
+     * @param {string} [str]
+     * @param {object} [argsDescription]
+     * @return {(string|Command)}
+     */
+    description(): string;
+    description(str: string): this;
+    description(str: string, argsDescription: Record<string, string>): this;
+    /**
+     * Set the summary. Used when listed as subcommand of parent.
+     *
+     * @param {string} [str]
+     * @return {(string|Command)}
+     */
+    summary(): string;
+    summary(str: string): 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.
+     *
+     * @param {string} [alias]
+     * @return {(string|Command)}
+     */
+    alias(): string;
+    alias(alias: string): this;
+    /**
+     * Set aliases for the command.
+     *
+     * Only the first alias is shown in the auto-generated help.
+     *
+     * @param {string[]} [aliases]
+     * @return {(string[]|Command)}
+     */
+    aliases(): string[];
+    aliases(aliases: readonly string[]): this;
+    /**
+     * Set / get the command usage `str`.
+     *
+     * @param {string} [str]
+     * @return {(string|Command)}
+     */
+    usage(): string;
+    usage(str: string): this;
+    /**
+     * Get or set the name of the command.
+     *
+     * @param {string} [str]
+     * @return {(string|Command)}
+     */
+    name(): string;
+    name(str: string): this;
+    /**
+     * Set/get the help group heading for this subcommand in parent command's help.
+     *
+     * @param {string} [heading]
+     * @return {Command | string}
+     */
+    helpGroup(): string;
+    helpGroup(heading: string): this;
+    /**
+     * Set/get the default help group heading for subcommands added to this command.
+     * (This does not override a group set directly on the subcommand using .helpGroup().)
+     *
+     * @example
+     * program.commandsGroup('Development Commands:);
+     * program.command('watch')...
+     * program.command('lint')...
+     * ...
+     *
+     * @param {string} [heading]
+     * @returns {Command | string}
+     */
+    commandsGroup(): string;
+    commandsGroup(heading: string): this;
+    /**
+     * Set/get the default help group heading for options added to this command.
+     * (This does not override a group set directly on the option using .helpGroup().)
+     *
+     * @example
+     * program
+     *   .optionsGroup('Development Options:')
+     *   .option('-d, --debug', 'output extra debugging')
+     *   .option('-p, --profile', 'output profiling information')
+     *
+     * @param {string} [heading]
+     * @returns {Command | string}
+     */
+    optionsGroup(): string;
+    optionsGroup(heading: string): this;
+    /**
+     * @param {Option} option
+     * @private
+     */
+    private _initOptionGroup;
+    /**
+     * @param {Command} cmd
+     * @private
+     */
+    private _initCommandGroup;
+    /**
+     * Set the name of the command from script filename, such as process.argv[1],
+     * or import.meta.filename.
+     *
+     * (Used internally and public although not documented in README.)
+     *
+     * @example
+     * program.nameFromFilename(import.meta.filename);
+     *
+     * @param {string} filename
+     * @return {Command}
+     */
+    nameFromFilename(filename: string): this;
+    /**
+     * Get or set the directory for searching for executable subcommands of this command.
+     *
+     * @example
+     * program.executableDir(import.meta.dirname);
+     * // or
+     * program.executableDir('subcommands');
+     *
+     * @param {string} [path]
+     * @return {(string|null|Command)}
+     */
+    executableDir(): string | null;
+    executableDir(path: string): this;
+    /**
+     * Return program help documentation.
+     *
+     * @param {{ error: boolean }} [contextOptions] - pass {error:true} to wrap for stderr instead of stdout
+     * @return {string}
+     */
+    helpInformation(contextOptions?: HelpContext): string;
+    /**
+     * @typedef HelpContext
+     * @type {object}
+     * @property {boolean} error
+     * @property {number} helpWidth
+     * @property {boolean} hasColors
+     * @property {function} write - includes stripColor if needed
+     *
+     * @returns {HelpContext}
+     * @private
+     */
+    private _getOutputContext;
+    /**
+     * Output help information for this command.
+     *
+     * Outputs built-in help, and custom text added using `.addHelpText()`.
+     *
+     * @param {{ error: boolean } | Function} [contextOptions] - pass {error:true} to write to stderr instead of stdout
+     */
+    outputHelp(cb: (str: string) => string): void;
+    outputHelp(context?: HelpContext): void;
+    /**
+     * You can pass in flags and a description to customise the built-in help option.
+     * Pass in false to disable the built-in help option.
+     *
+     * @example
+     * program.helpOption('-?, --help' 'show help'); // customise
+     * program.helpOption(false); // disable
+     *
+     * @param {(string | boolean)} flags
+     * @param {string} [description]
+     * @return {Command} `this` command for chaining
+     */
+    helpOption(flags?: string | boolean, description?: string): this;
+    /**
+     * Lazy create help option.
+     * Returns null if has been disabled with .helpOption(false).
+     *
+     * @returns {(Option | null)} the help option
+     * @package
+     */
+    _getHelpOption(): Option | null;
+    /**
+     * Supply your own option to use for the built-in help option.
+     * This is an alternative to using helpOption() to customise the flags and description etc.
+     *
+     * @param {Option} option
+     * @return {Command} `this` command for chaining
+     */
+    addHelpOption(option: Option): this;
+    /**
+     * Output help information and exit.
+     *
+     * Outputs built-in help, and custom text added using `.addHelpText()`.
+     *
+     * @param {{ error: boolean }} [contextOptions] - pass {error:true} to write to stderr instead of stdout
+     */
+    help(cb: (str: string) => string): never;
+    help(context?: HelpContext): never;
+    /**
+     * // Do a little typing to coordinate emit and listener for the help text events.
+     * @typedef HelpTextEventContext
+     * @type {object}
+     * @property {boolean} error
+     * @property {Command} command
+     * @property {function} write
+     */
+    /**
+     * 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.
+     *
+     * @param {string} position - before or after built-in help
+     * @param {(string | Function)} text - string to add, or a function returning a string
+     * @return {Command} `this` command for chaining
+     */
+    addHelpText(position: AddHelpTextPosition, text: string): this;
+    addHelpText(position: AddHelpTextPosition, text: (context: AddHelpTextContext) => string): this;
+    /**
+     * Output help information if help flags specified
+     *
+     * @param {Array} args - array of options to search for help flags
+     * @private
+     */
+    _outputHelpIfRequested(args: Array<string>): void;
+}
+/**
+ * Exported for using from tests, not otherwise used outside this file.
+ *
+ * @returns {boolean | undefined}
+ * @package
+ */
+export declare function useColor(): boolean | undefined;
+export {};
+//# sourceMappingURL=command.d.ts.map