feat: allow strict mode to be disabled (#840)

BREAKING CHANGE: the first argument to strict() is now used to enable/disable its functionality, rather than controlling whether or not it is global.
yargs · Apr 15, 2017 · 6f78c05 · 6f78c05
1 parent e7359d6
commit 6f78c05
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -1809,7 +1809,7 @@ Specify --help for available options
 Specifies either a single option key (string), or an array of options.
 If any of the options is present, yargs validation is skipped.
 
-.strict([global=true])
+.strict([enabled=true])
 ---------
 
 Any command-line argument given that is not demanded, or does not have a

diff --git a/test/command.js b/test/command.js
@@ -1000,19 +1000,6 @@ describe('Command', function () {
         commandCalled.should.be.true
       })
 
-      it('does not apply strict globally when passed value of `false`', function () {
-        var commandCalled = false
-        yargs('hi')
-          .strict(false)
-          .command('hi', 'The hi command', function (innerYargs) {
-            commandCalled = true
-            innerYargs.getStrict().should.be.false
-          })
-        yargs.getStrict().should.be.true
-        yargs.argv // parse and run command
-        commandCalled.should.be.true
-      })
-
       // address regression introduced in #766, thanks @nexdrew!
       it('does not fail strict check due to postional command arguments', function (done) {
         yargs()
@@ -1037,6 +1024,19 @@ describe('Command', function () {
           })
       })
 
+      it('allows a command to override global`', function () {
+        var commandCalled = false
+        yargs('hi')
+         .strict()
+         .command('hi', 'The hi command', function (innerYargs) {
+           commandCalled = true
+           innerYargs.strict(false).getStrict().should.be.false
+         })
+        yargs.getStrict().should.be.true
+        yargs.argv // parse and run command
+        commandCalled.should.be.true
+      })
+
       it('does not fire command if validation fails', function (done) {
         var commandRun = false
         yargs()

diff --git a/test/yargs.js b/test/yargs.js
@@ -225,7 +225,6 @@ describe('yargs dsl tests', function () {
         .implies('foo', 'snuh')
         .conflicts('qux', 'xyzzy')
         .group('foo', 'Group:')
-        .strict(false)
         .exitProcess(false)  // defaults to true.
         .global('foo', false)
         .global('qux', false)
@@ -266,7 +265,6 @@ describe('yargs dsl tests', function () {
       expect(y.getValidationInstance().getConflicting()).to.deep.equal({})
       expect(y.getCommandInstance().getCommandHandlers()).to.deep.equal({})
       expect(y.getExitProcess()).to.equal(false)
-      expect(y.getStrict()).to.equal(false)
       expect(y.getDemandedOptions()).to.deep.equal({})
       expect(y.getDemandedCommands()).to.deep.equal({})
       expect(y.getGroups()).to.deep.equal({})

diff --git a/yargs.js b/yargs.js
@@ -126,7 +126,6 @@ function Yargs (processArgs, cwd, parentRequire) {
     command = command ? command.reset() : Command(self, usage, validation)
     if (!completion) completion = Completion(self, usage, command)
 
-    if (!strictGlobal) strict = false
     completionCommand = null
     output = ''
     exitError = null
@@ -695,11 +694,9 @@ function Yargs (processArgs, cwd, parentRequire) {
   }
 
   var strict = false
-  var strictGlobal = false
-  self.strict = function (global) {
-    argsert('[boolean]', [global], arguments.length)
-    strict = true
-    strictGlobal = global !== false
+  self.strict = function (enabled) {
+    argsert('[boolean]', [enabled], arguments.length)
+    strict = enabled !== false
     return self
   }
   self.getStrict = function () {