yargs 1.3.1 → 2.3.0

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');
 
@@ -32,13 +34,17 @@ module.exports = function (args, opts) {
         }).join('');
     }
 
-    var aliases = {};
+    var aliases = {},
+        newAliases = {};
+
     Object.keys(opts.alias || {}).forEach(function (key) {
         aliases[key] = [].concat(opts.alias[key]);
         // For "--option-name", also set argv.optionName
         aliases[key].concat(key).forEach(function (x) {
             if (/-/.test(x)) {
-                aliases[key].push(toCamelCase(x));
+                var c = toCamelCase(x);
+                aliases[key].push(c);
+                newAliases[c] = true;
             }
         });
         aliases[key].forEach(function (x) {
@@ -52,7 +58,13 @@ module.exports = function (args, opts) {
 
     Object.keys(defaults || {}).forEach(function (key) {
         if (/-/.test(key) && !opts.alias[key]) {
-            aliases[key] = (aliases[key] || []).concat(toCamelCase(key));
+            var c = toCamelCase(key);
+            aliases[key] = aliases[key] || [];
+            // don't allow the same key to be added multiple times.
+            if (aliases[key].indexOf(c) === -1) {
+                aliases[key] = (aliases[key] || []).concat(c);
+                newAliases[c] = true;
+            }
         }
         (aliases[key] || []).forEach(function (alias) {
             defaults[alias] = defaults[key];
@@ -61,19 +73,25 @@ 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 = [];
-
     if (args.indexOf('--') !== -1) {
         notFlags = args.slice(args.indexOf('--')+1);
         args = args.slice(0, args.indexOf('--'));
     }
 
     function setArg (key, val) {
+        // handle parsing boolean arguments --foo=true --bar false.
+        if (flags.bools[key] || (aliases[key] ? flags.bools[aliases[key]] : false)) {
+          if (typeof val === 'string') val = val === 'true';
+        }
+
         if (/-/.test(key) && !(aliases[key] && aliases[key].length)) {
-            aliases[key] = [toCamelCase(key)];
+            var c = toCamelCase(key);
+            aliases[key] = [c];
+            newAliases[c] = true;
         }
 
         var value = !flags.strings[key] && isNumber(val) ? Number(val) : val;
@@ -82,18 +100,6 @@ module.exports = function (args, opts) {
             value = function(orig) { return orig !== undefined ? orig + 1 : 0; };
         }
 
-        if (flags.configs[key]) {
-            try {
-                var config = JSON.parse(fs.readFileSync(val, 'utf8'));
-                Object.keys(config).forEach(function (key) {
-                    setArg(key, config[key]);
-                });
-            } catch (ex) {
-                console.error('Invalid JSON config file: ' + val);
-                throw ex;
-            }
-        }
-
         setKey(argv, key.split('.'), value);
 
         (aliases[key] || []).forEach(function (x) {
@@ -118,6 +124,35 @@ module.exports = function (args, opts) {
         }
     }
 
+    // set args from config.json file, this should be
+    // applied last so that defaults can be applied.
+    function setConfig (argv) {
+        var configLookup = {};
+
+        // expand defaults/aliases, in-case any happen to reference
+        // the config.json file.
+        applyDefaultsAndAliases(configLookup, aliases, defaults);
+
+        Object.keys(flags.configs).forEach(function(configKey) {
+            var configPath = argv[configKey] || configLookup[configKey];
+            if (configPath) {
+              try {
+                  var config = JSON.parse(fs.readFileSync(configPath, 'utf8'));
+                  Object.keys(config).forEach(function (key) {
+                      // setting arguments via CLI takes precedence over
+                      // values within the config file.
+                      if (argv[key] === undefined) {
+                        delete argv[key];
+                        setArg(key, config[key]);
+                      }
+                  });
+              } catch (ex) {
+                  throw Error('invalid json config file: ' + configPath);
+              }
+            }
+        });
+    }
+
     for (var i = 0; i < args.length; i++) {
         var arg = args[i];
 
@@ -142,11 +177,11 @@ module.exports = function (args, opts) {
                 i++;
             }
             else if (/^(true|false)$/.test(next)) {
-                setArg(key, next === 'true');
+                setArg(key, next);
                 i++;
             }
             else {
-                setArg(key, true);
+                setArg(key, defaultForType(guessType(key, flags)));
             }
         }
         else if (arg.match(/^-[^-]+/)) {
@@ -180,7 +215,7 @@ module.exports = function (args, opts) {
                     break;
                 }
                 else {
-                    setArg(letters[j], true);
+                    setArg(letters[j], defaultForType(guessType(letters[j], flags)));
                 }
             }
 
@@ -193,11 +228,11 @@ module.exports = function (args, opts) {
                     i++;
                 }
                 else if (args[i+1] && /true|false/.test(args[i+1])) {
-                    setArg(key, args[i+1] === 'true');
+                    setArg(key, args[i+1]);
                     i++;
                 }
                 else {
-                    setArg(key, true);
+                    setArg(key, defaultForType(guessType(key, flags)));
                 }
             }
         }
@@ -208,15 +243,8 @@ module.exports = function (args, opts) {
         }
     }
 
-    Object.keys(defaults).forEach(function (key) {
-        if (!hasKey(argv, key.split('.'))) {
-            setKey(argv, key.split('.'), defaults[key]);
-
-            (aliases[key] || []).forEach(function (x) {
-                setKey(argv, x.split('.'), defaults[key]);
-            });
-        }
-    });
+    setConfig(argv);
+    applyDefaultsAndAliases(argv, aliases, defaults);
 
     Object.keys(flags.counts).forEach(function (key) {
         setArg(key, defaults[key]);
@@ -228,10 +256,23 @@ module.exports = function (args, opts) {
 
     return {
         argv: argv,
-        aliases: aliases
+        aliases: aliases,
+        newAliases: newAliases
     };
 };
 
+function applyDefaultsAndAliases(obj, aliases, defaults) {
+    Object.keys(defaults).forEach(function (key) {
+        if (!hasKey(obj, key.split('.'))) {
+            setKey(obj, key.split('.'), defaults[key]);
+
+            (aliases[key] || []).forEach(function (x) {
+                setKey(obj, x.split('.'), defaults[key]);
+            });
+        }
+    });
+}
+
 function hasKey (obj, keys) {
     var o = obj;
     keys.slice(0,-1).forEach(function (key) {
@@ -249,7 +290,6 @@ function setKey (obj, keys, value) {
         o = o[key];
     });
 
-
     var key = keys[keys.length - 1];
     if (typeof value === 'function') {
         o[key] = value(o[key]);
@@ -265,12 +305,27 @@ function setKey (obj, keys, value) {
     }
 }
 
+// return a default value, given the type of a flag.,
+// e.g., key of type 'string' will default to '', rather than 'true'.
+function defaultForType (type) {
+    var def = {
+        boolean: true,
+        string: ''
+    };
+
+    return def[type];
+}
+
+// given a flag, enforce a default type.
+function guessType (key, flags) {
+    var type = 'boolean';
+    if (flags.strings && flags.strings[key]) type = 'string';
+
+    return type;
+}
+
 function isNumber (x) {
     if (typeof x === 'number') return true;
     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,21 +1,45 @@
 {
   "name": "yargs",
-  "version": "1.3.1",
+  "version": "2.3.0",
   "description": "Light-weight option parsing with an argv hash. No optstrings attached.",
   "main": "./index.js",
-  "dependencies": {},
+  "files": [
+    "index.js",
+    "lib",
+    "LICENSE"
+  ],
+  "dependencies": {
+    "wordwrap": "0.0.2"
+  },
   "devDependencies": {
-    "hashish": "*",
-    "mocha": "*",
-    "chai": "*"
+    "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": {
-    "test": "mocha -R nyan"
+    "test": "mocha --check-leaks --ui exports --require blanket -R mocoverage"
   },
   "repository": {
     "type": "git",
     "url": "http://github.com/chevex/yargs.git"
   },
+  "config": {
+    "blanket": {
+      "pattern": [
+        "lib",
+        "index.js"
+      ],
+      "data-cover-never": [
+        "node_modules",
+        "test"
+      ],
+      "output-reporter": "spec"
+    }
+  },
   "keywords": [
     "argument",
     "args",
@@ -30,6 +54,22 @@
     "email": "Alex.Ford@CodeTunnel.com",
     "url": "http://CodeTunnel.com"
   },
+  "contributors": [
+    {
+      "name": "Chris Needham",
+      "email": "chris@chrisneedham.com",
+      "url": "http://chrisneedham.com"
+    },
+    {
+      "name": "James Nylen",
+      "email": "jnylen@gmail.com",
+      "url": "https://github.com/nylen"
+    },
+    {
+      "name": "Benjamin Horsleben",
+      "url": "https://github.com/fizker"
+    }
+  ],
   "license": "MIT/X11",
   "engine": {
     "node": ">=0.4"

package/.npmignore

@@ -1,3 +0,0 @@
-.idea/
-node_modules/
-*.swp

package/.travis.yml

@@ -1,3 +0,0 @@
-language: node_js
-node_js:
-  - "0.10"

package/example/bool.js

@@ -1,10 +0,0 @@
-#!/usr/bin/env node
-var util = require('util');
-var argv = require('yargs').argv;
-
-if (argv.s) {
-    util.print(argv.fr ? 'Le chat dit: ' : 'The cat says: ');
-}
-console.log(
-    (argv.fr ? 'miaou' : 'meow') + (argv.p ? '.' : '')
-);

package/example/boolean_double.js

@@ -1,7 +0,0 @@
-#!/usr/bin/env node
-var argv = require('yargs')
-    .boolean(['x','y','z'])
-    .argv
-;
-console.dir([ argv.x, argv.y, argv.z ]);
-console.dir(argv._);

package/example/boolean_single.js

@@ -1,7 +0,0 @@
-#!/usr/bin/env node
-var argv = require('yargs')
-    .boolean('v')
-    .argv
-;
-console.dir(argv.v);
-console.dir(argv._);

package/example/count.js

@@ -1,15 +0,0 @@
-#!/usr/bin/env node
-var argv = require('yargs')
-    .count('verbose')
-    .alias('v', 'verbose')
-    .argv;
-
-VERBOSE_LEVEL = argv.verbose;
-
-function WARN()  { VERBOSE_LEVEL >= 0 && console.log.apply(console, arguments); }
-function INFO()  { VERBOSE_LEVEL >= 1 && console.log.apply(console, arguments); }
-function DEBUG() { VERBOSE_LEVEL >= 2 && console.log.apply(console, arguments); }
-
-WARN("Showing only important stuff");
-INFO("Showing semi-important stuff too");
-DEBUG("Extra chatty mode");

package/example/default_hash.js

@@ -1,8 +0,0 @@
-#!/usr/bin/env node
-
-var argv = require('yargs')
-    .default({ x : 10, y : 10 })
-    .argv
-;
-
-console.log(argv.x + argv.y);

package/example/default_singles.js

@@ -1,7 +0,0 @@
-#!/usr/bin/env node
-var argv = require('yargs')
-    .default('x', 10)
-    .default('y', 10)
-    .argv
-;
-console.log(argv.x + argv.y);

package/example/demand_count.js

@@ -1,5 +0,0 @@
-#!/usr/bin/env node
-var argv = require('yargs')
-    .demand(2)
-    .argv;
-console.dir(argv)

package/example/divide.js

@@ -1,8 +0,0 @@
-#!/usr/bin/env node
-
-var argv = require('yargs')
-    .usage('Usage: $0 -x [num] -y [num]')
-    .demand(['x','y'])
-    .argv;
-
-console.log(argv.x / argv.y);

package/example/help.js

@@ -1,27 +0,0 @@
-var yargs = require('../index');
-
-var argv = yargs
-  .usage('This is my awesome program\n\nUsage: $0 [options]')
-  .help('help').alias('help', 'h')
-  .version('1.0.1', 'version').alias('version', 'V')
-  .options({
-    input: {
-      alias: 'i',
-      description: "<filename> Input file name",
-      requiresArg: true,
-      required: true
-    },
-    output: {
-      alias: 'o',
-      description: "<filename> output file name",
-      requiresArg: true,
-      required: true
-    }
-  })
-  .argv;
-
-console.log('Inspecting options');
-console.dir(argv);
-
-console.log("input:", argv.input);
-console.log("output:", argv.output);

package/example/implies.js

@@ -1,10 +0,0 @@
-#!/usr/bin/env node
-
-var argv = require('yargs')
-    .usage('Usage: $0 -x [num] -y [num]')
-    .implies('x', 'y')
-    .argv;
-
-if (argv.x) {
-    console.log(argv.x / argv.y);
-}

package/example/implies_hash.js

@@ -1,26 +0,0 @@
-#!/usr/bin/env node
-
-var argv = require('yargs')
-    .usage('Usage: $0 -x [num] -y [num] -w [msg] -h [msg]')
-    .implies({
-        x: 'y',
-        w: '--no-h',
-        1: 'h'
-    })
-    .argv;
-
-if (argv.x) {
-    console.log('x / y : ' + (argv.x / argv.y));
-}
-
-if (argv.y) {
-    console.log('y: ' + argv.y);
-}
-
-if (argv.w) {
-    console.log('w: ' +argv.w);
-}
-
-if (argv.h) {
-    console.log('h: ' +argv.h);
-}

package/example/line_count.js

@@ -1,20 +0,0 @@
-#!/usr/bin/env node
-var argv = require('yargs')
-    .usage('Count the lines in a file.\nUsage: $0')
-    .demand('f')
-    .alias('f', 'file')
-    .describe('f', 'Load a file')
-    .argv
-;
-
-var fs = require('fs');
-var s = fs.createReadStream(argv.file);
-
-var lines = 0;
-s.on('data', function (buf) {
-    lines += buf.toString().match(/\n/g).length;
-});
-
-s.on('end', function () {
-    console.log(lines);
-});

package/example/line_count_options.js

@@ -1,29 +0,0 @@
-#!/usr/bin/env node
-var argv = require('yargs')
-    .usage('Count the lines in a file.\nUsage: $0')
-    .options({
-        file : {
-            demand : true,
-            alias : 'f',
-            description : 'Load a file'
-        },
-        base : {
-            alias : 'b',
-            description : 'Numeric base to use for output',
-            default : 10,
-        },
-    })
-    .argv
-;
-
-var fs = require('fs');
-var s = fs.createReadStream(argv.file);
-
-var lines = 0;
-s.on('data', function (buf) {
-    lines += buf.toString().match(/\n/g).length;
-});
-
-s.on('end', function () {
-    console.log(lines.toString(argv.base));
-});

package/example/line_count_wrap.js

@@ -1,29 +0,0 @@
-#!/usr/bin/env node
-var argv = require('yargs')
-    .usage('Count the lines in a file.\nUsage: $0')
-    .wrap(80)
-    .demand('f')
-    .alias('f', [ 'file', 'filename' ])
-    .describe('f',
-        "Load a file. It's pretty important."
-        + " Required even. So you'd better specify it."
-    )
-    .alias('b', 'base')
-    .describe('b', 'Numeric base to display the number of lines in')
-    .default('b', 10)
-    .describe('x', 'Super-secret optional parameter which is secret')
-    .default('x', '')
-    .argv
-;
-
-var fs = require('fs');
-var s = fs.createReadStream(argv.file);
-
-var lines = 0;
-s.on('data', function (buf) {
-    lines += buf.toString().match(/\n/g).length;
-});
-
-s.on('end', function () {
-    console.log(lines.toString(argv.base));
-});

package/example/nonopt.js

@@ -1,4 +0,0 @@
-#!/usr/bin/env node
-var argv = require('yargs').argv;
-console.log('(%d,%d)', argv.x, argv.y);
-console.log(argv._);

package/example/requires_arg.js

@@ -1,19 +0,0 @@
-var yargs = require('yargs');
-
-var argv = yargs.usage('This is my awesome program', {
-  'input': {
-    description: 'Input file name',
-    requiresArg: true,
-    short: 'i',
-  },
-  'output': {
-    description: 'Output file name',
-    requiresArg: true,
-    short: 'o'
-  }
-}).argv;
-
-yargs.showHelp();
-
-console.log('\n\nInspecting options');
-console.dir(argv);

package/example/short.js

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-var argv = require('yargs').argv;
-console.log('(%d,%d)', argv.x, argv.y);

package/example/strict.js

@@ -1,19 +0,0 @@
-var yargs = require('yargs');
-
-var argv = yargs.usage('This is my awesome program', {
-  'about': {
-    description: 'Provide some details about the author of this program',
-    boolean: true,
-    short: 'a',
-  },
-  'info': {
-    description: 'Provide some information about this program',
-    boolean: true,
-    short: 'i'
-  }
-}).strict().argv;
-
-yargs.showHelp();
-
-console.log('\n\nInspecting options');
-console.dir(argv);

package/example/string.js

@@ -1,11 +0,0 @@
-#!/usr/bin/env node
-var argv = require('yargs')
-    .string('x', 'y')
-    .argv
-;
-console.dir([ argv.x, argv.y ]);
-
-/* Turns off numeric coercion:
-    ./node string.js -x 000123 -y 9876
-    [ '000123', '9876' ]
-*/

package/example/usage-options.js

@@ -1,19 +0,0 @@
-var yargs = require('yargs');
-
-var argv = yargs.usage('This is my awesome program', {
-  'about': {
-    description: 'Provide some details about the author of this program',
-    required: true,
-    alias: 'a',
-  },
-  'info': {
-    description: 'Provide some information about the node.js agains!!!!!!',
-    boolean: true,
-    alias: 'i'
-  }
-}).argv;
-
-yargs.showHelp();
-
-console.log('\n\nInspecting options');
-console.dir(argv);

package/example/xup.js

@@ -1,9 +0,0 @@
-#!/usr/bin/env node
-var argv = require('yargs').argv;
-
-if (argv.rif - 5 * argv.xup > 7.138) {
-    console.log('Buy more riffiwobbles');
-}
-else {
-    console.log('Sell the xupptumblers');
-}