commander 5.0.0-2 → 5.1.0

package/CHANGELOG.md

@@ -7,33 +7,28 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 <!-- markdownlint-disable MD024 -->
 
-## [5.0.0-2] (2020-02-10)
+## [5.1.0] (2020-04-25)
 
 ### Added
 
-- suggest help option along with unknown command error ([#1179])
-
-### Changed
+- support for multiple command aliases, the first of which is shown in the auto-generated help ([#531], [#1236])
+- configuration support in `addCommand()` for `hidden` and `isDefault` ([#1232])
 
-- TypeScript fluent return types changed to be more subclass friendly, return `this` rather than `Command` ([#1180])
-
-## [5.0.0-1] (2020-02-08)
+### Fixed
 
-### Added
-
-* `.helpInformation()` returns help text as a string, previously a private routine ([#1169])
-* `.parse()` implicitly uses `process.argv` if arguments not specified ([#1172])
-* optionally specify where `.parse()` arguments "from", if not following node conventions ([#512] [#1172])
+- omit masked help flags from the displayed help ([#645], [#1247])
+- remove old short help flag when change help flags using `helpOption` ([#1248])
 
 ### Changed
 
-* changes to error handling ([#1165])
-  * throw for author error, not just display message
-  * preflight for variadic error
-  * add tips to missing subcommand executable
-* update dependencies
+- remove use of `arguments` to improve auto-generated help in editors ([#1235])
+- rename `.command()` configuration `noHelp` to `hidden` (but not remove old support) ([#1232])
+- improvements to documentation
+- update dependencies
+- update tested versions of node
+- eliminate lint errors in TypeScript ([#1208])
 
-## [5.0.0-0] (2020-02-02)
+## [5.0.0] (2020-03-14)
 
 ### Added
 
@@ -46,6 +41,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 * display help for missing subcommand, by default ([#1088] [#1149])
 * combined short options as single argument may include boolean flags and value flag and value (e.g. `-a -b -p 80` can be written as `-abp80`) ([#1145])
 * `.parseOption()` includes short flag and long flag expansions ([#1145])
+* `.helpInformation()` returns help text as a string, previously a private routine ([#1169])
+* `.parse()` implicitly uses `process.argv` if arguments not specified ([#1172])
+* optionally specify where `.parse()` arguments "from", if not following node conventions ([#512] [#1172])
+* suggest help option along with unknown command error ([#1179])
+* TypeScript definition for `commands` property of `Command` ([#1184])
+* export `program` property ([#1195])
+* `createCommand` factory method to simplify subclassing ([#1191])
 
 ### Fixed
 
@@ -72,6 +74,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 * *Breaking* `.on('command:*', callback)` and other command events passed (changed) results from `.parseOptions`, i.e. operands and unknown  ([#1138])
 * refactor Option from prototype to class ([#1133])
 * refactor Command from prototype to class ([#1159])
+* changes to error handling ([#1165])
+  * throw for author error, not just display message
+  * preflight for variadic error
+  * add tips to missing subcommand executable
+* TypeScript fluent return types changed to be more subclass friendly, return `this` rather than `Command` ([#1180])
+* `.parseAsync` returns `Promise<this>` to be consistent with `.parse()` ([#1180])
+* update dependencies
 
 ### Removed
 
@@ -87,6 +96,26 @@ If you use `program.args` or more complicated tests to detect a missing subcomma
 
 If you use `.command('*')` to add a default command, you may be be able to switch to `isDefault:true` with a named command.
 
+## [5.0.0-4] (2020-03-03)
+
+(Released in 5.0.0)
+
+## [5.0.0-3] (2020-02-20)
+
+(Released in 5.0.0)
+
+## [5.0.0-2] (2020-02-10)
+
+(Released in 5.0.0)
+
+## [5.0.0-1] (2020-02-08)
+
+(Released in 5.0.0)
+
+## [5.0.0-0] (2020-02-02)
+
+(Released in 5.0.0)
+
 ## [4.1.1] (2020-02-02)
 
 ### Fixed
@@ -266,8 +295,10 @@ program
 [#432]: https://github.com/tj/commander.js/issues/432
 [#508]: https://github.com/tj/commander.js/issues/508
 [#512]: https://github.com/tj/commander.js/issues/512
+[#531]: https://github.com/tj/commander.js/issues/531
 [#599]: https://github.com/tj/commander.js/issues/599
 [#611]: https://github.com/tj/commander.js/issues/611
+[#645]: https://github.com/tj/commander.js/issues/645
 [#697]: https://github.com/tj/commander.js/issues/697
 [#742]: https://github.com/tj/commander.js/issues/742
 [#764]: https://github.com/tj/commander.js/issues/764
@@ -324,8 +355,21 @@ program
 [#1172]: https://github.com/tj/commander.js/pull/1172
 [#1179]: https://github.com/tj/commander.js/pull/1179
 [#1180]: https://github.com/tj/commander.js/pull/1180
+[#1184]: https://github.com/tj/commander.js/pull/1184
+[#1191]: https://github.com/tj/commander.js/pull/1191
+[#1195]: https://github.com/tj/commander.js/pull/1195
+[#1208]: https://github.com/tj/commander.js/pull/1208
+[#1232]: https://github.com/tj/commander.js/pull/1232
+[#1235]: https://github.com/tj/commander.js/pull/1235
+[#1236]: https://github.com/tj/commander.js/pull/1236
+[#1247]: https://github.com/tj/commander.js/pull/1247
+[#1248]: https://github.com/tj/commander.js/pull/1248
 
 [Unreleased]: https://github.com/tj/commander.js/compare/master...develop
+[5.1.0]: https://github.com/tj/commander.js/compare/v5.0.0..v5.1.0
+[5.0.0]: https://github.com/tj/commander.js/compare/v4.1.1..v5.0.0
+[5.0.0-4]: https://github.com/tj/commander.js/compare/v5.0.0-3..v5.0.0-4
+[5.0.0-3]: https://github.com/tj/commander.js/compare/v5.0.0-2..v5.0.0-3
 [5.0.0-2]: https://github.com/tj/commander.js/compare/v5.0.0-1..v5.0.0-2
 [5.0.0-1]: https://github.com/tj/commander.js/compare/v5.0.0-0..v5.0.0-1
 [5.0.0-0]: https://github.com/tj/commander.js/compare/v4.1.1..v5.0.0-0

package/Readme.md

@@ -36,6 +36,7 @@ Read this in other languages: English | [简体中文](./Readme_zh-CN.md)
     - [.parse() and .parseAsync()](#parse-and-parseasync)
     - [Avoiding option name clashes](#avoiding-option-name-clashes)
     - [TypeScript](#typescript)
+    - [createCommand()](#createcommand)
     - [Node options such as `--harmony`](#node-options-such-as---harmony)
     - [Debugging stand-alone executable subcommands](#debugging-stand-alone-executable-subcommands)
     - [Override exit handling](#override-exit-handling)
@@ -56,15 +57,15 @@ Commander exports a global object which is convenient for quick programs.
 This is used in the examples in this README for brevity.
 
 ```js
-const program = require('commander');
+const { program } = require('commander');
 program.version('0.0.1');
 ```
 
 For larger programs which may use commander in multiple ways, including unit testing, it is better to create a local Command object to use.
 
  ```js
- const commander = require('commander');
- const program = new commander.Command();
+ const { Command } = require('commander');
+ const program = new Command();
  program.version('0.0.1');
  ```
 
@@ -88,7 +89,7 @@ Options on the command line are not positional, and can be specified before or a
 The two most used option types are a boolean flag, and an option which takes a value (declared using angle brackets). Both are `undefined` unless specified on command line.
 
 ```js
-const program = require('commander');
+const { program } = require('commander');
 
 program
   .option('-d, --debug', 'output extra debugging')
@@ -126,7 +127,7 @@ pizza details:
 You can specify a default value for an option which takes a value.
 
 ```js
-const program = require('commander');
+const { program } = require('commander');
 
 program
   .option('-c, --cheese <type>', 'add the specified type of cheese', 'blue');
@@ -152,7 +153,7 @@ If you define `--foo` first, adding `--no-foo` does not change the default value
 otherwise be. You can specify a default boolean value for a boolean flag and it can be overridden on command line.
 
 ```js
-const program = require('commander');
+const { program } = require('commander');
 
 program
   .option('--no-sauce', 'Remove sauce')
@@ -179,7 +180,7 @@ You ordered a pizza with no sauce and no cheese
 You can specify an option which functions as a flag but may also take a value (declared using square brackets).
 
 ```js
-const program = require('commander');
+const { program } = require('commander');
 
 program
   .option('-c, --cheese [type]', 'Add cheese with optional type');
@@ -210,7 +211,7 @@ This allows you to coerce the option value to the desired type, or accumulate va
 You can optionally specify the default/starting value for the option after the function.
 
 ```js
-const program = require('commander');
+const { program } = require('commander');
 
 function myParseInt(value, dummyPrevious) {
   // parseInt takes a string and an optional radix
@@ -264,7 +265,7 @@ $ custom --list x,y,z
 You may specify a required (mandatory) option using `.requiredOption`. The option must have a value after parsing, usually specified on the command line, or perhaps from a default value (say from environment). The method is otherwise the same as `.option` in format, taking flags and description, and optional default value or custom processing.
 
 ```js
-const program = require('commander');
+const { program } = require('commander');
 
 program
   .requiredOption('-c, --cheese <type>', 'pizza must have cheese');
@@ -299,7 +300,7 @@ program.version('0.0.1', '-v, --vers', 'output the current version');
 
 ## Commands
 
-You can specify (sub)commands for your top-level command using `.command()` or `.addCommand()`. There are two ways these can be implemented: using an action handler attached to the command, or as a stand-alone executable file (described in more detail later). The subcommands may be nested ([example](./examples/nestedCommands.js)).
+You can specify (sub)commands using `.command()` or `.addCommand()`. There are two ways these can be implemented: using an action handler attached to the command, or as a stand-alone executable file (described in more detail later). The subcommands may be nested ([example](./examples/nestedCommands.js)).
 
 In the first parameter to `.command()` you specify the command name and any command arguments. The arguments may be `<required>` or `[optional]`, and the last argument may also be `variadic...`.
 
@@ -318,25 +319,25 @@ program
   });
 
 // Command implemented using stand-alone executable file (description is second parameter to `.command`)
-// Returns top-level command for adding more commands.
+// Returns `this` for adding more commands.
 program
   .command('start <service>', 'start named service')
   .command('stop [service]', 'stop named service, or all if no name supplied');
 
 // Command prepared separately.
-// Returns top-level command for adding more commands.
+// Returns `this` for adding more commands.
 program
   .addCommand(build.makeBuildCommand());
 ```
 
-Configuration options can be passed with the call to `.command()`. Specifying `true` for `opts.noHelp` will remove the command from the generated help output. Specifying `true` for `opts.isDefault` will run the subcommand if no other subcommand is specified ([example](./examples/defaultCommand.js)).
+Configuration options can be passed with the call to `.command()` and `.addCommand()`. Specifying `true` for `opts.hidden` will remove the command from the generated help output. Specifying `true` for `opts.isDefault` will run the subcommand if no other subcommand is specified ([example](./examples/defaultCommand.js)).
 
 ### Specify the argument syntax
 
-You use `.arguments` to specify the arguments for the top-level command, and for subcommands they are included in the `.command` call. Angled brackets (e.g. `<required>`) indicate required input. Square brackets (e.g. `[optional]`) indicate optional input.
+You use `.arguments` to specify the arguments for the top-level command, and for subcommands they are usually included in the `.command` call. Angled brackets (e.g. `<required>`) indicate required input. Square brackets (e.g. `[optional]`) indicate optional input.
 
 ```js
-const program = require('commander');
+const { program } = require('commander');
 
 program
   .version('0.1.0')
@@ -360,7 +361,7 @@ console.log('environment:', envValue || "no environment given");
  append `...` to the argument name. For example:
 
 ```js
-const program = require('commander');
+const { program } = require('commander');
 
 program
   .version('0.1.0')
@@ -386,7 +387,7 @@ The action handler gets passed a parameter for each argument you declared, and o
 command object itself. This command argument has the values for the command-specific options added as properties.
 
 ```js
-const program = require('commander');
+const { program } = require('commander');
 
 program
   .command('rm <dir>')
@@ -423,7 +424,7 @@ You handle the options for an executable (sub)command in the executable, and don
 
 ```js
 // file: ./examples/pm
-const program = require('commander');
+const { program } = require('commander');
 
 program
   .version('0.1.0')
@@ -557,9 +558,7 @@ program.on('option:verbose', function () {
 program.on('command:*', function (operands) {
   console.error(`error: unknown command '${operands[0]}'`);
   const availableCommands = program.commands.map(cmd => cmd.name());
-  const suggestion = didYouMean(operands[0], availableCommands);
-  if (suggestion)
-    console.error(`Did you mean '${suggestion}'?`);
+  mySuggestBestMatch(operands[0], availableCommands);
   process.exitCode = 1;
 });
 ```
@@ -632,6 +631,19 @@ If you use `ts-node` and  stand-alone executable subcommands written as `.ts` fi
 node -r ts-node/register pm.ts
 ```
 
+### createCommand()
+
+This factory function creates a new command. It is exported and may be used instead of using `new`, like:
+
+```js
+const { createCommand } = require('commander');
+const program = createCommand();
+```
+
+`createCommand` is also a method of the Command object, and creates a new command rather than a subcommand. This gets used internally
+when creating subcommands using `.command()`, and you may override it to
+customise the new subcommand (examples using [subclass](./examples/custom-command-class.js) and [function](./examples/custom-command-function.js)).
+
 ### Node options such as `--harmony`
 
 You can enable `--harmony` option in two ways:
@@ -669,7 +681,7 @@ try {
 ## Examples
 
 ```js
-const program = require('commander');
+const { program } = require('commander');
 
 program
   .version('0.1.0')
@@ -713,7 +725,7 @@ More Demos can be found in the [examples](https://github.com/tj/commander.js/tre
 
 ## Support
 
-Commander 4.x is supported on Node 8 and above, and is likely to work with Node 6 but not tested.
+Commander 5.x is fully supported on Long Term Support versions of Node, and is likely to work with Node 6 but not tested.
 (For versions of Node below Node 6, use Commander 3.x or 2.x.)
 
 The main forum for free and community support is the project [Issues](https://github.com/tj/commander.js/issues) on GitHub.

package/index.js

@@ -7,6 +7,8 @@ const spawn = require('child_process').spawn;
 const path = require('path');
 const fs = require('fs');
 
+// @ts-check
+
 class Option {
   /**
    * Initialize a new `Option` with the given `flags` and `description`.
@@ -22,10 +24,11 @@ class Option {
     this.optional = flags.indexOf('[') >= 0; // A value is optional when the option is specified.
     this.mandatory = false; // The option must have a value after parsing, which usually means it must be specified on command line.
     this.negate = flags.indexOf('-no-') !== -1;
-    flags = flags.split(/[ ,|]+/);
-    if (flags.length > 1 && !/^[[<]/.test(flags[1])) this.short = flags.shift();
-    this.long = flags.shift();
+    const flagParts = flags.split(/[ ,|]+/);
+    if (flagParts.length > 1 && !/^[[<]/.test(flagParts[1])) this.short = flagParts.shift();
+    this.long = flagParts.shift();
     this.description = description || '';
+    this.defaultValue = undefined;
   }
 
   /**
@@ -83,6 +86,7 @@ class CommanderError extends Error {
     this.name = this.constructor.name;
     this.code = code;
     this.exitCode = exitCode;
+    this.nestedError = undefined;
   }
 }
 
@@ -98,6 +102,7 @@ class Command extends EventEmitter {
     super();
     this.commands = [];
     this.options = [];
+    this.parent = null;
     this._allowUnknownOption = false;
     this._args = [];
     this.rawArgs = null;
@@ -112,8 +117,9 @@ class Command extends EventEmitter {
     this._executableFile = null; // custom name for executable
     this._defaultCommandName = null;
     this._exitCallback = null;
+    this._aliases = [];
 
-    this._noHelp = false;
+    this._hidden = false;
     this._helpFlags = '-h, --help';
     this._helpDescription = 'display help for command';
     this._helpShortFlag = '-h';
@@ -147,7 +153,7 @@ class Command extends EventEmitter {
    * @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 top-level command for executable command
+   * @return {Command} returns new command for action handler, or `this` for executable command
    * @api public
    */
 
@@ -160,7 +166,7 @@ class Command extends EventEmitter {
     }
     opts = opts || {};
     const args = nameAndArgs.split(/ +/);
-    const cmd = new Command(args.shift());
+    const cmd = this.createCommand(args.shift());
 
     if (desc) {
       cmd.description(desc);
@@ -168,7 +174,7 @@ class Command extends EventEmitter {
     }
     if (opts.isDefault) this._defaultCommandName = cmd._name;
 
-    cmd._noHelp = !!opts.noHelp;
+    cmd._hidden = !!(opts.noHelp || opts.hidden);
     cmd._helpFlags = this._helpFlags;
     cmd._helpDescription = this._helpDescription;
     cmd._helpShortFlag = this._helpShortFlag;
@@ -189,15 +195,33 @@ class Command extends EventEmitter {
     return cmd;
   };
 
+  /**
+   * 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
+   * @api public
+   */
+
+  createCommand(name) {
+    return new Command(name);
+  };
+
   /**
    * Add a prepared subcommand.
    *
+   * See .command() for creating an attached subcommand which inherits settings from its parent.
+   *
    * @param {Command} cmd - new subcommand
-   * @return {Command} parent command for chaining
+   * @param {Object} [opts] - configuration options
+   * @return {Command} `this` command for chaining
    * @api public
    */
 
-  addCommand(cmd) {
+  addCommand(cmd, opts) {
     if (!cmd._name) throw new Error('Command passed to .addCommand() must have a name');
 
     // To keep things simple, block automatic name generation for deeply nested executables.
@@ -212,13 +236,17 @@ class Command extends EventEmitter {
     }
     checkExplicitNames(cmd.commands);
 
+    opts = opts || {};
+    if (opts.isDefault) this._defaultCommandName = cmd._name;
+    if (opts.noHelp || opts.hidden) cmd._hidden = true; // modifying passed command due to existing implementation
+
     this.commands.push(cmd);
     cmd.parent = this;
     return this;
   };
 
   /**
-   * Define argument syntax for the top-level command.
+   * Define argument syntax for the command.
    *
    * @api public
    */
@@ -234,7 +262,7 @@ class Command extends EventEmitter {
    *    addHelpCommand(false); // force off
    *    addHelpCommand('help [cmd]', 'display help for [cmd]'); // force on with custom detais
    *
-   * @return {Command} for chaining
+   * @return {Command} `this` command for chaining
    * @api public
    */
 
@@ -270,7 +298,7 @@ class Command extends EventEmitter {
    * For example `["[type]"]` becomes `[{ required: false, name: 'type' }]`.
    *
    * @param {Array} args
-   * @return {Command} for chaining
+   * @return {Command} `this` command for chaining
    * @api private
    */
 
@@ -313,7 +341,7 @@ class Command extends EventEmitter {
    * 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} for chaining
+   * @return {Command} `this` command for chaining
    * @api public
    */
 
@@ -363,7 +391,7 @@ class Command extends EventEmitter {
    *        });
    *
    * @param {Function} fn
-   * @return {Command} for chaining
+   * @return {Command} `this` command for chaining
    * @api public
    */
 
@@ -402,7 +430,7 @@ class Command extends EventEmitter {
    * @param {string} description
    * @param {Function|*} [fn] - custom option processing function or default vaue
    * @param {*} [defaultValue]
-   * @return {Command} for chaining
+   * @return {Command} `this` command for chaining
    * @api private
    */
 
@@ -520,7 +548,7 @@ class Command extends EventEmitter {
    * @param {string} description
    * @param {Function|*} [fn] - custom option processing function or default vaue
    * @param {*} [defaultValue]
-   * @return {Command} for chaining
+   * @return {Command} `this` command for chaining
    * @api public
    */
 
@@ -538,7 +566,7 @@ class Command extends EventEmitter {
   * @param {string} description
   * @param {Function|*} [fn] - custom option processing function or default vaue
   * @param {*} [defaultValue]
-  * @return {Command} for chaining
+  * @return {Command} `this` command for chaining
   * @api public
   */
 
@@ -554,7 +582,7 @@ class Command extends EventEmitter {
    * @api public
    */
   allowUnknownOption(arg) {
-    this._allowUnknownOption = arguments.length === 0 || arg;
+    this._allowUnknownOption = (arg === undefined) || arg;
     return this;
   };
 
@@ -563,7 +591,7 @@ class Command extends EventEmitter {
     * or store separately (specify false). In both cases the option values can be accessed using .opts().
     *
     * @param {boolean} value
-    * @return {Command} Command for chaining
+    * @return {Command} `this` command for chaining
     * @api public
     */
 
@@ -580,7 +608,7 @@ class Command extends EventEmitter {
     * or just the options (specify false).
     *
     * @param {boolean} value
-    * @return {Command} Command for chaining
+    * @return {Command} `this` command for chaining
     * @api public
     */
 
@@ -634,8 +662,8 @@ class Command extends EventEmitter {
    *
    * @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} for chaining
+   * @param {string} [parseOptions.from] - where the args are from: 'node', 'user', 'electron'
+   * @return {Command} `this` command for chaining
    * @api public
    */
 
@@ -648,6 +676,7 @@ class Command extends EventEmitter {
     // Default to using process.argv
     if (argv === undefined) {
       argv = process.argv;
+      // @ts-ignore
       if (process.versions && process.versions.electron) {
         parseOptions.from = 'electron';
       }
@@ -663,6 +692,7 @@ class Command extends EventEmitter {
         userArgs = argv.slice(2);
         break;
       case 'electron':
+        // @ts-ignore
         if (process.defaultApp) {
           this._scriptPath = argv[1];
           userArgs = argv.slice(2);
@@ -780,6 +810,7 @@ class Command extends EventEmitter {
 
     const signals = ['SIGUSR1', 'SIGUSR2', 'SIGTERM', 'SIGINT', 'SIGHUP'];
     signals.forEach((signal) => {
+      // @ts-ignore
       process.on(signal, () => {
         if (proc.killed === false && proc.exitCode === null) {
           proc.kill(signal);
@@ -798,11 +829,13 @@ class Command extends EventEmitter {
       });
     }
     proc.on('error', (err) => {
+      // @ts-ignore
       if (err.code === 'ENOENT') {
         const executableMissing = `'${bin}' does not exist
  - if '${subcommand._name}' is not meant to be an executable command, remove description parameter from '.command()' and use '.description()' instead
  - if the default executable name is not suitable, use the executableFile option to supply a custom name`;
         throw new Error(executableMissing);
+      // @ts-ignore
       } else if (err.code === 'EACCES') {
         throw new Error(`'${bin}' not executable`);
       }
@@ -904,7 +937,7 @@ class Command extends EventEmitter {
    */
   _findCommand(name) {
     if (!name) return undefined;
-    return this.commands.find(cmd => cmd._name === name || cmd._alias === name);
+    return this.commands.find(cmd => cmd._name === name || cmd._aliases.includes(name));
   };
 
   /**
@@ -1119,7 +1152,6 @@ class Command extends EventEmitter {
   /**
    * Unknown command.
    *
-   * @param {string} flag
    * @api private
    */
 
@@ -1145,12 +1177,12 @@ class Command extends EventEmitter {
    * @param {string} str
    * @param {string} [flags]
    * @param {string} [description]
-   * @return {Command} for chaining
+   * @return {this | string} `this` command for chaining, or version string if no arguments
    * @api public
    */
 
   version(str, flags, description) {
-    if (arguments.length === 0) return this._version;
+    if (str === undefined) return this._version;
     this._version = str;
     flags = flags || '-V, --version';
     description = description || 'output the version number';
@@ -1169,36 +1201,57 @@ class Command extends EventEmitter {
    *
    * @param {string} str
    * @param {Object} [argsDescription]
-   * @return {String|Command}
+   * @return {string|Command}
    * @api public
    */
 
   description(str, argsDescription) {
-    if (arguments.length === 0) return this._description;
+    if (str === undefined && argsDescription === undefined) return this._description;
     this._description = str;
     this._argsDescription = argsDescription;
     return this;
   };
 
   /**
-   * Set an alias for the command
+   * Set an alias for the command.
    *
-   * @param {string} alias
-   * @return {String|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}
    * @api public
    */
 
   alias(alias) {
+    if (alias === undefined) return this._aliases[0]; // just return first, for backwards compatibility
+
     let command = this;
-    if (this.commands.length !== 0) {
+    if (this.commands.length !== 0 && this.commands[this.commands.length - 1]._executableHandler) {
+      // assume adding alias for last added executable subcommand, rather than this
       command = this.commands[this.commands.length - 1];
     }
 
-    if (arguments.length === 0) return command._alias;
-
     if (alias === command._name) throw new Error('Command alias can\'t be the same as its name');
 
-    command._alias = alias;
+    command._aliases.push(alias);
+    return this;
+  };
+
+  /**
+   * Set aliases for the command.
+   *
+   * Only the first alias is shown in the auto-generated help.
+   *
+   * @param {string[]} [aliases]
+   * @return {string[]|Command}
+   * @api public
+   */
+
+  aliases(aliases) {
+    // Getter for the array of aliases is the main reason for having aliases() in addition to alias().
+    if (aliases === undefined) return this._aliases;
+
+    aliases.forEach((alias) => this.alias(alias));
     return this;
   };
 
@@ -1211,17 +1264,18 @@ class Command extends EventEmitter {
    */
 
   usage(str) {
-    const args = this._args.map((arg) => {
-      return humanReadableArgName(arg);
-    });
+    if (str === undefined) {
+      if (this._usage) return this._usage;
 
-    const usage = '[options]' +
-      (this.commands.length ? ' [command]' : '') +
-      (this._args.length ? ' ' + args.join(' ') : '');
+      const args = this._args.map((arg) => {
+        return humanReadableArgName(arg);
+      });
+      return '[options]' +
+        (this.commands.length ? ' [command]' : '') +
+        (this._args.length ? ' ' + args.join(' ') : '');
+    }
 
-    if (arguments.length === 0) return this._usage || usage;
     this._usage = str;
-
     return this;
   };
 
@@ -1234,7 +1288,7 @@ class Command extends EventEmitter {
    */
 
   name(str) {
-    if (arguments.length === 0) return this._name;
+    if (str === undefined) return this._name;
     this._name = str;
     return this;
   };
@@ -1248,7 +1302,7 @@ class Command extends EventEmitter {
 
   prepareCommands() {
     const commandDetails = this.commands.filter((cmd) => {
-      return !cmd._noHelp;
+      return !cmd._hidden;
     }).map((cmd) => {
       const args = cmd._args.map((arg) => {
         return humanReadableArgName(arg);
@@ -1256,7 +1310,7 @@ class Command extends EventEmitter {
 
       return [
         cmd._name +
-          (cmd._alias ? '|' + cmd._alias : '') +
+          (cmd._aliases[0] ? '|' + cmd._aliases[0] : '') +
           (cmd.options.length ? ' [options]' : '') +
           (args ? ' ' + args : ''),
         cmd._description
@@ -1347,17 +1401,33 @@ class Command extends EventEmitter {
 
   optionHelp() {
     const width = this.padWidth();
-
     const columns = process.stdout.columns || 80;
     const descriptionWidth = columns - width - 4;
+    function padOptionDetails(flags, description) {
+      return pad(flags, width) + '  ' + optionalWrap(description, descriptionWidth, width + 2);
+    };
 
-    // Append the help information
-    return this.options.map((option) => {
+    // Explicit options (including version)
+    const help = this.options.map((option) => {
       const fullDesc = option.description +
         ((!option.negate && option.defaultValue !== undefined) ? ' (default: ' + JSON.stringify(option.defaultValue) + ')' : '');
-      return pad(option.flags, width) + '  ' + optionalWrap(fullDesc, descriptionWidth, width + 2);
-    }).concat([pad(this._helpFlags, width) + '  ' + optionalWrap(this._helpDescription, descriptionWidth, width + 2)])
-      .join('\n');
+      return padOptionDetails(option.flags, fullDesc);
+    });
+
+    // Implicit help
+    const showShortHelpFlag = this._helpShortFlag && !this._findOption(this._helpShortFlag);
+    const showLongHelpFlag = !this._findOption(this._helpLongFlag);
+    if (showShortHelpFlag || showLongHelpFlag) {
+      let helpFlags = this._helpFlags;
+      if (!showShortHelpFlag) {
+        helpFlags = this._helpLongFlag;
+      } else if (!showLongHelpFlag) {
+        helpFlags = this._helpShortFlag;
+      }
+      help.push(padOptionDetails(helpFlags, this._helpDescription));
+    }
+
+    return help.join('\n');
   };
 
   /**
@@ -1416,8 +1486,8 @@ class Command extends EventEmitter {
     }
 
     let cmdName = this._name;
-    if (this._alias) {
-      cmdName = cmdName + '|' + this._alias;
+    if (this._aliases[0]) {
+      cmdName = cmdName + '|' + this._aliases[0];
     }
     let parentCmdNames = '';
     for (let parentCmd = this.parent; parentCmd; parentCmd = parentCmd.parent) {
@@ -1474,7 +1544,7 @@ class Command extends EventEmitter {
    *
    * @param {string} [flags]
    * @param {string} [description]
-   * @return {Command}
+   * @return {Command} `this` command for chaining
    * @api public
    */
 
@@ -1484,6 +1554,7 @@ class Command extends EventEmitter {
 
     const splitFlags = this._helpFlags.split(/[ ,|]+/);
 
+    this._helpShortFlag = undefined;
     if (splitFlags.length > 1) this._helpShortFlag = splitFlags.shift();
 
     this._helpLongFlag = splitFlags.shift();
@@ -1523,6 +1594,7 @@ class Command extends EventEmitter {
  */
 
 exports = module.exports = new Command();
+exports.program = exports; // More explicit access to global command.
 
 /**
  * Expose classes

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "commander",
-  "version": "5.0.0-2",
+  "version": "5.1.0",
   "description": "the complete solution for node.js command-line programs",
   "keywords": [
     "commander",
     "command",
     "option",
-    "parser"
+    "parser",
+    "cli",
+    "argument",
+    "args",
+    "argv"
   ],
   "author": "TJ Holowaychuk <tj@vision-media.ca>",
   "license": "MIT",
@@ -16,6 +20,7 @@
   },
   "scripts": {
     "lint": "eslint index.js \"tests/**/*.js\"",
+    "typescript-lint": "eslint typings/*.ts",
     "test": "jest && npm run test-typings",
     "test-typings": "tsc -p tsconfig.json"
   },
@@ -26,12 +31,14 @@
   ],
   "dependencies": {},
   "devDependencies": {
-    "@types/jest": "^25.1.1",
-    "@types/node": "^12.12.26",
+    "@types/jest": "^25.2.1",
+    "@types/node": "^12.12.36",
+    "@typescript-eslint/eslint-plugin": "^2.29.0",
     "eslint": "^6.8.0",
-    "eslint-plugin-jest": "^23.6.0",
-    "jest": "^25.1.0",
-    "standard": "^14.3.1",
+    "eslint-config-standard-with-typescript": "^15.0.1",
+    "eslint-plugin-jest": "^23.8.2",
+    "jest": "^25.4.0",
+    "standard": "^14.3.3",
     "typescript": "^3.7.5"
   },
   "typings": "typings/index.d.ts",

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,10 +21,10 @@ 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";
+    from: 'node' | 'electron' | 'user';
   }
 
   interface Command {
@@ -32,22 +32,24 @@ declare namespace commander {
 
     args: string[];
 
+    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
@@ -57,43 +59,53 @@ 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
      */
-    command(nameAndArgs: string, opts?: CommandOptions): Command;
+    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');
      * ```
-     * 
+     *
      * @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.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.
      */
-    command(nameAndArgs: string, description: string, opts?: commander.CommandOptions): this;
+    createCommand(name?: string): Command;
 
     /**
      * Add a prepared subcommand.
-     * 
-     * @returns parent command for chaining
+     *
+     * See .command() for creating an attached subcommand which inherits settings from its parent.
+     *
+     * @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;
 
@@ -113,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;
 
@@ -157,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;
@@ -173,20 +185,19 @@ 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;
 
@@ -194,13 +205,13 @@ declare namespace commander {
      * 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.
      *
@@ -209,16 +220,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.
      *
@@ -252,8 +263,8 @@ declare namespace commander {
 
     /**
      * Set the description.
-     * 
-     * @returns Command for chaining
+     *
+     * @returns `this` command for chaining
      */
     description(str: string, argsDescription?: {[argName: string]: string}): this;
     /**
@@ -263,8 +274,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;
     /**
@@ -272,10 +285,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;
     /**
@@ -285,8 +311,8 @@ declare namespace commander {
 
     /**
      * Set the name of the command.
-     * 
-     * @returns Command for chaining
+     *
+     * @returns `this` command for chaining
      */
     name(str: string): this;
     /**
@@ -306,21 +332,21 @@ 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.
      */
     helpOption(flags?: string, 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', () -> {
@@ -329,27 +355,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 {
-        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;