commander 2.2.0 → 2.5.1

package/Readme.md

@@ -1,8 +1,12 @@
 # Commander.js
 
-  The complete solution for [node.js](http://nodejs.org) command-line interfaces, inspired by Ruby's [commander](https://github.com/visionmedia/commander).
+ [![Build Status](https://api.travis-ci.org/tj/commander.js.svg)](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)
+
+  The complete solution for [node.js](http://nodejs.org) command-line interfaces, inspired by Ruby's [commander](https://github.com/tj/commander).  
+  API documentation: [http://tj.github.com/commander.js/](http://tj.github.com/commander.js/)
 
- [![Build Status](https://secure.travis-ci.org/visionmedia/commander.js.png)](http://travis-ci.org/visionmedia/commander.js)
 
 ## Installation
 
@@ -38,6 +42,55 @@ 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.
 
+## Variadic arguments
+
+ The last argument of a command can be variadic, and only the last argument.  To make an argument variadic you have to
+ append `...` to the argument name.  Here is an example:
+
+```js
+#!/usr/bin/env node
+
+/**
+ * Module dependencies.
+ */
+
+var program = require('commander');
+
+program
+  .version('0.0.1')
+  .command('rmdir <dir> [otherDirs...]')
+  .action(function (dir, otherDirs) {
+    console.log('rmdir %s', dir);
+    if (otherDirs) {
+      otherDirs.forEach(function (oDir) {
+        console.log('rmdir %s', oDir);
+      });
+    }
+  });
+
+program.parse(process.argv);
+```
+
+ An `Array` is used for the value of a variadic argument.  This applies to `program.args` as well as the argument passed
+ to your action as demonstrated above.
+
+## Git-style sub-commands
+
+```js
+// file: ./examples/pm
+var program = require('..');
+
+program
+  .version('0.0.1')
+  .command('install [name]', 'install one or more packages')
+  .command('search [query]', 'search with optional query')
+  .command('list', 'list packages installed')
+  .parse(process.argv);
+```
+
+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 find the executable script in __current directory__ with the name `scriptBasename-subcommand`, like `pm-install`, `pm-search`.
+
 ## Automated --help
 
  The help information is auto-generated based on the information commander already knows about your program, so the following `--help` info is for free:
@@ -86,7 +139,7 @@ program
   .option('-r, --range <a>..<b>', 'A range', range)
   .option('-l, --list <items>', 'A list', list)
   .option('-o, --optional [value]', 'An optional value')
-  .option('-c, --collect [value]', 'A repeatable value', [])
+  .option('-c, --collect [value]', 'A repeatable value', collect, [])
   .option('-v, --verbose', 'A value that can be increased', increaseVerbosity, 0)
   .parse(process.argv);
 
@@ -117,11 +170,7 @@ console.log(' args: %j', program.args);
  * Module dependencies.
  */
 
-var program = require('../');
-
-function list(val) {
-  return val.split(',').map(Number);
-}
+var program = require('commander');
 
 program
   .version('0.0.1')
@@ -145,7 +194,7 @@ program.parse(process.argv);
 console.log('stuff');
 ```
 
-yielding the following help output:
+Yields the following help output when `node script-name.js -h` or `node script-name.js --help` are run:
 
 ```
 
@@ -176,13 +225,12 @@ Examples:
 
 ## Links
 
- - [API documentation](http://visionmedia.github.com/commander.js/)
  - [ascii tables](https://github.com/LearnBoost/cli-table)
- - [progress bars](https://github.com/visionmedia/node-progress)
+ - [progress bars](https://github.com/tj/node-progress)
  - [more progress bars](https://github.com/substack/node-multimeter)
- - [examples](https://github.com/visionmedia/commander.js/tree/master/examples)
+ - [examples](https://github.com/tj/commander.js/tree/master/examples)
 
-## License 
+## License
 
 (The MIT License)
 

package/index.js

@@ -5,8 +5,6 @@
 
 var EventEmitter = require('events').EventEmitter;
 var spawn = require('child_process').spawn;
-var fs = require('fs');
-var exists = fs.existsSync;
 var path = require('path');
 var dirname = path.dirname;
 var basename = path.basename;
@@ -15,7 +13,7 @@ var basename = path.basename;
  * Expose the root command.
  */
 
-exports = module.exports = new Command;
+exports = module.exports = new Command();
 
 /**
  * Expose `Command`.
@@ -55,7 +53,7 @@ function Option(flags, description) {
  * @api private
  */
 
-Option.prototype.name = function(){
+Option.prototype.name = function() {
   return this.long
     .replace('--', '')
     .replace('no-', '');
@@ -69,9 +67,8 @@ Option.prototype.name = function(){
  * @api private
  */
 
-Option.prototype.is = function(arg){
-  return arg == this.short
-    || arg == this.long;
+Option.prototype.is = function(arg) {
+  return arg == this.short || arg == this.long;
 };
 
 /**
@@ -118,41 +115,58 @@ Command.prototype.__proto__ = EventEmitter.prototype;
  *      program
  *        .command('setup')
  *        .description('run remote setup commands')
- *        .action(function(){
+ *        .action(function() {
  *          console.log('setup');
  *        });
  *
  *      program
  *        .command('exec <cmd>')
  *        .description('run the given remote command')
- *        .action(function(cmd){
+ *        .action(function(cmd) {
  *          console.log('exec "%s"', cmd);
  *        });
  *
  *      program
+ *        .command('teardown <dir> [otherDirs...]')
+ *        .description('run teardown commands')
+ *        .action(function(dir, otherDirs) {
+ *          console.log('dir "%s"', dir);
+ *          if (otherDirs) {
+ *            otherDirs.forEach(function (oDir) {
+ *              console.log('dir "%s"', oDir);
+ *            });
+ *          }
+ *        });
+ *
+ *      program
  *        .command('*')
  *        .description('deploy the given env')
- *        .action(function(env){
+ *        .action(function(env) {
  *          console.log('deploying "%s"', env);
  *        });
  *
  *      program.parse(process.argv);
   *
  * @param {String} name
- * @param {String} [desc]
+ * @param {String} [desc] for git-style sub-commands
  * @return {Command} the new command
  * @api public
  */
 
-Command.prototype.command = function(name, desc){
+Command.prototype.command = function(name, desc) {
   var args = name.split(/ +/);
   var cmd = new Command(args.shift());
-  if (desc) cmd.description(desc);
-  if (desc) this.executables = true;
-  if (desc) this._execs[cmd._name] = true;
+
+  if (desc) {
+    cmd.description(desc);
+    this.executables = true;
+    this._execs[cmd._name] = true;
+  }
+
   this.commands.push(cmd);
   cmd.parseExpectedArgs(args);
   cmd.parent = this;
+
   if (desc) return this;
   return cmd;
 };
@@ -178,18 +192,33 @@ Command.prototype.addImplicitHelpCommand = function() {
  * @api public
  */
 
-Command.prototype.parseExpectedArgs = function(args){
+Command.prototype.parseExpectedArgs = function(args) {
   if (!args.length) return;
   var self = this;
-  args.forEach(function(arg){
+  args.forEach(function(arg) {
+    var argDetails = {
+      required: false,
+      name: '',
+      variadic: false
+    };
+
     switch (arg[0]) {
       case '<':
-        self._args.push({ required: true, name: arg.slice(1, -1) });
+        argDetails.required = true;
+        argDetails.name = arg.slice(1, -1);
         break;
       case '[':
-        self._args.push({ required: false, name: arg.slice(1, -1) });
+        argDetails.name = arg.slice(1, -1);
         break;
     }
+
+    if (argDetails.name.length > 3 && argDetails.name.slice(-3) === '...') {
+      argDetails.variadic = true;
+      argDetails.name = argDetails.name.slice(0, -3);
+    }
+    if (argDetails.name) {
+      self._args.push(argDetails);
+    }
   });
   return this;
 };
@@ -202,7 +231,7 @@ Command.prototype.parseExpectedArgs = function(args){
  *      program
  *        .command('help')
  *        .description('display verbose help')
- *        .action(function(){
+ *        .action(function() {
  *           // output help here
  *        });
  *
@@ -211,11 +240,13 @@ Command.prototype.parseExpectedArgs = function(args){
  * @api public
  */
 
-Command.prototype.action = function(fn){
+Command.prototype.action = function(fn) {
   var self = this;
-  this.parent.on(this._name, function(args, unknown){
+  var listener = function(args, unknown) {
     // Parse any so-far unknown options
+    args = args || [];
     unknown = unknown || [];
+
     var parsed = self.parseOptions(unknown);
 
     // Output help if necessary
@@ -231,9 +262,15 @@ Command.prototype.action = function(fn){
     // Leftover arguments need to be pushed back. Fixes issue #56
     if (parsed.args.length) args = parsed.args.concat(args);
 
-    self._args.forEach(function(arg, i){
+    self._args.forEach(function(arg, i) {
       if (arg.required && null == args[i]) {
         self.missingArgument(arg.name);
+      } else if (arg.variadic) {
+        if (i !== self._args.length - 1) {
+          self.variadicArgNotLast(arg.name);
+        }
+
+        args[i] = args.splice(i);
       }
     });
 
@@ -246,8 +283,10 @@ Command.prototype.action = function(fn){
       args.push(self);
     }
 
-    fn.apply(this, args);
-  });
+    fn.apply(self, args);
+  };
+  this.parent.on(this._name, listener);
+  if (this._alias) this.parent.on(this._alias, listener);
   return this;
 };
 
@@ -272,7 +311,7 @@ Command.prototype.action = function(fn){
  *     program.pepper
  *     // => Boolean
  *
- *     // simple boolean defaulting to false
+ *     // simple boolean defaulting to true
  *     program.option('-C, --no-cheese', 'remove cheese');
  *
  *     program.cheese
@@ -280,7 +319,7 @@ Command.prototype.action = function(fn){
  *
  *     --no-cheese
  *     program.cheese
- *     // => true
+ *     // => false
  *
  *     // required argument
  *     program.option('-C, --chdir <path>', 'change the working directory');
@@ -300,14 +339,17 @@ Command.prototype.action = function(fn){
  * @api public
  */
 
-Command.prototype.option = function(flags, description, fn, defaultValue){
+Command.prototype.option = function(flags, description, fn, defaultValue) {
   var self = this
     , option = new Option(flags, description)
     , oname = option.name()
     , name = camelcase(oname);
 
   // default as 3rd arg
-  if ('function' != typeof fn) defaultValue = fn, fn = null;
+  if (typeof fn != 'function') {
+    defaultValue = fn;
+    fn = null;
+  }
 
   // preassign default value only for --no-*, [optional], or <required>
   if (false == option.bool || option.optional || option.required) {
@@ -322,9 +364,11 @@ Command.prototype.option = function(flags, description, fn, defaultValue){
 
   // when it's passed assign the value
   // and conditionally invoke the callback
-  this.on(oname, function(val){
+  this.on(oname, function(val) {
     // coercion
-    if (null !== val && fn) val = fn(val, undefined === self[name] ? defaultValue : self[name]);
+    if (null !== val && fn) val = fn(val, undefined === self[name]
+      ? defaultValue
+      : self[name]);
 
     // unassigned or bool
     if ('boolean' == typeof self[name] || 'undefined' == typeof self[name]) {
@@ -353,7 +397,7 @@ Command.prototype.option = function(flags, description, fn, defaultValue){
  * @api public
  */
 
-Command.prototype.parse = function(argv){
+Command.prototype.parse = function(argv) {
   // implicit help
   if (this.executables) this.addImplicitHelpCommand();
 
@@ -371,7 +415,9 @@ Command.prototype.parse = function(argv){
 
   // executable sub-commands
   var name = result.args[0];
-  if (this._execs[name]) return this.executeSubCommand(argv, args, parsed.unknown);
+  if (this._execs[name] && typeof this._execs[name] != "function") {
+    return this.executeSubCommand(argv, args, parsed.unknown);
+  }
 
   return result;
 };
@@ -408,7 +454,7 @@ Command.prototype.executeSubCommand = function(argv, args, unknown) {
   args = args.slice(1);
   args.unshift(local);
   var proc = spawn('node', args, { stdio: 'inherit', customFds: [0, 1, 2] });
-  proc.on('error', function(err){
+  proc.on('error', function(err) {
     if (err.code == "ENOENT") {
       console.error('\n  %s(1) does not exist, try --help\n', bin);
     } else if (err.code == "EACCES") {
@@ -429,7 +475,7 @@ Command.prototype.executeSubCommand = function(argv, args, unknown) {
  * @api private
  */
 
-Command.prototype.normalize = function(args){
+Command.prototype.normalize = function(args) {
   var ret = []
     , arg
     , lastOpt
@@ -437,12 +483,18 @@ Command.prototype.normalize = function(args){
 
   for (var i = 0, len = args.length; i < len; ++i) {
     arg = args[i];
-    i > 0 && (lastOpt = this.optionFor(args[i-1]));
+    if (i > 0) {
+      lastOpt = this.optionFor(args[i-1]);
+    }
 
-    if (lastOpt && lastOpt.required) {
-     	ret.push(arg);
+    if (arg === '--') {
+      // Honor option terminator
+      ret = ret.concat(args.slice(i));
+      break;
+    } else if (lastOpt && lastOpt.required) {
+      ret.push(arg);
     } else if (arg.length > 1 && '-' == arg[0] && '-' != arg[1]) {
-      arg.slice(1).split('').forEach(function(c){
+      arg.slice(1).split('').forEach(function(c) {
         ret.push('-' + c);
       });
     } else if (/^--/.test(arg) && ~(index = arg.indexOf('='))) {
@@ -467,10 +519,8 @@ Command.prototype.normalize = function(args){
  * @api private
  */
 
-Command.prototype.parseArgs = function(args, unknown){
-  var cmds = this.commands
-    , len = cmds.length
-    , name;
+Command.prototype.parseArgs = function(args, unknown) {
+  var name;
 
   if (args.length) {
     name = args[0];
@@ -500,7 +550,7 @@ Command.prototype.parseArgs = function(args, unknown){
  * @api private
  */
 
-Command.prototype.optionFor = function(arg){
+Command.prototype.optionFor = function(arg) {
   for (var i = 0, len = this.options.length; i < len; ++i) {
     if (this.options[i].is(arg)) {
       return this.options[i];
@@ -517,7 +567,7 @@ Command.prototype.optionFor = function(arg){
  * @api public
  */
 
-Command.prototype.parseOptions = function(argv){
+Command.prototype.parseOptions = function(argv) {
   var args = []
     , len = argv.length
     , literal
@@ -587,6 +637,23 @@ Command.prototype.parseOptions = function(argv){
   return { args: args, unknown: unknownOptions };
 };
 
+/**
+ * Return an object containing options as key-value pairs
+ *
+ * @return {Object}
+ * @api public
+ */
+Command.prototype.opts = function() {
+  var result = {}
+    , len = this.options.length;
+
+  for (var i = 0 ; i < len; i++) {
+    var key = this.options[i].name();
+    result[key] = key === 'version' ? this._version : this[key];
+  }
+  return result;
+};
+
 /**
  * Argument `name` is missing.
  *
@@ -594,7 +661,7 @@ Command.prototype.parseOptions = function(argv){
  * @api private
  */
 
-Command.prototype.missingArgument = function(name){
+Command.prototype.missingArgument = function(name) {
   console.error();
   console.error("  error: missing required argument `%s'", name);
   console.error();
@@ -609,7 +676,7 @@ Command.prototype.missingArgument = function(name){
  * @api private
  */
 
-Command.prototype.optionMissingArgument = function(option, flag){
+Command.prototype.optionMissingArgument = function(option, flag) {
   console.error();
   if (flag) {
     console.error("  error: option `%s' argument missing, got `%s'", option.flags, flag);
@@ -627,13 +694,26 @@ Command.prototype.optionMissingArgument = function(option, flag){
  * @api private
  */
 
-Command.prototype.unknownOption = function(flag){
+Command.prototype.unknownOption = function(flag) {
   console.error();
   console.error("  error: unknown option `%s'", flag);
   console.error();
   process.exit(1);
 };
 
+/**
+ * Variadic argument with `name` is not the last argument as required.
+ *
+ * @param {String} name
+ * @api private
+ */
+
+Command.prototype.variadicArgNotLast = function(name) {
+  console.error();
+  console.error("  error: variadic arguments must be last `%s'", name);
+  console.error();
+  process.exit(1);
+};
 
 /**
  * Set the program version to `str`.
@@ -647,32 +727,46 @@ Command.prototype.unknownOption = function(flag){
  * @api public
  */
 
-Command.prototype.version = function(str, flags){
+Command.prototype.version = function(str, flags) {
   if (0 == arguments.length) return this._version;
   this._version = str;
   flags = flags || '-V, --version';
   this.option(flags, 'output the version number');
-  this.on('version', function(){
-    console.log(str);
+  this.on('version', function() {
+    process.stdout.write(str + '\n');
     process.exit(0);
   });
   return this;
 };
 
 /**
- * Set the description `str`.
+ * Set the description to `str`.
  *
  * @param {String} str
  * @return {String|Command}
  * @api public
  */
 
-Command.prototype.description = function(str){
+Command.prototype.description = function(str) {
   if (0 == arguments.length) return this._description;
   this._description = str;
   return this;
 };
 
+/**
+ * Set an alias for the command
+ *
+ * @param {String} alias
+ * @return {String|Command}
+ * @api public
+ */
+
+Command.prototype.alias = function(alias) {
+  if (0 == arguments.length) return this._alias;
+  this._alias = alias;
+  return this;
+};
+
 /**
  * Set / get the command usage `str`.
  *
@@ -681,17 +775,14 @@ Command.prototype.description = function(str){
  * @api public
  */
 
-Command.prototype.usage = function(str){
-  var args = this._args.map(function(arg){
-    return arg.required
-      ? '<' + arg.name + '>'
-      : '[' + arg.name + ']';
+Command.prototype.usage = function(str) {
+  var args = this._args.map(function(arg) {
+    return humanReadableArgName(arg);
   });
 
-  var usage = '[options'
-    + (this.commands.length ? '] [command' : '')
-    + ']'
-    + (this._args.length ? ' ' + args : '');
+  var usage = '[options]'
+    + (this.commands.length ? ' [command]' : '')
+    + (this._args.length ? ' ' + args.join(' ') : '');
 
   if (0 == arguments.length) return this._usage || usage;
   this._usage = str;
@@ -699,6 +790,18 @@ Command.prototype.usage = function(str){
   return this;
 };
 
+/**
+ * Get the name of the command
+ *
+ * @param {String} name
+ * @return {String|Command}
+ * @api public
+ */
+
+Command.prototype.name = function(name) {
+  return this._name;
+};
+
 /**
  * Return the largest option length.
  *
@@ -706,8 +809,8 @@ Command.prototype.usage = function(str){
  * @api private
  */
 
-Command.prototype.largestOptionLength = function(){
-  return this.options.reduce(function(max, option){
+Command.prototype.largestOptionLength = function() {
+  return this.options.reduce(function(max, option) {
     return Math.max(max, option.flags.length);
   }, 0);
 };
@@ -719,14 +822,13 @@ Command.prototype.largestOptionLength = function(){
  * @api private
  */
 
-Command.prototype.optionHelp = function(){
+Command.prototype.optionHelp = function() {
   var width = this.largestOptionLength();
 
   // Prepend the help information
   return [pad('-h, --help', width) + '  ' + 'output usage information']
-    .concat(this.options.map(function(option){
-      return pad(option.flags, width)
-        + '  ' + option.description;
+    .concat(this.options.map(function(option) {
+      return pad(option.flags, width) + '  ' + option.description;
       }))
     .join('\n');
 };
@@ -738,26 +840,37 @@ Command.prototype.optionHelp = function(){
  * @api private
  */
 
-Command.prototype.commandHelp = function(){
+Command.prototype.commandHelp = function() {
   if (!this.commands.length) return '';
+
+  var commands = this.commands.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);
+
   return [
       ''
     , '  Commands:'
     , ''
-    , this.commands.map(function(cmd){
-      var args = cmd._args.map(function(arg){
-        return arg.required
-          ? '<' + arg.name + '>'
-          : '[' + arg.name + ']';
-      }).join(' ');
-
-      return pad(cmd._name
-        + (cmd.options.length
-          ? ' [options]'
-          : '') + ' ' + args, 22)
-        + (cmd.description()
-          ? ' ' + cmd.description()
-          : '');
+    , commands.map(function(cmd) {
+      return pad(cmd[0], width) + '  ' + cmd[1];
     }).join('\n').replace(/^/gm, '    ')
     , ''
   ].join('\n');
@@ -770,10 +883,14 @@ Command.prototype.commandHelp = function(){
  * @api private
  */
 
-Command.prototype.helpInformation = function(){
+Command.prototype.helpInformation = function() {
   return [
       ''
-    , '  Usage: ' + this._name + ' ' + this.usage()
+    , '  Usage: ' + this._name
+        + (this._alias
+          ? '|' + this._alias
+          : '')
+        + ' ' + this.usage()
     , '' + this.commandHelp()
     , '  Options:'
     , ''
@@ -789,7 +906,7 @@ Command.prototype.helpInformation = function(){
  * @api public
  */
 
-Command.prototype.outputHelp = function(){
+Command.prototype.outputHelp = function() {
   process.stdout.write(this.helpInformation());
   this.emit('--help');
 };
@@ -800,7 +917,7 @@ Command.prototype.outputHelp = function(){
  * @api public
  */
 
-Command.prototype.help = function(){
+Command.prototype.help = function() {
   this.outputHelp();
   process.exit();
 };
@@ -814,7 +931,7 @@ Command.prototype.help = function(){
  */
 
 function camelcase(flag) {
-  return flag.split('-').reduce(function(str, word){
+  return flag.split('-').reduce(function(str, word) {
     return str + word[0].toUpperCase() + word.slice(1);
   });
 }
@@ -850,3 +967,19 @@ function outputHelpIfNecessary(cmd, options) {
     }
   }
 }
+
+/**
+ * Takes an argument an returns its human readable equivalent for help usage.
+ *
+ * @param {Object} arg
+ * @return {String}
+ * @api private
+ */
+
+function humanReadableArgName(arg) {
+  var nameOutput = arg.name + (arg.variadic === true ? '...' : '');
+
+  return arg.required
+    ? '<' + nameOutput + '>'
+    : '[' + nameOutput + ']'
+}

package/package.json

@@ -1,10 +1,11 @@
 {
     "name": "commander"
-  , "version": "2.2.0"
+  , "version": "2.5.1"
   , "description": "the complete solution for node.js command-line programs"
-  , "keywords": ["command", "option", "parser", "prompt", "stdin"]
+  , "keywords": ["command", "option", "parser", "prompt"]
   , "author": "TJ Holowaychuk <tj@vision-media.ca>"
-  , "repository": { "type": "git", "url": "https://github.com/visionmedia/commander.js.git" }
+  , "license": "MIT"
+  , "repository": { "type": "git", "url": "https://github.com/tj/commander.js.git" }
   , "devDependencies": { "should": ">= 0.0.1" }
   , "scripts": { "test": "make test" }
   , "main": "index"