feat: add conflicts and implies shorthands. (#753)

vseventer · bcoe · commit bd1472ba3da6 · 2017-01-16T15:59:22.000-08:00
diff --git a/README.md b/README.md
@@ -1382,7 +1382,7 @@ var yargs = require("yargs")(['--help'])
 
 Later on, `argv` can be retrieved with `yargs.argv`.
 
-.implies(x, y)
+<a name="implies"></a>.implies(x, y)
 --------------
 
 Given the key `x` is set, it is required that the key `y` is set.
@@ -1578,13 +1578,15 @@ Valid `opt` keys include:
 - `coerce`: function, coerce or transform parsed command line values into another value, see [`coerce()`](#coerce)
 - `config`: boolean, interpret option as a path to a JSON config file, see [`config()`](#config)
 - `configParser`: function, provide a custom config parsing function, see [`config()`](#config)
+- `conflicts`: string or object, require certain keys not to be set, see [`conflicts()`](#conflicts)
 - `count`: boolean, interpret option as a count of boolean flags, see [`count()`](#count)
 - `default`: value, set a default value for the option, see [`default()`](#default)
 - `defaultDescription`: string, use this description for the default value in help content, see [`default()`](#default)
 - `demandOption`: boolean or string, demand the option be given, with optional error message, see [`demandOption()`](#demandOption)
 - `desc`/`describe`/`description`: string, the option description for help content, see [`describe()`](#describe)
 - `global`: boolean, indicate that this key should not be [reset](#reset) when a command is invoked, see [`global()`](#global)
 - `group`: string, when displaying usage instructions place the option under an alternative group heading, see [`group()`](#group)
+- `implies`: string or object, require certain keys to be set, see [`implies()`](#implies)
 - `nargs`: number, specify how many arguments should be consumed for the option, see [`nargs()`](#nargs)
 - `normalize`: boolean, apply `path.normalize()` to the option, see [`normalize()`](#normalize)
 - `number`: boolean, interpret option as a number, [`number()`](#number)
diff --git a/test/validation.js b/test/validation.js
@@ -124,6 +124,18 @@ describe('validation tests', function () {
       expect(argv.noFoo).to.not.exist
       expect(argv.foo).to.not.exist
     })
+
+    it('allows key to be specified with option shorthand', function (done) {
+      yargs('--bar')
+        .option('bar', {
+          implies: 'foo'
+        })
+        .fail(function (msg) {
+          msg.should.match(/Implications failed/)
+          return done()
+        })
+        .argv
+    })
   })
 
   describe('conflicts', function () {
@@ -172,6 +184,18 @@ describe('validation tests', function () {
         })
         .argv
     })
+
+    it('allows key to be specified with option shorthand', function (done) {
+      yargs(['-f', '-b'])
+          .option('f', {
+            conflicts: 'b'
+          })
+          .fail(function (msg) {
+            msg.should.equal('Arguments f and b are mutually exclusive')
+            return done()
+          })
+          .argv
+    })
   })
 
   describe('demand', function () {
diff --git a/yargs.js b/yargs.js
@@ -535,10 +535,18 @@ function Yargs (processArgs, cwd, parentRequire) {
         self.config(key, opt.configParser)
       }
 
+      if ('conflicts' in opt) {
+        self.conflicts(key, opt.conflicts)
+      }
+
       if ('default' in opt) {
         self.default(key, opt.default)
       }
 
+      if ('implies' in opt) {
+        self.implies(key, opt.implies)
+      }
+
       if ('nargs' in opt) {
         self.nargs(key, opt.nargs)
       }

Original file line number	Diff line number	Diff line change
`@@ -535,10 +535,18 @@ function Yargs (processArgs, cwd, parentRequire) {`
`535`	`535`	`self.config(key, opt.configParser)`
`536`	`536`	`}`
`537`	`537`
	`538`	`+ if ('conflicts' in opt) {`
	`539`	`+ self.conflicts(key, opt.conflicts)`
	`540`	`+ }`
	`541`	`+`
`538`	`542`	`if ('default' in opt) {`
`539`	`543`	`self.default(key, opt.default)`
`540`	`544`	`}`
`541`	`545`
	`546`	`+ if ('implies' in opt) {`
	`547`	`+ self.implies(key, opt.implies)`
	`548`	`+ }`
	`549`	`+`
`542`	`550`	`if ('nargs' in opt) {`
`543`	`551`	`self.nargs(key, opt.nargs)`
`544`	`552`	`}`