yargs 2.1.1 → 2.3.0

package/README.md

@@ -8,10 +8,9 @@ With yargs, ye be havin' a map that leads straight to yer treasure! Treasure of
 [![Build Status](https://travis-ci.org/chevex/yargs.png)](https://travis-ci.org/chevex/yargs)
 [![Dependency Status](https://gemnasium.com/chevex/yargs.png)](https://gemnasium.com/chevex/yargs)
 [![NPM version](https://badge.fury.io/js/yargs.png)](http://badge.fury.io/js/yargs)
+[![Coverage Status](https://coveralls.io/repos/chevex/yargs/badge.svg?branch=)](https://coveralls.io/r/chevex/yargs?branch=)
 
-> ~~NOTE: Yargs is a fork of [optimist](https://github.com/substack/node-optimist) by [substack (James Halliday)](https://github.com/substack). It is obvious that substack is stretched pretty thin maintaining over 300 modules on npm at the time of this writing. So rather than complain in the project issue tracker I thought I'd just pick up the torch and maintain a proper fork. Currently the project is totally backward compatible with optimist but this may change in the future (if it does I will update this notice to inform you of this). For now though, enjoy optimist with about 5 months worth of fixes and updates rolled in, most of them pulled from optimist's own [stale pull requests](https://github.com/substack/node-optimist/pulls).~~
-
-> UPDATE: Yargs is now the official successor to optimist. Please feel free to submit issues and pull requests. While I personally don't have the time to pore over all the issues and fix all of them on a regular basis, I'm more than happy to look over pull requests, test them, and merge them in. If you'd like to contribute and don't know where to start, have a look at [the issue list](https://github.com/chevex/yargs/issues) :)
+> Yargs is the official successor to optimist. Please feel free to submit issues and pull requests. If you'd like to contribute and don't know where to start, have a look at [the issue list](https://github.com/chevex/yargs/issues) :)
 
 examples
 ========
@@ -37,7 +36,7 @@ else {
 
     $ ./xup.js --rif=55 --xup=9.52
     Plunder more riffiwobbles!
-    
+
     $ ./xup.js --rif 12 --xup 8.1
     Drop the xupptumblers!
 
@@ -45,7 +44,7 @@ else {
 
 But don't walk the plank just yet! There be more! You can do short options:
 -------------------------------------------------
- 
+
 short.js:
 
 ````javascript
@@ -81,7 +80,7 @@ console.log(
 
     $ ./bool.js -s
     The parrot says: squawk
-    
+
     $ ./bool.js -sp
     The parrot says: squawk!
 
@@ -90,7 +89,7 @@ console.log(
 
 And non-hyphenated options too! Just use `argv._`!
 -------------------------------------------------
- 
+
 nonopt.js:
 
 ````javascript
@@ -105,7 +104,7 @@ console.log(argv._);
     $ ./nonopt.js -x 6.82 -y 3.35 rum
     (6.82,3.35)
     [ 'rum' ]
-    
+
     $ ./nonopt.js "me hearties" -x 0.54 yo -y 1.12 ho
     (0.54,1.12)
     [ 'me hearties', 'yo', 'ho' ]
@@ -167,10 +166,10 @@ console.log(argv.x / argv.y);
 ````
 
 ***
- 
+
     $ ./divide.js -x 55 -y 11
     5
-    
+
     $ node ./divide.js -x 4.91 -z 2.51
     Usage: node ./divide.js -x [num] -y [num]
 
@@ -258,7 +257,7 @@ console.dir(argv._);
     $ ./boolean_single.js -v "me hearties" yo ho
     true
     [ 'me hearties', 'yo', 'ho' ]
-    
+
 
 boolean_double.js
 
@@ -324,10 +323,10 @@ s.on('end', function () {
 
     Missing required arguments: f
 
-    $ node line_count.js --file line_count.js 
+    $ node line_count.js --file line_count.js
     20
-    
-    $ node line_count.js -f line_count.js 
+
+    $ node line_count.js -f line_count.js
     20
 
 methods
@@ -403,6 +402,13 @@ usage information and exit.
 The default behaviour is to set the value of any key not followed by an
 option value to `true`.
 
+.implies(x, y)
+--------------
+
+Given the key `x` is set, it is required that the key `y` is set.
+
+implies can also accept an object specifying multiple implications.
+
 .describe(key, desc)
 --------------------
 
@@ -415,7 +421,7 @@ Optionally `.describe()` can take an object that maps keys to descriptions.
 .options(key, opt)
 ------------------
 
-Instead of chaining together `.alias().demand().default()`, you can specify
+Instead of chaining together `.alias().demand().default().describe().string()`, you can specify
 keys in `opt` for each of the chainable methods.
 
 For example:
@@ -424,7 +430,10 @@ For example:
 var argv = require('yargs')
     .option('f', {
         alias : 'file',
-        default : '/etc/passwd',
+        demand: true,
+        default: '/etc/passwd',
+        describe: 'x marks the spot',
+        type: 'string'
     })
     .argv
 ;
@@ -442,6 +451,21 @@ var argv = require('yargs')
 
 Optionally `.options()` can take an object that maps keys to `opt` parameters.
 
+````javascript
+var argv = require('yargs')
+    .options({
+      'f': {
+        alias: 'file',
+        demand: true,
+        default: '/etc/passwd',
+        describe: 'x marks the spot',
+        type: 'string'
+      }
+    })
+    .argv
+;
+````
+
 .usage(message, opts)
 ---------------------
 
@@ -469,14 +493,21 @@ Check that certain conditions are met in the provided arguments.
 If `fn` throws or returns `false`, show the thrown error, usage information, and
 exit.
 
+.fail(fn)
+---------
+
+Method to execute when a failure occurs, rather then printing the failure message.
+
+`fn` is called with the failure message that would have been printed.
+
 .boolean(key)
 -------------
 
 Interpret `key` as a boolean. If a non-flag option follows `key` in
 `process.argv`, that string won't get set as the value of `key`.
 
-If `key` never shows up as a flag in `process.arguments`, `argv[key]` will be
-`false`.
+`key` will default to `false`, unless an `default(key, undefined)` is
+explicitly set.
 
 If `key` is an Array, interpret all the elements as booleans.
 
@@ -488,6 +519,9 @@ This can be useful if you need to preserve leading zeros in an input.
 
 If `key` is an Array, interpret all the elements as strings.
 
+`.string('_')` will result in non-hyphenated arguments being interpreted as strings,
+regardless of whether they resemble numbers.
+
 .config(key)
 ------------
 
@@ -671,17 +705,17 @@ installation
 With [npm](http://github.com/isaacs/npm), just do:
 
     npm install yargs
- 
+
 or clone this project on github:
 
     git clone http://github.com/chevex/yargs.git
 
 To run the tests with [expresso](http://github.com/visionmedia/expresso),
 just do:
-    
+
     expresso
 
-inspired By
+inspired by
 ===========
 
 This module is loosely inspired by Perl's

package/index.js

@@ -1,6 +1,6 @@
 var path = require('path');
-var minimist = require('./lib/minimist');
-var wordwrap = require('./lib/wordwrap');
+var parser = require('./lib/parser');
+var wordwrap = require('wordwrap');
 
 /*  Hack an instance of Argv with process.argv into Argv
     so people can do
@@ -189,7 +189,7 @@ function Argv (processArgs, cwd) {
             if (exitProcess){
                 process.exit(1);
             }else{
-              throw new Error(msg);
+                throw new Error(msg);
             }
         }
     }
@@ -233,7 +233,7 @@ function Argv (processArgs, cwd) {
                 self.demand(key, demand);
             }
 
-            if (typeof opt.default !== 'undefined') {
+            if ('default' in opt) {
                 self.default(key, opt.default);
             }
 
@@ -300,8 +300,8 @@ function Argv (processArgs, cwd) {
     var showHelpOnFail = true;
     self.showHelpOnFail = function (enabled, message) {
         if (typeof enabled === 'string') {
-            enabled = true;
             message = enabled;
+            enabled = true;
         }
         else if (typeof enabled === 'undefined') {
             enabled = true;
@@ -440,13 +440,17 @@ function Argv (processArgs, cwd) {
                 var dlen = dlines.slice(-1)[0].length
                     + (dlines.length === 1 ? prelude.length : 0)
 
-                body = desc + (dlen + extra.length > wrap - 2
-                    ? '\n'
-                        + new Array(wrap - extra.length + 1).join(' ')
-                        + extra
-                    : new Array(wrap - extra.length - dlen + 1).join(' ')
-                        + extra
-                );
+                if (extra.length > wrap) {
+                    body = desc + '\n' + wordwrap(switchlen + 4, wrap)(extra)
+                } else {
+                    body = desc + (dlen + extra.length > wrap - 2
+                        ? '\n'
+                            + new Array(wrap - extra.length + 1).join(' ')
+                            + extra
+                        : new Array(wrap - extra.length - dlen + 1).join(' ')
+                            + extra
+                    );
+                }
             }
 
             help.push(prelude + body);
@@ -457,12 +461,22 @@ function Argv (processArgs, cwd) {
     };
 
     Object.defineProperty(self, 'argv', {
-        get : function () { return parseArgs(processArgs) },
+        get : function () {
+          var args = null;
+
+          try {
+            args = parseArgs(processArgs);
+          } catch (err) {
+            fail(err.message);
+          }
+
+          return args;
+        },
         enumerable : true
     });
 
     function parseArgs (args) {
-        var parsed = minimist(args, options),
+        var parsed = parser(args, options),
             argv = parsed.argv,
             aliases = parsed.aliases;
 
@@ -501,7 +515,7 @@ function Argv (processArgs, cwd) {
             options.requiresArg.forEach(function(key) {
                 var value = argv[key];
 
-                // minimist sets --foo value to true / --no-foo to false
+                // parser sets --foo value to true / --no-foo to false
                 if (value === true || value === false) {
                     missingRequiredArgs.push(key);
                 }
@@ -643,14 +657,5 @@ function Argv (processArgs, cwd) {
 // exported for tests
 exports.rebase = rebase;
 function rebase (base, dir) {
-    var ds = path.normalize(dir).split('/').slice(1);
-    var bs = path.normalize(base).split('/').slice(1);
-
-    for (var i = 0; ds[i] && ds[i] == bs[i]; i++);
-    ds.splice(0, i); bs.splice(0, i);
-
-    var p = path.normalize(
-        bs.map(function () { return '..' }).concat(ds).join('/')
-    ).replace(/\/$/,'').replace(/^$/, '.');
-    return p.match(/^[.\/]/) ? p : './' + p;
+  return path.relative(base, dir);
 };

package/lib/{minimist.js → parser.js}

@@ -1,3 +1,5 @@
+// fancy-pants parsing of argv, originally forked
+// from minimist: https://www.npmjs.com/package/minimist
 var path = require('path');
 var fs = require('fs');
 
@@ -71,7 +73,7 @@ module.exports = function (args, opts) {
 
     var argv = { _ : [] };
     Object.keys(flags.bools).forEach(function (key) {
-        setArg(key, defaults[key] === undefined ? false : defaults[key]);
+        setArg(key, !(key in defaults) ? false : defaults[key]);
     });
 
     var notFlags = [];
@@ -145,8 +147,7 @@ module.exports = function (args, opts) {
                       }
                   });
               } catch (ex) {
-                  console.error('Invalid JSON config file: ' + configPath);
-                  throw ex;
+                  throw Error('invalid json config file: ' + configPath);
               }
             }
         });
@@ -328,7 +329,3 @@ function isNumber (x) {
     if (/^0x[0-9a-f]+$/i.test(x)) return true;
     return /^[-+]?(?:\d+(?:\.\d*)?|\.\d+)(e[-+]?\d+)?$/.test(x);
 }
-
-function longest (xs) {
-    return Math.max.apply(null, xs.map(function (x) { return x.length }));
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yargs",
-  "version": "2.1.1",
+  "version": "2.3.0",
   "description": "Light-weight option parsing with an argv hash. No optstrings attached.",
   "main": "./index.js",
   "files": [
@@ -8,12 +8,16 @@
     "lib",
     "LICENSE"
   ],
-  "dependencies": {},
+  "dependencies": {
+    "wordwrap": "0.0.2"
+  },
   "devDependencies": {
     "blanket": "^1.1.6",
     "chai": "^1.10.0",
+    "coveralls": "^2.11.2",
     "hashish": "0.0.4",
     "mocha": "^2.1.0",
+    "mocha-lcov-reporter": "0.0.1",
     "mocoverage": "^1.0.0"
   },
   "scripts": {

package/lib/wordwrap.js

@@ -1,50 +0,0 @@
-// Simplified version of https://github.com/substack/node-wordwrap
-
-'use strict';
-
-module.exports = function (start, stop) {
-
-    if (!stop) {
-        stop = start;
-        start = 0;
-    }
-
-    var re = /(\S+\s+)/;
-
-    return function (text) {
-        var chunks = text.toString().split(re);
-
-        return chunks.reduce(function (lines, rawChunk) {
-            if (rawChunk === '') return lines;
-
-            var chunk = rawChunk.replace(/\t/g, '    ');
-
-            var i = lines.length - 1;
-            if (lines[i].length + chunk.length > stop) {
-                lines[i] = lines[i].replace(/\s+$/, '');
-
-                chunk.split(/\n/).forEach(function (c) {
-                    lines.push(
-                        new Array(start + 1).join(' ')
-                            + c.replace(/^\s+/, '')
-                    );
-                });
-            }
-            else if (chunk.match(/\n/)) {
-                var xs = chunk.split(/\n/);
-                lines[i] += xs.shift();
-                xs.forEach(function (c) {
-                    lines.push(
-                        new Array(start + 1).join(' ')
-                            + c.replace(/^\s+/, '')
-                    );
-                });
-            }
-            else {
-                lines[i] += chunk;
-            }
-
-            return lines;
-        }, [ new Array(start + 1).join(' ') ]).join('\n');
-    };
-};