yargs 3.9.1 → 3.10.0

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Change Log
 
+### v3.10.0 (2015/05/29 04:25 +00:00)
+
+- [#165](https://github.com/bcoe/yargs/pull/165) expose yargs.terminalWidth() thanks @ensonic (@bcoe)
+- [#164](https://github.com/bcoe/yargs/pull/164) better array handling thanks @getify (@bcoe)
+
 ### v3.9.1 (2015/05/20 05:14 +00:00)
 - [b6662b6](https://github.com/bcoe/yargs/commit/b6662b6774cfeab4876f41ec5e2f67b7698f4e2f) clarify .config() docs (@linclark)
 - [0291360](https://github.com/bcoe/yargs/commit/02913606285ce31ce81d7f12c48d8a3029776ec7) fixed tests, switched to nyc for coverage, fixed security issue, added Lin as collaborator (@bcoe)

package/README.md

@@ -595,7 +595,7 @@ regardless of whether they resemble numbers.
 ----------
 
 Tell the parser to interpret `key` as an array. If `.array('foo')` is set,
-`--foo bar` will be parsed as `['bar']` rather than as `'bar'`.
+`--foo foo bar` will be parsed as `['foo', 'bar']` rather than as `'bar'`.
 
 .nargs(key, count)
 -----------
@@ -618,7 +618,7 @@ Optionally `.nargs()` can take an object of `key`/`narg` pairs.
 .config(key)
 ------------
 
-Tells the parser that if the option specified by `key` is passed in, it 
+Tells the parser that if the option specified by `key` is passed in, it
 should be interpreted as a path to a JSON config file. The file is loaded
 and parsed, and its properties are set as arguments.
 
@@ -630,6 +630,9 @@ Format usage output to wrap at `columns` many columns.
 By default wrap will be set to `Math.min(80, windowWidth)`. Use `.wrap(null)` to
 specify no column limit.
 
+`yargs.wrap(yargs.terminalWidth())` can be used to maximize the width
+of yargs' usage instructions.
+
 .strict()
 ---------
 

package/index.js

@@ -379,6 +379,10 @@ function Argv (processArgs, cwd) {
     return validation
   }
 
+  self.terminalWidth = function () {
+    return require('window-size').width
+  }
+
   Object.defineProperty(self, 'argv', {
     get: function () {
       var args = null

package/lib/parser.js

@@ -69,7 +69,8 @@ module.exports = function (args, opts) {
       key,
       letters,
       m,
-      next
+      next,
+      value
 
     // -- seperated by =
     if (arg.match(/^--.+=/)) {
@@ -77,7 +78,18 @@ module.exports = function (args, opts) {
       // 'dotall' regex modifier. See:
       // http://stackoverflow.com/a/1068308/13216
       m = arg.match(/^--([^=]+)=([\s\S]*)$/)
-      setArg(m[1], m[2])
+
+      // nargs format = '--f=monkey washing cat'
+      if (checkAllAliases(m[1], opts.narg)) {
+        args.splice(i + 1, m[1], m[2])
+        i = eatNargs(i, m[1], args)
+      // arrays format = '--f=a b c'
+      } else if (checkAllAliases(m[1], flags.arrays) && args.length > i + 1) {
+        args.splice(i + 1, m[1], m[2])
+        i = eatArray(i, m[1], args)
+      } else {
+        setArg(m[1], m[2])
+      }
     } else if (arg.match(/^--no-.+/)) {
       key = arg.match(/^--no-(.+)/)[1]
       setArg(key, false)
@@ -86,8 +98,12 @@ module.exports = function (args, opts) {
     } else if (arg.match(/^--.+/)) {
       key = arg.match(/^--(.+)/)[1]
 
+      // nargs format = '--foo a b c'
       if (checkAllAliases(key, opts.narg)) {
         i = eatNargs(i, key, args)
+      // array format = '--foo a b c'
+      } else if (checkAllAliases(key, flags.arrays) && args.length > i + 1) {
+        i = eatArray(i, key, args)
       } else {
         next = args[i + 1]
 
@@ -130,7 +146,21 @@ module.exports = function (args, opts) {
         next = arg.slice(j + 2)
 
         if (letters[j + 1] && letters[j + 1] === '=') {
-          setArg(letters[j], arg.slice(j + 3))
+          value = arg.slice(j + 3)
+          key = letters[j]
+
+          // nargs format = '-f=monkey washing cat'
+          if (checkAllAliases(letters[j], opts.narg)) {
+            args.splice(i + 1, 0, value)
+            i = eatNargs(i, key, args)
+          // array format = '-f=a b c'
+          } else if (checkAllAliases(key, flags.arrays) && args.length > i + 1) {
+            args.splice(i + 1, 0, value)
+            i = eatArray(i, key, args)
+          } else {
+            setArg(key, value)
+          }
+
           broken = true
           break
         }
@@ -159,8 +189,12 @@ module.exports = function (args, opts) {
       key = arg.slice(-1)[0]
 
       if (!broken && key !== '-') {
+        // nargs format = '-f a b c'
         if (checkAllAliases(key, opts.narg)) {
           i = eatNargs(i, key, args)
+        // array format = '-f a b c'
+        } else if (checkAllAliases(key, flags.arrays) && args.length > i + 1) {
+          i = eatArray(i, key, args)
         } else {
           if (args[i + 1] && !/^(-|--)[^-]/.test(args[i + 1])
           && !checkAllAliases(key, flags.bools)
@@ -207,6 +241,19 @@ module.exports = function (args, opts) {
     return (i + toEat)
   }
 
+  // if an option is an array, eat all non-hyphenated arguments
+  // following it... YUM!
+  // e.g., --foo apple banana cat becomes ["apple", "banana", "cat"]
+  function eatArray (i, key, args) {
+    for (var ii = i + 1; ii < args.length; ii++) {
+      if (/^-/.test(args[ii])) break
+      i = ii
+      setArg(key, args[ii])
+    }
+
+    return i
+  }
+
   function setArg (key, val) {
     // handle parsing boolean arguments --foo=true --bar false.
     if (checkAllAliases(key, flags.bools) || checkAllAliases(key, flags.counts)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yargs",
-  "version": "3.9.1",
+  "version": "3.10.0",
   "description": "Light-weight option parsing with an argv hash. No optstrings attached.",
   "main": "./index.js",
   "files": [
@@ -20,8 +20,8 @@
     "coveralls": "^2.11.2",
     "hashish": "0.0.4",
     "mocha": "^2.2.1",
-    "nyc": "^2.0.0",
-    "standard": "^3.9.0"
+    "nyc": "^2.2.1",
+    "standard": "^3.11.1"
   },
   "scripts": {
     "test": "standard && nyc mocha --check-leaks && nyc report",