commander 1.1.0 → 1.3.1

package/History.md

@@ -1,4 +1,27 @@
 
+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 
 ==================
 

package/Readme.md

@@ -31,7 +31,7 @@ program
 
 console.log('you ordered a pizza with:');
 if (program.peppers) console.log('  - peppers');
-if (program.pineapple) console.log('  - pineappe');
+if (program.pineapple) console.log('  - pineapple');
 if (program.bbq) console.log('  - bbq');
 console.log('  - %s cheese', program.cheese);
 ```
@@ -51,7 +51,7 @@ console.log('  - %s cheese', program.cheese);
 
      -V, --version        output the version number
      -p, --peppers        Add peppers
-     -P, --pineapple      Add pineappe
+     -P, --pineapple      Add pineapple
      -b, --bbq            Add bbq sauce
      -c, --cheese <type>  Add the specified type of cheese [marble]
      -h, --help           output usage information
@@ -185,6 +185,12 @@ program.prompt('Birthdate: ', Date, function(date){
 });
 ```
 
+```js
+program.prompt('Email: ', /^.+@.+\..+$/, function(email){
+  console.log('email: %j', email);
+});
+```
+
 ## .password(msg[, mask], fn)
 
 Prompt for password without echoing:
@@ -267,4 +273,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/index.js

@@ -91,7 +91,7 @@ Option.prototype.is = function(arg){
 function Command(name) {
   this.commands = [];
   this.options = [];
-  this.args = [];
+  this._args = [];
   this._name = name;
 }
 
@@ -189,10 +189,10 @@ Command.prototype.parseExpectedArgs = function(args){
   args.forEach(function(arg){
     switch (arg[0]) {
       case '<':
-        self.args.push({ required: true, name: arg.slice(1, -1) });
+        self._args.push({ required: true, name: arg.slice(1, -1) });
         break;
       case '[':
-        self.args.push({ required: false, name: arg.slice(1, -1) });
+        self._args.push({ required: false, name: arg.slice(1, -1) });
         break;
     }
   });
@@ -236,7 +236,7 @@ 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);
       }
@@ -245,8 +245,8 @@ Command.prototype.action = function(fn){
     // Always append ourselves to the end of the arguments,
     // to make sure we match the number of arguments the user
     // expects
-    if (self.args.length) {
-      args[self.args.length] = self;
+    if (self._args.length) {
+      args[self._args.length] = self;
     } else {
       args.push(self);
     }
@@ -372,10 +372,12 @@ Command.prototype.parse = function(argv){
   var parsed = this.parseOptions(this.normalize(argv.slice(2)));
   var args = this.args = parsed.args;
  
+  var result = this.parseArgs(this.args, parsed.unknown);
+
   // executable sub-commands, skip .parseArgs()
   if (this.executables) return this.executeSubCommand(argv, args, parsed.unknown);
 
-  return this.parseArgs(this.args, parsed.unknown);
+  return result;
 };
 
 /**
@@ -405,16 +407,19 @@ Command.prototype.executeSubCommand = function(argv, args, unknown) {
 
   // check for ./<bin> first
   var local = path.join(dir, bin);
-  if (exists(local)) bin = local;
 
   // run it
   args = args.slice(1);
-  var proc = spawn(bin, args, { stdio: 'inherit', customFds: [0, 1, 2] });
-  proc.on('exit', function(code){
-    if (code == 127) {
-      console.error('\n  %s(1) does not exist\n', bin);
+  var proc = spawn(local, args, { stdio: 'inherit', customFds: [0, 1, 2] });
+  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") {
+      console.error('\n  %s(1) not executable. try chmod or run with root\n', bin);
     }
   });
+
+  this.runningCommand = proc;
 };
 
 /**
@@ -543,12 +548,12 @@ Command.prototype.parseOptions = function(argv){
       if (option.required) {
         arg = argv[++i];
         if (null == arg) return this.optionMissingArgument(option);
-        if ('-' == arg[0]) return this.optionMissingArgument(option, arg);
+        if ('-' == arg[0] && '-' != arg) return this.optionMissingArgument(option, arg);
         this.emit(option.name(), arg);
       // optional arg
       } else if (option.optional) {
         arg = argv[i+1];
-        if (null == arg || '-' == arg[0]) {
+        if (null == arg || ('-' == arg[0] && '-' != arg)) {
           arg = null;
         } else {
           ++i;
@@ -676,7 +681,7 @@ Command.prototype.description = function(str){
  */
 
 Command.prototype.usage = function(str){
-  var args = this.args.map(function(arg){
+  var args = this._args.map(function(arg){
     return arg.required
       ? '<' + arg.name + '>'
       : '[' + arg.name + ']';
@@ -685,7 +690,8 @@ Command.prototype.usage = function(str){
   var usage = '[options'
     + (this.commands.length ? '] [command' : '')
     + ']'
-    + (this.args.length ? ' ' + args : '');
+    + (this._args.length ? ' ' + args : '');
+
   if (0 == arguments.length) return this._usage || usage;
   this._usage = str;
 
@@ -738,7 +744,7 @@ Command.prototype.commandHelp = function(){
     , '  Commands:'
     , ''
     , this.commands.map(function(cmd){
-      var args = cmd.args.map(function(arg){
+      var args = cmd._args.map(function(arg){
         return arg.required
           ? '<' + arg.name + '>'
           : '[' + arg.name + ']';
@@ -747,7 +753,7 @@ Command.prototype.commandHelp = function(){
       return pad(cmd._name
         + (cmd.options.length 
           ? ' [options]'
-          : '') + ' ' + args, 18)
+          : '') + ' ' + args, 22)
         + (cmd.description()
           ? ' ' + cmd.description()
           : '');
@@ -810,6 +816,25 @@ Command.prototype.promptForDate = function(str, fn){
   });
 };
 
+
+/**
+ * Prompt for a `Regular Expression`.
+ *
+ * @param {String} str
+ * @param {Object} pattern regular expression object to test
+ * @param {Function} fn
+ * @api private
+ */
+
+Command.prototype.promptForRegexp = function(str, pattern, fn){
+  var self = this;
+  this.promptSingleLine(str, function parseRegexp(val){
+    if(!pattern.test(val)) return self.promptSingleLine(str + '(regular expression mismatch) ', parseRegexp);
+    fn(val);
+  });
+};
+
+
 /**
  * Single-line prompt.
  *
@@ -819,7 +844,10 @@ Command.prototype.promptForDate = function(str, fn){
  */
 
 Command.prototype.promptSingleLine = function(str, fn){
-  if ('function' == typeof arguments[2]) {
+  // determine if the 2nd argument is a regular expression
+  if (arguments[1].global !== undefined && arguments[1].multiline !== undefined) {
+    return this.promptForRegexp(str, arguments[1], arguments[2]);
+  } else if ('function' == typeof arguments[2]) {
     return this['promptFor' + (fn.name || fn)](str, arguments[2]);
   }
 
@@ -878,7 +906,6 @@ Command.prototype.promptMultiLine = function(str, fn){
 
 Command.prototype.prompt = function(str, fn){
   var self = this;
-
   if ('string' == typeof str) {
     if (/ $/.test(str)) return this.promptSingleLine.apply(this, arguments);
     this.promptMultiLine(str, fn);

package/package.json

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

package/.npmignore

@@ -1,4 +0,0 @@
-support
-test
-examples
-*.sock

package/.travis.yml

@@ -1,4 +0,0 @@
-language: node_js
-node_js:
-  - 0.4
-  - 0.6

package/Makefile

@@ -1,7 +0,0 @@
-
-TESTS = $(shell find test/test.*.js)
-
-test:
-	@./test/run $(TESTS)
-
-.PHONY: test