commander 5.0.0 → 6.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commander",
-  "version": "5.0.0",
+  "version": "6.1.0",
   "description": "the complete solution for node.js command-line programs",
   "keywords": [
     "commander",
@@ -31,15 +31,15 @@
   ],
   "dependencies": {},
   "devDependencies": {
-    "@types/jest": "^25.1.4",
-    "@types/node": "^12.12.26",
-    "@typescript-eslint/eslint-plugin": "^2.23.0",
+    "@types/jest": "^26.0.5",
+    "@types/node": "^14.0.23",
+    "@typescript-eslint/eslint-plugin": "^2.34.0",
     "eslint": "^6.8.0",
-    "eslint-config-standard-with-typescript": "^14.0.0",
-    "eslint-plugin-jest": "^23.8.2",
-    "jest": "^25.1.0",
-    "standard": "^14.3.1",
-    "typescript": "^3.7.5"
+    "eslint-config-standard-with-typescript": "^16.0.0",
+    "eslint-plugin-jest": "^23.18.0",
+    "jest": "^26.1.0",
+    "standard": "^14.3.4",
+    "typescript": "^3.9.7"
   },
   "typings": "typings/index.d.ts",
   "engines": {

package/typings/index.d.ts

@@ -9,7 +9,7 @@ declare namespace commander {
     message: string;
     nestedError?: string;
   }
-  type CommanderErrorConstructor = { new (exitCode: number, code: string, message: string): CommanderError };
+  type CommanderErrorConstructor = new (exitCode: number, code: string, message: string) => CommanderError;
 
   interface Option {
     flags: string;
@@ -21,7 +21,7 @@ declare namespace commander {
     long: string;
     description: string;
   }
-  type OptionConstructor = { new (flags: string, description?: string): Option };
+  type OptionConstructor = new (flags: string, description?: string) => Option;
 
   interface ParseOptions {
     from: 'node' | 'electron' | 'user';
@@ -35,21 +35,21 @@ declare namespace commander {
     commands: Command[];
 
     /**
-     * Set the program version to `str`. 
+     * 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(str: string, flags?: string, description?: string): this;
 
     /**
      * Define a command, implemented using an action handler.
-     * 
+     *
      * @remarks
      * The command description is supplied using `.description`, not as a parameter to `.command`.
-     * 
+     *
      * @example
      * ```ts
      *  program
@@ -59,7 +59,7 @@ declare namespace commander {
      *      console.log('clone command called');
      *    });
      * ```
-     * 
+     *
      * @param nameAndArgs - command name and arguments, args are  `<required>` or `[optional]` and last may also be `variadic...`
      * @param opts - configuration options
      * @returns new command
@@ -67,23 +67,23 @@ declare namespace commander {
     command(nameAndArgs: string, opts?: CommandOptions): ReturnType<this['createCommand']>;
     /**
      * Define a command, implemented in a separate executable file.
-     * 
+     *
      * @remarks
      * The command description is supplied as the second parameter to `.command`.
-     * 
+     *
      * @example
      * ```ts
      *  program
      *    .command('start <service>', 'start named service')
-     *    .command('stop [service]', 'stop named serice, or all if no name supplied');
+     *    .command('stop [service]', 'stop named service, or all if no name supplied');
      * ```
-     * 
+     *
      * @param nameAndArgs - command name and arguments, args are  `<required>` or `[optional]` and last may also be `variadic...`
      * @param description - description of executable command
      * @param opts - configuration options
-     * @returns top level command for chaining more command definitions
+     * @returns `this` command for chaining
      */
-    command(nameAndArgs: string, description: string, opts?: commander.CommandOptions): this;
+    command(nameAndArgs: string, description: string, opts?: commander.ExecutableCommandOptions): this;
 
     /**
      * Factory routine to create a new unattached command.
@@ -92,20 +92,20 @@ declare namespace commander {
      * create the command. You can override createCommand to customise subcommands.
      */
     createCommand(name?: string): Command;
-    
+
     /**
      * Add a prepared subcommand.
-     * 
+     *
      * See .command() for creating an attached subcommand which inherits settings from its parent.
-     * 
-     * @returns parent command for chaining
+     *
+     * @returns `this` command for chaining
      */
-    addCommand(cmd: Command): this;
+    addCommand(cmd: Command, opts?: CommandOptions): this;
 
     /**
-     * Define argument syntax for the top-level command.
+     * Define argument syntax for command.
      *
-     * @returns Command for chaining
+     * @returns `this` command for chaining
      */
     arguments(desc: string): this;
 
@@ -125,7 +125,7 @@ declare namespace commander {
      *           // output help here
      *        });
      *
-     * @returns Command for chaining
+     * @returns `this` command for chaining
      */
     action(fn: (...args: any[]) => void | Promise<void>): this;
 
@@ -169,7 +169,7 @@ declare namespace commander {
      *     // optional argument
      *     program.option('-c, --cheese [type]', 'add cheese [marble]');
      *
-     * @returns Command for chaining
+     * @returns `this` command for chaining
      */
     option(flags: string, description?: string, defaultValue?: string | boolean): this;
     option(flags: string, description: string, regexp: RegExp, defaultValue?: string | boolean): this;
@@ -185,34 +185,45 @@ declare namespace commander {
     requiredOption(flags: string, description: string, regexp: RegExp, defaultValue?: string | boolean): this;
     requiredOption<T>(flags: string, description: string, fn: (value: string, previous: T) => T, defaultValue?: T): this;
 
-
     /**
      * 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().
      *
-     * @return Command for chaining
+     * @returns `this` command for chaining
      */
     storeOptionsAsProperties(value?: boolean): this;
 
     /**
      * Whether to pass command to action handler,
      * or just the options (specify false).
-     * 
-     * @return Command for chaining
+     *
+     * @returns `this` command for chaining
      */
     passCommandToAction(value?: boolean): this;
 
+    /**
+     * Alter parsing of short flags with optional values.
+     *
+     * @example
+     *    // for `.option('-f,--flag [value]'):
+     *   .combineFlagAndOptionalValue(true)  // `-f80` is treated like `--flag=80`, this is the default behaviour
+     *   .combineFlagAndOptionalValue(false) // `-fb` is treated like `-f -b`
+     *
+     * @returns `this` command for chaining
+     */
+    combineFlagAndOptionalValue(arg?: boolean): this;
+
     /**
      * Allow unknown options on the command line.
      *
      * @param [arg] if `true` or omitted, no error will be thrown for unknown options.
-     * @returns Command for chaining
+     * @returns `this` command for chaining
      */
     allowUnknownOption(arg?: boolean): this;
 
     /**
      * 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.
      *
@@ -221,16 +232,16 @@ declare namespace commander {
      *      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 Command for chaining
+     *
+     * @returns `this` command for chaining
      */
     parse(argv?: string[], options?: ParseOptions): 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.
      *
@@ -264,8 +275,8 @@ declare namespace commander {
 
     /**
      * Set the description.
-     * 
-     * @returns Command for chaining
+     *
+     * @returns `this` command for chaining
      */
     description(str: string, argsDescription?: {[argName: string]: string}): this;
     /**
@@ -275,8 +286,10 @@ declare namespace commander {
 
     /**
      * Set an alias for the command.
-     * 
-     * @returns Command for chaining
+     *
+     * You may call more than once to add multiple aliases. Only the first alias is shown in the auto-generated help.
+     *
+     * @returns `this` command for chaining
      */
     alias(alias: string): this;
     /**
@@ -284,10 +297,23 @@ declare namespace commander {
      */
     alias(): string;
 
+    /**
+     * Set aliases for the command.
+     *
+     * Only the first alias is shown in the auto-generated help.
+     *
+     * @returns `this` command for chaining
+     */
+    aliases(aliases: string[]): this;
+    /**
+     * Get aliases for the command.
+     */
+    aliases(): string[];
+
     /**
      * Set the command usage.
-     * 
-     * @returns Command for chaining
+     *
+     * @returns `this` command for chaining
      */
     usage(str: string): this;
     /**
@@ -297,8 +323,8 @@ declare namespace commander {
 
     /**
      * Set the name of the command.
-     * 
-     * @returns Command for chaining
+     *
+     * @returns `this` command for chaining
      */
     name(str: string): this;
     /**
@@ -318,21 +344,22 @@ declare namespace commander {
      * Return command help documentation.
      */
     helpInformation(): string;
-    
+
     /**
      * You can pass in flags and a description to override the help
-     * flags and help description for your command.
+     * flags and help description for your command. Pass in false
+     * to disable the built-in help option.
      */
-    helpOption(flags?: string, description?: string): this;
+    helpOption(flags?: string | boolean, description?: string): this;
 
-    /** 
+    /**
      * Output help information and exit.
      */
     help(cb?: (str: string) => string): never;
 
     /**
      * Add a listener (callback) for when events occur. (Implemented using EventEmitter.)
-     * 
+     *
      * @example
      *     program
      *       .on('--help', () -> {
@@ -341,28 +368,32 @@ declare namespace commander {
      */
     on(event: string | symbol, listener: (...args: any[]) => void): this;
   }
-  type CommandConstructor = { new (name?: string): Command };
+  type CommandConstructor = new (name?: string) => Command;
 
+  interface CommandOptions {
+    noHelp?: boolean; // old name for hidden
+    hidden?: boolean;
+    isDefault?: boolean;
+  }
+  interface ExecutableCommandOptions extends CommandOptions {
+    executableFile?: string;
+  }
 
-    interface CommandOptions {
-        noHelp?: boolean;
-        isDefault?: boolean;
-        executableFile?: string;
-    }
-
-    interface ParseOptionsResult {
-        operands: string[];
-        unknown: string[];
-    }
+  interface ParseOptionsResult {
+    operands: string[];
+    unknown: string[];
+  }
 
-    interface CommanderStatic extends Command {
-        program: Command;
-        Command: CommandConstructor;
-        Option: OptionConstructor;
-        CommanderError:CommanderErrorConstructor;
-      }
+  interface CommanderStatic extends Command {
+    program: Command;
+    Command: CommandConstructor;
+    Option: OptionConstructor;
+    CommanderError: CommanderErrorConstructor;
+  }
 
 }
 
+// Declaring namespace AND global
+// eslint-disable-next-line no-redeclare
 declare const commander: commander.CommanderStatic;
 export = commander;