feat: introduce custom yargs error object (#765)

bcoe · bcoe · commit 8308efab74bb · 2017-02-26T09:53:21.000-06:00
BREAKING CHANGE: yargs will no longer aggressively supress errors, allowing errors that are not generated internally to bubble.
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@ node_modules/
 .nyc_output/
 *.swp
 test.js
+coverage
diff --git a/lib/completion.js b/lib/completion.js
@@ -44,7 +44,12 @@ module.exports = function (yargs, usage, command) {
     var handlers = command.getCommandHandlers()
     for (var i = 0, ii = args.length; i < ii; ++i) {
       if (handlers[args[i]] && handlers[args[i]].builder) {
-        return handlers[args[i]].builder(yargs.reset()).argv
+        const builder = handlers[args[i]].builder
+        if (typeof builder === 'function') {
+          const y = yargs.reset()
+          builder(y)
+          return y.argv
+        }
       }
     }
 
diff --git a/lib/usage.js b/lib/usage.js
@@ -3,6 +3,7 @@
 const stringWidth = require('string-width')
 const objFilter = require('./obj-filter')
 const setBlocking = require('set-blocking')
+const YError = require('./yerror')
 
 module.exports = function (yargs, y18n) {
   const __ = y18n.__
@@ -50,7 +51,7 @@ module.exports = function (yargs, y18n) {
         }
       }
 
-      err = err || new Error(msg)
+      err = err || new YError(msg)
       if (yargs.getExitProcess()) {
         return yargs.exit(1)
       } else if (yargs._hasParseCallback()) {
diff --git a/lib/yerror.js b/lib/yerror.js
@@ -0,0 +1,10 @@
+function YError (msg) {
+  this.name = 'YError'
+  this.message = msg || 'yargs error'
+  Error.captureStackTrace(this, YError)
+}
+
+YError.prototype = Object.create(Error.prototype)
+YError.prototype.constructor = YError
+
+module.exports = YError
diff --git a/test/completion.js b/test/completion.js
@@ -97,15 +97,13 @@ describe('Completion', function () {
                 describe: 'first option'
               }
             })
-            .argv
           })
           .command('cmd2', 'second command', function (subYargs) {
             subYargs.options({
               opt2: {
                 describe: 'second option'
               }
             })
-            .argv
           })
           .completion()
           .argv
diff --git a/test/usage.js b/test/usage.js
@@ -1,10 +1,11 @@
 /* global describe, it, beforeEach */
 
-var checkUsage = require('./helpers/utils').checkOutput
-var chalk = require('chalk')
-var path = require('path')
-var yargs = require('../')
-var rebase = require('../yargs').rebase
+const checkUsage = require('./helpers/utils').checkOutput
+const chalk = require('chalk')
+const path = require('path')
+const yargs = require('../')
+const rebase = require('../yargs').rebase
+const YError = require('../lib/yerror')
 
 require('chai').should()
 
@@ -482,7 +483,7 @@ describe('usage tests', function () {
                 describe: 'bar command'
               }
             }, function (argv) {
-              throw new Error('blah')
+              throw new YError('blah')
             })
             .fail(function (message, error, yargs) {
               yargs.showHelp()
@@ -534,14 +535,14 @@ describe('usage tests', function () {
                     })
                     .exitProcess(false)
                 }, function (argv) {
-                  throw new Error('foo')
+                  throw new YError('foo')
                 })
                 .argv
             } catch (error) {
 
             }
           })
-          r.logs.should.deep.equal([['Error', 'foo'], 'is triggered last'])
+          r.logs.should.deep.equal([['YError', 'foo'], 'is triggered last'])
           r.should.have.property('exit').and.be.false
         })
       })
diff --git a/yargs.js b/yargs.js
@@ -8,6 +8,7 @@ const Validation = require('./lib/validation')
 const Y18n = require('y18n')
 const objFilter = require('./lib/obj-filter')
 const setBlocking = require('set-blocking')
+const YError = require('./lib/yerror')
 
 var exports = module.exports = Yargs
 function Yargs (processArgs, cwd, parentRequire) {
@@ -867,7 +868,8 @@ function Yargs (processArgs, cwd, parentRequire) {
       try {
         args = parseArgs(processArgs)
       } catch (err) {
-        usage.fail(err.message, err)
+        if (err instanceof YError) usage.fail(err.message, err)
+        else throw err
       }
 
       return args
@@ -993,7 +995,7 @@ function Yargs (processArgs, cwd, parentRequire) {
     // If the help or version options where used and exitProcess is false,
     // or if explicitly skipped, we won't run validations
     if (!skipValidation) {
-      if (parsed.error) throw parsed.error
+      if (parsed.error) throw new YError(parsed.error.message)
 
       // if we're executed via bash completion, don't
       // bother with validation.

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,12 @@ module.exports = function (yargs, usage, command) {`
`44`	`44`	`var handlers = command.getCommandHandlers()`
`45`	`45`	`for (var i = 0, ii = args.length; i < ii; ++i) {`
`46`	`46`	`if (handlers[args[i]] && handlers[args[i]].builder) {`
`47`		`- return handlers[args[i]].builder(yargs.reset()).argv`
	`47`	`+ const builder = handlers[args[i]].builder`
	`48`	`+ if (typeof builder === 'function') {`
	`49`	`+ const y = yargs.reset()`
	`50`	`+ builder(y)`
	`51`	`+ return y.argv`
	`52`	`+ }`
`48`	`53`	`}`
`49`	`54`	`}`
`50`	`55`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`const stringWidth = require('string-width')`
`4`	`4`	`const objFilter = require('./obj-filter')`
`5`	`5`	`const setBlocking = require('set-blocking')`
	`6`	`+const YError = require('./yerror')`
`6`	`7`
`7`	`8`	`module.exports = function (yargs, y18n) {`
`8`	`9`	`const __ = y18n.__`
`@@ -50,7 +51,7 @@ module.exports = function (yargs, y18n) {`
`50`	`51`	`}`
`51`	`52`	`}`
`52`	`53`
`53`		`- err = err \|\| new Error(msg)`
	`54`	`+ err = err \|\| new YError(msg)`
`54`	`55`	`if (yargs.getExitProcess()) {`
`55`	`56`	`return yargs.exit(1)`
`56`	`57`	`} else if (yargs._hasParseCallback()) {`