commander 2.5.0 → 2.5.1

package/Readme.md

@@ -4,7 +4,8 @@
 [![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).
+  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/)
 
 
 ## Installation
@@ -73,6 +74,23 @@ 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:
@@ -152,7 +170,7 @@ console.log(' args: %j', program.args);
  * Module dependencies.
  */
 
-var program = require('../');
+var program = require('commander');
 
 program
   .version('0.0.1')
@@ -176,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:
 
 ```
 
@@ -207,7 +225,6 @@ Examples:
 
 ## Links
 
- - [API documentation](http://tj.github.com/commander.js/)
  - [ascii tables](https://github.com/LearnBoost/cli-table)
  - [progress bars](https://github.com/tj/node-progress)
  - [more progress bars](https://github.com/substack/node-multimeter)

package/index.js

@@ -148,7 +148,7 @@ Command.prototype.__proto__ = EventEmitter.prototype;
  *      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
  */
@@ -156,12 +156,17 @@ Command.prototype.__proto__ = EventEmitter.prototype;
 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;
 };
@@ -207,11 +212,10 @@ Command.prototype.parseExpectedArgs = function(args) {
         break;
     }
 
-    if (argDetails.name.indexOf('...') === argDetails.name.length - 3) {
+    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);
     }
@@ -266,7 +270,7 @@ Command.prototype.action = function(fn) {
           self.variadicArgNotLast(arg.name);
         }
 
-        args[i] = args.slice(i);
+        args[i] = args.splice(i);
       }
     });
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "commander"
-  , "version": "2.5.0"
+  , "version": "2.5.1"
   , "description": "the complete solution for node.js command-line programs"
   , "keywords": ["command", "option", "parser", "prompt"]
   , "author": "TJ Holowaychuk <tj@vision-media.ca>"