aboutsummaryrefslogtreecommitdiff
path: root/node_modules/commander
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2018-09-20 02:56:13 +0200
committerFlorian Dold <florian.dold@gmail.com>2018-09-20 02:56:13 +0200
commitbbff7403fbf46f9ad92240ac213df8d30ef31b64 (patch)
treec58400ec5124da1c7d56b01aea83309f80a56c3b /node_modules/commander
parent003fb34971cf63466184351b4db5f7c67df4f444 (diff)
update packages
Diffstat (limited to 'node_modules/commander')
-rw-r--r--node_modules/commander/History.md298
-rw-r--r--node_modules/commander/Readme.md88
-rw-r--r--node_modules/commander/index.js341
-rw-r--r--node_modules/commander/package.json24
4 files changed, 317 insertions, 434 deletions
diff --git a/node_modules/commander/History.md b/node_modules/commander/History.md
deleted file mode 100644
index d60418ebd..000000000
--- a/node_modules/commander/History.md
+++ /dev/null
@@ -1,298 +0,0 @@
-
-2.11.0 / 2017-07-03
-==================
-
- * Fix help section order and padding (#652)
- * feature: support for signals to subcommands (#632)
- * Fixed #37, --help should not display first (#447)
- * Fix translation errors. (#570)
- * Add package-lock.json
- * Remove engines
- * Upgrade package version
- * Prefix events to prevent conflicts between commands and options (#494)
- * Removing dependency on graceful-readlink
- * Support setting name in #name function and make it chainable
- * Add .vscode directory to .gitignore (Visual Studio Code metadata)
- * Updated link to ruby commander in readme files
-
-2.10.0 / 2017-06-19
-==================
-
- * Update .travis.yml. drop support for older node.js versions.
- * Fix require arguments in README.md
- * On SemVer you do not start from 0.0.1
- * Add missing semi colon in readme
- * Add save param to npm install
- * node v6 travis test
- * Update Readme_zh-CN.md
- * Allow literal '--' to be passed-through as an argument
- * Test subcommand alias help
- * link build badge to master branch
- * Support the alias of Git style sub-command
- * added keyword commander for better search result on npm
- * Fix Sub-Subcommands
- * test node.js stable
- * Fixes TypeError when a command has an option called `--description`
- * Update README.md to make it beginner friendly and elaborate on the difference between angled and square brackets.
- * Add chinese Readme file
-
-2.9.0 / 2015-10-13
-==================
-
- * Add option `isDefault` to set default subcommand #415 @Qix-
- * Add callback to allow filtering or post-processing of help text #434 @djulien
- * Fix `undefined` text in help information close #414 #416 @zhiyelee
-
-2.8.1 / 2015-04-22
-==================
-
- * Back out `support multiline description` Close #396 #397
-
-2.8.0 / 2015-04-07
-==================
-
- * Add `process.execArg` support, execution args like `--harmony` will be passed to sub-commands #387 @DigitalIO @zhiyelee
- * Fix bug in Git-style sub-commands #372 @zhiyelee
- * Allow commands to be hidden from help #383 @tonylukasavage
- * When git-style sub-commands are in use, yet none are called, display help #382 @claylo
- * Add ability to specify arguments syntax for top-level command #258 @rrthomas
- * Support multiline descriptions #208 @zxqfox
-
-2.7.1 / 2015-03-11
-==================
-
- * Revert #347 (fix collisions when option and first arg have same name) which causes a bug in #367.
-
-2.7.0 / 2015-03-09
-==================
-
- * Fix git-style bug when installed globally. Close #335 #349 @zhiyelee
- * Fix collisions when option and first arg have same name. Close #346 #347 @tonylukasavage
- * Add support for camelCase on `opts()`. Close #353 @nkzawa
- * Add node.js 0.12 and io.js to travis.yml
- * Allow RegEx options. #337 @palanik
- * Fixes exit code when sub-command failing. Close #260 #332 @pirelenito
- * git-style `bin` files in $PATH make sense. Close #196 #327 @zhiyelee
-
-2.6.0 / 2014-12-30
-==================
-
- * added `Command#allowUnknownOption` method. Close #138 #318 @doozr @zhiyelee
- * Add application description to the help msg. Close #112 @dalssoft
-
-2.5.1 / 2014-12-15
-==================
-
- * fixed two bugs incurred by variadic arguments. Close #291 @Quentin01 #302 @zhiyelee
-
-2.5.0 / 2014-10-24
-==================
-
- * add support for variadic arguments. Closes #277 @whitlockjc
-
-2.4.0 / 2014-10-17
-==================
-
- * fixed a bug on executing the coercion function of subcommands option. Closes #270
- * added `Command.prototype.name` to retrieve command name. Closes #264 #266 @tonylukasavage
- * added `Command.prototype.opts` to retrieve all the options as a simple object of key-value pairs. Closes #262 @tonylukasavage
- * fixed a bug on subcommand name. Closes #248 @jonathandelgado
- * fixed function normalize doesn’t honor option terminator. Closes #216 @abbr
-
-2.3.0 / 2014-07-16
-==================
-
- * add command alias'. Closes PR #210
- * fix: Typos. Closes #99
- * fix: Unused fs module. Closes #217
-
-2.2.0 / 2014-03-29
-==================
-
- * add passing of previous option value
- * fix: support subcommands on windows. Closes #142
- * Now the defaultValue passed as the second argument of the coercion function.
-
-2.1.0 / 2013-11-21
-==================
-
- * add: allow cflag style option params, unit test, fixes #174
-
-2.0.0 / 2013-07-18
-==================
-
- * remove input methods (.prompt, .confirm, etc)
-
-1.3.2 / 2013-07-18
-==================
-
- * add support for sub-commands to co-exist with the original command
-
-1.3.1 / 2013-07-18
-==================
-
- * add quick .runningCommand hack so you can opt-out of other logic when running a sub command
-
-1.3.0 / 2013-07-09
-==================
-
- * add EACCES error handling
- * fix sub-command --help
-
-1.2.0 / 2013-06-13
-==================
-
- * allow "-" hyphen as an option argument
- * support for RegExp coercion
-
-1.1.1 / 2012-11-20
-==================
-
- * add more sub-command padding
- * fix .usage() when args are present. Closes #106
-
-1.1.0 / 2012-11-16
-==================
-
- * add git-style executable subcommand support. Closes #94
-
-1.0.5 / 2012-10-09
-==================
-
- * fix `--name` clobbering. Closes #92
- * fix examples/help. Closes #89
-
-1.0.4 / 2012-09-03
-==================
-
- * add `outputHelp()` method.
-
-1.0.3 / 2012-08-30
-==================
-
- * remove invalid .version() defaulting
-
-1.0.2 / 2012-08-24
-==================
-
- * add `--foo=bar` support [arv]
- * fix password on node 0.8.8. Make backward compatible with 0.6 [focusaurus]
-
-1.0.1 / 2012-08-03
-==================
-
- * fix issue #56
- * fix tty.setRawMode(mode) was moved to tty.ReadStream#setRawMode() (i.e. process.stdin.setRawMode())
-
-1.0.0 / 2012-07-05
-==================
-
- * add support for optional option descriptions
- * add defaulting of `.version()` to package.json's version
-
-0.6.1 / 2012-06-01
-==================
-
- * Added: append (yes or no) on confirmation
- * Added: allow node.js v0.7.x
-
-0.6.0 / 2012-04-10
-==================
-
- * Added `.prompt(obj, callback)` support. Closes #49
- * Added default support to .choose(). Closes #41
- * Fixed the choice example
-
-0.5.1 / 2011-12-20
-==================
-
- * Fixed `password()` for recent nodes. Closes #36
-
-0.5.0 / 2011-12-04
-==================
-
- * Added sub-command option support [itay]
-
-0.4.3 / 2011-12-04
-==================
-
- * Fixed custom help ordering. Closes #32
-
-0.4.2 / 2011-11-24
-==================
-
- * Added travis support
- * Fixed: line-buffered input automatically trimmed. Closes #31
-
-0.4.1 / 2011-11-18
-==================
-
- * Removed listening for "close" on --help
-
-0.4.0 / 2011-11-15
-==================
-
- * Added support for `--`. Closes #24
-
-0.3.3 / 2011-11-14
-==================
-
- * Fixed: wait for close event when writing help info [Jerry Hamlet]
-
-0.3.2 / 2011-11-01
-==================
-
- * Fixed long flag definitions with values [felixge]
-
-0.3.1 / 2011-10-31
-==================
-
- * Changed `--version` short flag to `-V` from `-v`
- * Changed `.version()` so it's configurable [felixge]
-
-0.3.0 / 2011-10-31
-==================
-
- * Added support for long flags only. Closes #18
-
-0.2.1 / 2011-10-24
-==================
-
- * "node": ">= 0.4.x < 0.7.0". Closes #20
-
-0.2.0 / 2011-09-26
-==================
-
- * Allow for defaults that are not just boolean. Default peassignment only occurs for --no-*, optional, and required arguments. [Jim Isaacs]
-
-0.1.0 / 2011-08-24
-==================
-
- * Added support for custom `--help` output
-
-0.0.5 / 2011-08-18
-==================
-
- * Changed: when the user enters nothing prompt for password again
- * Fixed issue with passwords beginning with numbers [NuckChorris]
-
-0.0.4 / 2011-08-15
-==================
-
- * Fixed `Commander#args`
-
-0.0.3 / 2011-08-15
-==================
-
- * Added default option value support
-
-0.0.2 / 2011-08-15
-==================
-
- * Added mask support to `Command#password(str[, mask], fn)`
- * Added `Command#password(str, fn)`
-
-0.0.1 / 2010-01-03
-==================
-
- * Initial release
diff --git a/node_modules/commander/Readme.md b/node_modules/commander/Readme.md
index 3135a9443..5897d371a 100644
--- a/node_modules/commander/Readme.md
+++ b/node_modules/commander/Readme.md
@@ -3,7 +3,8 @@
[![Build Status](https://api.travis-ci.org/tj/commander.js.svg?branch=master)](http://travis-ci.org/tj/commander.js)
[![NPM Version](http://img.shields.io/npm/v/commander.svg?style=flat)](https://www.npmjs.org/package/commander)
-[![NPM Downloads](https://img.shields.io/npm/dm/commander.svg?style=flat)](https://www.npmjs.org/package/commander)
+[![NPM Downloads](https://img.shields.io/npm/dm/commander.svg?style=flat)](https://npmcharts.com/compare/commander?minimal=true)
+[![Install Size](https://packagephobia.now.sh/badge?p=commander)](https://packagephobia.now.sh/result?p=commander)
[![Join the chat at https://gitter.im/tj/commander.js](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/tj/commander.js?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
The complete solution for [node.js](http://nodejs.org) command-line interfaces, inspired by Ruby's [commander](https://github.com/commander-rb/commander).
@@ -16,7 +17,7 @@
## Option parsing
- Options with commander are defined with the `.option()` method, also serving as documentation for the options. The example below parses args and options from `process.argv`, leaving remaining args as the `program.args` array which were not consumed by options.
+Options with commander are defined with the `.option()` method, also serving as documentation for the options. The example below parses args and options from `process.argv`, leaving remaining args as the `program.args` array which were not consumed by options.
```js
#!/usr/bin/env node
@@ -42,8 +43,65 @@ if (program.bbqSauce) console.log(' - bbq');
console.log(' - %s cheese', program.cheese);
```
- Short flags may be passed as a single arg, for example `-abc` is equivalent to `-a -b -c`. Multi-word options such as "--template-engine" are camel-cased, becoming `program.templateEngine` etc.
+Short flags may be passed as a single arg, for example `-abc` is equivalent to `-a -b -c`. Multi-word options such as "--template-engine" are camel-cased, becoming `program.templateEngine` etc.
+Note that multi-word options starting with `--no` prefix negate the boolean value of the following word. For example, `--no-sauce` sets the value of `program.sauce` to false.
+
+```js
+#!/usr/bin/env node
+
+/**
+ * Module dependencies.
+ */
+
+var program = require('commander');
+
+program
+ .option('--no-sauce', 'Remove sauce')
+ .parse(process.argv);
+
+console.log('you ordered a pizza');
+if (program.sauce) console.log(' with sauce');
+else console.log(' without sauce');
+```
+
+## Version option
+
+Calling the `version` implicitly adds the `-V` and `--version` options to the command.
+When either of these options is present, the command prints the version number and exits.
+
+ $ ./examples/pizza -V
+ 0.0.1
+
+If you want your program to respond to the `-v` option instead of the `-V` option, simply pass custom flags to the `version` method using the same syntax as the `option` method.
+
+```js
+program
+ .version('0.0.1', '-v, --version')
+```
+
+The version flags can be named anything, but the long option is required.
+
+## Command-specific options
+
+You can attach options to a command.
+
+```js
+#!/usr/bin/env node
+
+var program = require('commander');
+
+program
+ .command('rm <dir>')
+ .option('-r, --recursive', 'Remove recursively')
+ .action(function (dir, cmd) {
+ console.log('remove ' + dir + (cmd.recursive ? ' recursively' : ''))
+ })
+
+program.parse(process.argv)
+```
+
+A command's options are validated when the command is used. Any unknown options will be reported as an error. However, if an action-based command does not define an action, then the options are not validated.
## Coercion
@@ -175,7 +233,7 @@ program
When `.command()` is invoked with a description argument, no `.action(callback)` should be called to handle sub-commands, otherwise there will be an error. This tells commander that you're going to use separate executables for sub-commands, much like `git(1)` and other popular tools.
The commander will try to search the executables in the directory of the entry script (like `./examples/pm`) with the name `program-command`, like `pm-install`, `pm-search`.
-Options can be passed with the call to `.command()`. Specifying `true` for `opts.noHelp` will remove the option from the generated help output. Specifying `true` for `opts.isDefault` will run the subcommand if no other subcommand is specified.
+Options can be passed with the call to `.command()`. Specifying `true` for `opts.noHelp` will remove the subcommand from the generated help output. Specifying `true` for `opts.isDefault` will run the subcommand if no other subcommand is specified.
If the program is designed to be installed globally, make sure the executables have proper modes, like `755`.
@@ -285,9 +343,9 @@ program
.command('getstream [url]', 'get stream URL')
.parse(process.argv);
- if (!process.argv.slice(2).length) {
- program.outputHelp(make_red);
- }
+if (!process.argv.slice(2).length) {
+ program.outputHelp(make_red);
+}
function make_red(txt) {
return colors.red(txt); //display the help text in red on the console
@@ -299,6 +357,22 @@ function make_red(txt) {
Output help information and exit immediately.
Optional callback cb allows post-processing of help text before it is displayed.
+
+## Custom event listeners
+ You can execute custom actions by listening to command and option events.
+
+```js
+program.on('option:verbose', function () {
+ process.env.VERBOSE = this.verbose;
+});
+
+// error on unknown commands
+program.on('command:*', function () {
+ console.error('Invalid command: %s\nSee --help for a list of available commands.', program.args.join(' '));
+ process.exit(1);
+});
+```
+
## Examples
```js
diff --git a/node_modules/commander/index.js b/node_modules/commander/index.js
index d5dbe1868..3ad0cacfd 100644
--- a/node_modules/commander/index.js
+++ b/node_modules/commander/index.js
@@ -10,6 +10,12 @@ var basename = path.basename;
var fs = require('fs');
/**
+ * Inherit `Command` from `EventEmitter.prototype`.
+ */
+
+require('util').inherits(Command, EventEmitter);
+
+/**
* Expose the root command.
*/
@@ -37,9 +43,9 @@ exports.Option = Option;
function Option(flags, description) {
this.flags = flags;
- this.required = ~flags.indexOf('<');
- this.optional = ~flags.indexOf('[');
- this.bool = !~flags.indexOf('-no-');
+ this.required = flags.indexOf('<') >= 0;
+ this.optional = flags.indexOf('[') >= 0;
+ this.bool = flags.indexOf('-no-') === -1;
flags = flags.split(/[ ,|]+/);
if (flags.length > 1 && !/^[[<]/.test(flags[1])) this.short = flags.shift();
this.long = flags.shift();
@@ -60,6 +66,18 @@ Option.prototype.name = function() {
};
/**
+ * Return option name, in a camelcase format that can be used
+ * as a object attribute key.
+ *
+ * @return {String}
+ * @api private
+ */
+
+Option.prototype.attributeName = function() {
+ return camelcase(this.name());
+};
+
+/**
* Check if `arg` matches the short or long flag.
*
* @param {String} arg
@@ -68,7 +86,7 @@ Option.prototype.name = function() {
*/
Option.prototype.is = function(arg) {
- return arg == this.short || arg == this.long;
+ return this.short === arg || this.long === arg;
};
/**
@@ -88,12 +106,6 @@ function Command(name) {
}
/**
- * Inherit from `EventEmitter.prototype`.
- */
-
-Command.prototype.__proto__ = EventEmitter.prototype;
-
-/**
* Add command `name`.
*
* The `.action()` callback is invoked when the
@@ -155,6 +167,10 @@ Command.prototype.__proto__ = EventEmitter.prototype;
*/
Command.prototype.command = function(name, desc, opts) {
+ if (typeof desc === 'object' && desc !== null) {
+ opts = desc;
+ desc = null;
+ }
opts = opts || {};
var args = name.split(/ +/);
var cmd = new Command(args.shift());
@@ -165,7 +181,6 @@ Command.prototype.command = function(name, desc, opts) {
this._execs[cmd._name] = true;
if (opts.isDefault) this.defaultExecutable = cmd._name;
}
-
cmd._noHelp = !!opts.noHelp;
this.commands.push(cmd);
cmd.parseExpectedArgs(args);
@@ -181,7 +196,7 @@ Command.prototype.command = function(name, desc, opts) {
* @api public
*/
-Command.prototype.arguments = function (desc) {
+Command.prototype.arguments = function(desc) {
return this.parseExpectedArgs(desc.split(/ +/));
};
@@ -277,7 +292,7 @@ Command.prototype.action = function(fn) {
if (parsed.args.length) args = parsed.args.concat(args);
self._args.forEach(function(arg, i) {
- if (arg.required && null == args[i]) {
+ if (arg.required && args[i] == null) {
self.missingArgument(arg.name);
} else if (arg.variadic) {
if (i !== self._args.length - 1) {
@@ -356,32 +371,34 @@ Command.prototype.action = function(fn) {
*/
Command.prototype.option = function(flags, description, fn, defaultValue) {
- var self = this
- , option = new Option(flags, description)
- , oname = option.name()
- , name = camelcase(oname);
+ var self = this,
+ option = new Option(flags, description),
+ oname = option.name(),
+ name = option.attributeName();
// default as 3rd arg
- if (typeof fn != 'function') {
+ if (typeof fn !== 'function') {
if (fn instanceof RegExp) {
var regex = fn;
fn = function(val, def) {
var m = regex.exec(val);
return m ? m[0] : def;
- }
- }
- else {
+ };
+ } else {
defaultValue = fn;
fn = null;
}
}
// preassign default value only for --no-*, [optional], or <required>
- if (false == option.bool || option.optional || option.required) {
+ if (!option.bool || option.optional || option.required) {
// when --no-* we make sure default is true
- if (false == option.bool) defaultValue = true;
+ if (!option.bool) defaultValue = true;
// preassign only if we have a default
- if (undefined !== defaultValue) self[name] = defaultValue;
+ if (defaultValue !== undefined) {
+ self[name] = defaultValue;
+ option.defaultValue = defaultValue;
+ }
}
// register the option
@@ -391,21 +408,21 @@ Command.prototype.option = function(flags, description, fn, defaultValue) {
// and conditionally invoke the callback
this.on('option:' + oname, function(val) {
// coercion
- if (null !== val && fn) val = fn(val, undefined === self[name]
- ? defaultValue
- : self[name]);
+ if (val !== null && fn) {
+ val = fn(val, self[name] === undefined ? defaultValue : self[name]);
+ }
// unassigned or bool
- if ('boolean' == typeof self[name] || 'undefined' == typeof self[name]) {
+ if (typeof self[name] === 'boolean' || typeof self[name] === 'undefined') {
// if no value, bool true, and we have a default, then use it!
- if (null == val) {
+ if (val == null) {
self[name] = option.bool
? defaultValue || true
: false;
} else {
self[name] = val;
}
- } else if (null !== val) {
+ } else if (val !== null) {
// reassign
self[name] = val;
}
@@ -422,8 +439,8 @@ Command.prototype.option = function(flags, description, fn, defaultValue) {
* @api public
*/
Command.prototype.allowUnknownOption = function(arg) {
- this._allowUnknownOption = arguments.length === 0 || arg;
- return this;
+ this._allowUnknownOption = arguments.length === 0 || arg;
+ return this;
};
/**
@@ -467,7 +484,7 @@ Command.prototype.parse = function(argv) {
})[0];
}
- if (this._execs[name] && typeof this._execs[name] != "function") {
+ if (this._execs[name] && typeof this._execs[name] !== 'function') {
return this.executeSubCommand(argv, args, parsed.unknown);
} else if (aliasCommand) {
// is alias of a subCommand
@@ -495,10 +512,10 @@ Command.prototype.executeSubCommand = function(argv, args, unknown) {
args = args.concat(unknown);
if (!args.length) this.help();
- if ('help' == args[0] && 1 == args.length) this.help();
+ if (args[0] === 'help' && args.length === 1) this.help();
// <cmd> --help
- if ('help' == args[0]) {
+ if (args[0] === 'help') {
args[0] = args[1];
args[1] = '--help';
}
@@ -508,15 +525,14 @@ Command.prototype.executeSubCommand = function(argv, args, unknown) {
// name of the subcommand, link `pm-install`
var bin = basename(f, '.js') + '-' + args[0];
-
// In case of globally installed, get the base dir where executable
// subcommand file should be located at
- var baseDir
- , link = fs.lstatSync(f).isSymbolicLink() ? fs.readlinkSync(f) : f;
+ var baseDir,
+ link = fs.lstatSync(f).isSymbolicLink() ? fs.readlinkSync(f) : f;
// when symbolink is relative path
if (link !== f && link.charAt(0) !== '/') {
- link = path.join(dirname(f), link)
+ link = path.join(dirname(f), link);
}
baseDir = dirname(link);
@@ -541,28 +557,28 @@ Command.prototype.executeSubCommand = function(argv, args, unknown) {
// add executable arguments to spawn
args = (process.execArgv || []).concat(args);
- proc = spawn('node', args, { stdio: 'inherit', customFds: [0, 1, 2] });
+ proc = spawn(process.argv[0], args, { stdio: 'inherit', customFds: [0, 1, 2] });
} else {
proc = spawn(bin, args, { stdio: 'inherit', customFds: [0, 1, 2] });
}
} else {
args.unshift(bin);
- proc = spawn(process.execPath, args, { stdio: 'inherit'});
+ proc = spawn(process.execPath, args, { stdio: 'inherit' });
}
var signals = ['SIGUSR1', 'SIGUSR2', 'SIGTERM', 'SIGINT', 'SIGHUP'];
signals.forEach(function(signal) {
- process.on(signal, function(){
- if ((proc.killed === false) && (proc.exitCode === null)){
+ process.on(signal, function() {
+ if (proc.killed === false && proc.exitCode === null) {
proc.kill(signal);
}
});
});
proc.on('close', process.exit.bind(process));
proc.on('error', function(err) {
- if (err.code == "ENOENT") {
+ if (err.code === 'ENOENT') {
console.error('\n %s(1) does not exist, try --help\n', bin);
- } else if (err.code == "EACCES") {
+ } else if (err.code === 'EACCES') {
console.error('\n %s(1) not executable. try chmod or run with root\n', bin);
}
process.exit(1);
@@ -583,15 +599,15 @@ Command.prototype.executeSubCommand = function(argv, args, unknown) {
*/
Command.prototype.normalize = function(args) {
- var ret = []
- , arg
- , lastOpt
- , index;
+ var ret = [],
+ arg,
+ lastOpt,
+ index;
for (var i = 0, len = args.length; i < len; ++i) {
arg = args[i];
if (i > 0) {
- lastOpt = this.optionFor(args[i-1]);
+ lastOpt = this.optionFor(args[i - 1]);
}
if (arg === '--') {
@@ -600,7 +616,7 @@ Command.prototype.normalize = function(args) {
break;
} else if (lastOpt && lastOpt.required) {
ret.push(arg);
- } else if (arg.length > 1 && '-' == arg[0] && '-' != arg[1]) {
+ } else if (arg.length > 1 && arg[0] === '-' && arg[1] !== '-') {
arg.slice(1).split('').forEach(function(c) {
ret.push('-' + c);
});
@@ -644,6 +660,10 @@ Command.prototype.parseArgs = function(args, unknown) {
if (unknown.length > 0) {
this.unknownOption(unknown[0]);
}
+ if (this.commands.length === 0 &&
+ this._args.filter(function(a) { return a.required }).length === 0) {
+ this.emit('command:*');
+ }
}
return this;
@@ -675,11 +695,11 @@ Command.prototype.optionFor = function(arg) {
*/
Command.prototype.parseOptions = function(argv) {
- var args = []
- , len = argv.length
- , literal
- , option
- , arg;
+ var args = [],
+ len = argv.length,
+ literal,
+ option,
+ arg;
var unknownOptions = [];
@@ -693,7 +713,7 @@ Command.prototype.parseOptions = function(argv) {
continue;
}
- if ('--' == arg) {
+ if (arg === '--') {
literal = true;
continue;
}
@@ -706,12 +726,12 @@ Command.prototype.parseOptions = function(argv) {
// requires arg
if (option.required) {
arg = argv[++i];
- if (null == arg) return this.optionMissingArgument(option);
+ if (arg == null) return this.optionMissingArgument(option);
this.emit('option:' + option.name(), arg);
// optional arg
} else if (option.optional) {
- arg = argv[i+1];
- if (null == arg || ('-' == arg[0] && '-' != arg)) {
+ arg = argv[i + 1];
+ if (arg == null || (arg[0] === '-' && arg !== '-')) {
arg = null;
} else {
++i;
@@ -725,13 +745,13 @@ Command.prototype.parseOptions = function(argv) {
}
// looks like an option
- if (arg.length > 1 && '-' == arg[0]) {
+ if (arg.length > 1 && arg[0] === '-') {
unknownOptions.push(arg);
// If the next argument looks like it might be
// an argument for this option, we pass it on.
// If it isn't, then it'll simply be ignored
- if (argv[i+1] && '-' != argv[i+1][0]) {
+ if ((i + 1) < argv.length && argv[i + 1][0] !== '-') {
unknownOptions.push(argv[++i]);
}
continue;
@@ -751,12 +771,12 @@ Command.prototype.parseOptions = function(argv) {
* @api public
*/
Command.prototype.opts = function() {
- var result = {}
- , len = this.options.length;
+ var result = {},
+ len = this.options.length;
- for (var i = 0 ; i < len; i++) {
- var key = camelcase(this.options[i].name());
- result[key] = key === 'version' ? this._version : this[key];
+ for (var i = 0; i < len; i++) {
+ var key = this.options[i].attributeName();
+ result[key] = key === this._versionOptionName ? this._version : this[key];
}
return result;
};
@@ -836,11 +856,13 @@ Command.prototype.variadicArgNotLast = function(name) {
*/
Command.prototype.version = function(str, flags) {
- if (0 == arguments.length) return this._version;
+ if (arguments.length === 0) return this._version;
this._version = str;
flags = flags || '-V, --version';
- this.option(flags, 'output the version number');
- this.on('option:version', function() {
+ var versionOption = new Option(flags, 'output the version number');
+ this._versionOptionName = versionOption.long.substr(2) || 'version';
+ this.options.push(versionOption);
+ this.on('option:' + this._versionOptionName, function() {
process.stdout.write(str + '\n');
process.exit(0);
});
@@ -851,13 +873,15 @@ Command.prototype.version = function(str, flags) {
* Set the description to `str`.
*
* @param {String} str
+ * @param {Object} argsDescription
* @return {String|Command}
* @api public
*/
-Command.prototype.description = function(str) {
- if (0 === arguments.length) return this._description;
+Command.prototype.description = function(str, argsDescription) {
+ if (arguments.length === 0) return this._description;
this._description = str;
+ this._argsDescription = argsDescription;
return this;
};
@@ -871,12 +895,14 @@ Command.prototype.description = function(str) {
Command.prototype.alias = function(alias) {
var command = this;
- if(this.commands.length !== 0) {
- command = this.commands[this.commands.length - 1]
+ if (this.commands.length !== 0) {
+ 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;
return this;
};
@@ -894,11 +920,11 @@ Command.prototype.usage = function(str) {
return humanReadableArgName(arg);
});
- var usage = '[options]'
- + (this.commands.length ? ' [command]' : '')
- + (this._args.length ? ' ' + args.join(' ') : '');
+ var usage = '[options]' +
+ (this.commands.length ? ' [command]' : '') +
+ (this._args.length ? ' ' + args.join(' ') : '');
- if (0 == arguments.length) return this._usage || usage;
+ if (arguments.length === 0) return this._usage || usage;
this._usage = str;
return this;
@@ -913,12 +939,51 @@ Command.prototype.usage = function(str) {
*/
Command.prototype.name = function(str) {
- if (0 === arguments.length) return this._name;
+ if (arguments.length === 0) return this._name;
this._name = str;
return this;
};
/**
+ * Return prepared commands.
+ *
+ * @return {Array}
+ * @api private
+ */
+
+Command.prototype.prepareCommands = function() {
+ return this.commands.filter(function(cmd) {
+ return !cmd._noHelp;
+ }).map(function(cmd) {
+ var args = cmd._args.map(function(arg) {
+ return humanReadableArgName(arg);
+ }).join(' ');
+
+ return [
+ cmd._name +
+ (cmd._alias ? '|' + cmd._alias : '') +
+ (cmd.options.length ? ' [options]' : '') +
+ (args ? ' ' + args : ''),
+ cmd._description
+ ];
+ });
+};
+
+/**
+ * Return the largest command length.
+ *
+ * @return {Number}
+ * @api private
+ */
+
+Command.prototype.largestCommandLength = function() {
+ var commands = this.prepareCommands();
+ return commands.reduce(function(max, command) {
+ return Math.max(max, command[0].length);
+ }, 0);
+};
+
+/**
* Return the largest option length.
*
* @return {Number}
@@ -926,12 +991,53 @@ Command.prototype.name = function(str) {
*/
Command.prototype.largestOptionLength = function() {
- return this.options.reduce(function(max, option) {
+ var options = [].slice.call(this.options);
+ options.push({
+ flags: '-h, --help'
+ });
+ return options.reduce(function(max, option) {
return Math.max(max, option.flags.length);
}, 0);
};
/**
+ * Return the largest arg length.
+ *
+ * @return {Number}
+ * @api private
+ */
+
+Command.prototype.largestArgLength = function() {
+ return this._args.reduce(function(max, arg) {
+ return Math.max(max, arg.name.length);
+ }, 0);
+};
+
+/**
+ * Return the pad width.
+ *
+ * @return {Number}
+ * @api private
+ */
+
+Command.prototype.padWidth = function() {
+ var width = this.largestOptionLength();
+ if (this._argsDescription && this._args.length) {
+ if (this.largestArgLength() > width) {
+ width = this.largestArgLength();
+ }
+ }
+
+ if (this.commands && this.commands.length) {
+ if (this.largestCommandLength() > width) {
+ width = this.largestCommandLength();
+ }
+ }
+
+ return width;
+};
+
+/**
* Return help for options.
*
* @return {String}
@@ -939,12 +1045,13 @@ Command.prototype.largestOptionLength = function() {
*/
Command.prototype.optionHelp = function() {
- var width = this.largestOptionLength();
+ var width = this.padWidth();
// Append the help information
return this.options.map(function(option) {
- return pad(option.flags, width) + ' ' + option.description;
- }).concat([pad('-h, --help', width) + ' ' + 'output usage information'])
+ return pad(option.flags, width) + ' ' + option.description +
+ ((option.bool && option.defaultValue !== undefined) ? ' (default: ' + option.defaultValue + ')' : '');
+ }).concat([pad('-h, --help', width) + ' ' + 'output usage information'])
.join('\n');
};
@@ -958,35 +1065,17 @@ Command.prototype.optionHelp = function() {
Command.prototype.commandHelp = function() {
if (!this.commands.length) return '';
- var commands = this.commands.filter(function(cmd) {
- return !cmd._noHelp;
- }).map(function(cmd) {
- var args = cmd._args.map(function(arg) {
- return humanReadableArgName(arg);
- }).join(' ');
-
- return [
- cmd._name
- + (cmd._alias ? '|' + cmd._alias : '')
- + (cmd.options.length ? ' [options]' : '')
- + ' ' + args
- , cmd._description
- ];
- });
-
- var width = commands.reduce(function(max, command) {
- return Math.max(max, command[0].length);
- }, 0);
+ var commands = this.prepareCommands();
+ var width = this.padWidth();
return [
- ''
- , ' Commands:'
- , ''
- , commands.map(function(cmd) {
+ ' Commands:',
+ '',
+ commands.map(function(cmd) {
var desc = cmd[1] ? ' ' + cmd[1] : '';
- return pad(cmd[0], width) + desc;
- }).join('\n').replace(/^/gm, ' ')
- , ''
+ return (desc ? pad(cmd[0], width) : cmd[0]) + desc;
+ }).join('\n').replace(/^/gm, ' '),
+ ''
].join('\n');
};
@@ -1001,9 +1090,20 @@ Command.prototype.helpInformation = function() {
var desc = [];
if (this._description) {
desc = [
- ' ' + this._description
- , ''
+ ' ' + this._description,
+ ''
];
+
+ var argsDescription = this._argsDescription;
+ if (argsDescription && this._args.length) {
+ var width = this.padWidth();
+ desc.push(' Arguments:');
+ desc.push('');
+ this._args.forEach(function(arg) {
+ desc.push(' ' + pad(arg.name, width) + ' ' + argsDescription[arg.name]);
+ });
+ desc.push('');
+ }
}
var cmdName = this._name;
@@ -1011,9 +1111,9 @@ Command.prototype.helpInformation = function() {
cmdName = cmdName + '|' + this._alias;
}
var usage = [
+ '',
+ ' Usage: ' + cmdName + ' ' + this.usage(),
''
- ,' Usage: ' + cmdName + ' ' + this.usage()
- , ''
];
var cmds = [];
@@ -1021,17 +1121,17 @@ Command.prototype.helpInformation = function() {
if (commandHelp) cmds = [commandHelp];
var options = [
+ ' Options:',
+ '',
+ '' + this.optionHelp().replace(/^/gm, ' '),
''
- , ' Options:'
- , ''
- , '' + this.optionHelp().replace(/^/gm, ' ')
- , ''
];
return usage
.concat(desc)
.concat(options)
.concat(cmds)
+ .concat([''])
.join('\n');
};
@@ -1045,7 +1145,7 @@ Command.prototype.outputHelp = function(cb) {
if (!cb) {
cb = function(passthru) {
return passthru;
- }
+ };
}
process.stdout.write(cb(this.helpInformation()));
this.emit('--help');
@@ -1101,7 +1201,7 @@ function pad(str, width) {
function outputHelpIfNecessary(cmd, options) {
options = options || [];
for (var i = 0; i < options.length; i++) {
- if (options[i] == '--help' || options[i] == '-h') {
+ if (options[i] === '--help' || options[i] === '-h') {
cmd.outputHelp();
process.exit(0);
}
@@ -1121,7 +1221,7 @@ function humanReadableArgName(arg) {
return arg.required
? '<' + nameOutput + '>'
- : '[' + nameOutput + ']'
+ : '[' + nameOutput + ']';
}
// for versions before node v0.8 when there weren't `fs.existsSync`
@@ -1134,4 +1234,3 @@ function exists(file) {
return false;
}
}
-
diff --git a/node_modules/commander/package.json b/node_modules/commander/package.json
index 708f223a2..d3a1b24b5 100644
--- a/node_modules/commander/package.json
+++ b/node_modules/commander/package.json
@@ -1,6 +1,6 @@
{
"name": "commander",
- "version": "2.11.0",
+ "version": "2.17.1",
"description": "the complete solution for node.js command-line programs",
"keywords": [
"commander",
@@ -14,16 +14,24 @@
"type": "git",
"url": "https://github.com/tj/commander.js.git"
},
- "devDependencies": {
- "should": "^11.2.1",
- "sinon": "^2.3.5"
- },
"scripts": {
- "test": "make test"
+ "lint": "eslint index.js",
+ "test": "node test/run.js && npm run test-typings",
+ "test-typings": "tsc -p tsconfig.json"
},
"main": "index",
"files": [
- "index.js"
+ "index.js",
+ "typings/index.d.ts"
],
- "dependencies": {}
+ "dependencies": {},
+ "devDependencies": {
+ "@types/node": "^10.5.7",
+ "eslint": "^5.3.0",
+ "should": "^13.2.3",
+ "sinon": "^6.1.4",
+ "standard": "^11.0.1",
+ "typescript": "^2.9.2"
+ },
+ "typings": "typings/index.d.ts"
}