whoops 4.0.1 → 4.1.1

package/README.md

@@ -1,12 +1,8 @@
 # whoops
 
 ![Last version](https://img.shields.io/github/tag/Kikobeats/whoops.svg?style=flat-square)
-[![Build Status](http://img.shields.io/travis/Kikobeats/whoops/master.svg?style=flat-square)](https://travis-ci.org/Kikobeats/whoops)
 [![Coverage Status](https://img.shields.io/coveralls/Kikobeats/whoops.svg?style=flat-square)](https://coveralls.io/github/Kikobeats/whoops)
-[![Dependency status](http://img.shields.io/david/Kikobeats/whoops.svg?style=flat-square)](https://david-dm.org/Kikobeats/whoops)
-[![Dev Dependencies Status](http://img.shields.io/david/dev/Kikobeats/whoops.svg?style=flat-square)](https://david-dm.org/Kikobeats/whoops#info=devDependencies)
 [![NPM Status](http://img.shields.io/npm/dm/whoops.svg?style=flat-square)](https://www.npmjs.org/package/whoops)
-[![Donate](https://img.shields.io/badge/donate-paypal-blue.svg?style=flat-square)](https://paypal.me/kikobeats)
 
 > It makes simple throw qualified errors. Inspired in [errno](https://github.com/rvagg/node-errno), [create-error-class](https://github.com/floatdrop/create-error-class) and [fault](https://github.com/wooorm/fault).
 
@@ -14,7 +10,7 @@
 
 - An easy way to create qualified errors.
 - Using the standard `Error` interface in browser and NodeJS.
-- Attach extra information, depending of your case of use.
+- Attach extra information, being flexible with whatever user case.
 
 This library is a compromise to provide a clean API for use `Error` native class.
 
@@ -48,30 +44,36 @@ Call `whoops` to get a constructor function. Every time you call the constructor
 ```js
 const whoops = require('whoops')
 const myError = whoops()
-
 throw myError()
 ```
 
-If you provided a `className` you get a qualified constructor function that extends from `Error`:
+Create domain specific errors providing a `className` as first argument:
 
 ```js
 const whoops = require('whoops')
 const userError = whoops('userError')
-
 throw userError()
 ```
 
-Providing `props` as second parameter you can attach extra information that always will be associated with the `error`:
+The qualified error will be extends from `Error`:
 
 ```js
 const whoops = require('whoops')
-const userError = whoops('userError', {code: 'ENOVALID'})
+const userError = whoops('userError')
+const error = userError()
+console.log(error instanceof Error); // => true
+```
+
+Attach extra information passing a `props` as second argument:
 
+```js
+const whoops = require('whoops')
+const userError = whoops('userError', {code: 'ENOVALID'})
 const err = userError()
 console.log(`My error code is ${err.code}`) // => My error code is ENOVALID
 ```
 
-Also, you can associate dynamic `props` at the moment of the `error`:
+You can associate dynamic `props` as well:
 
 ```js
 const whoops = require('whoops')
@@ -126,6 +128,12 @@ switch (err.name) {
 };
 ```
 
+## Related
+
+- [create-error-class](https://github.com/floatdrop/create-error-class) – Create error class.
+- [fault](https://github.com/wooorm/fault) – Functional errors with formatted output.
+
+
 ## License
 
 MIT © [Kiko Beats](http://www.kikobeats.com)

package/lib/add-error-props.js

@@ -1,6 +1,6 @@
 'use strict'
 
-const {isFunction, composeErrorMessage} = require('./helpers')
+const { isFunction, composeErrorMessage } = require('./helpers')
 
 function interfaceObject (error, ...props) {
   Object.assign(error, ...props)
@@ -8,8 +8,8 @@ function interfaceObject (error, ...props) {
   error.description = isFunction(error.message) ? error.message(error) : error.message
 
   error.message = error.code
-   ? composeErrorMessage(error.code, error.description)
-   : error.description
+    ? composeErrorMessage(error.code, error.description)
+    : error.description
 }
 
 module.exports = interfaceObject

package/lib/create-error.js

@@ -1,13 +1,18 @@
 'use strict'
 
-const {inherits} = require('./helpers')
+const { inherits } = require('./helpers')
 const mimicFn = require('mimic-fn')
 
 const REGEX_CLASS_NAME = /[^0-9a-zA-Z_$]/
 
 function createError (className) {
-  if (typeof className !== 'string') throw new TypeError('Expected className to be a string')
-  if (REGEX_CLASS_NAME.test(className)) throw new Error('className contains invalid characters')
+  if (typeof className !== 'string') {
+    throw new TypeError('Expected className to be a string')
+  }
+
+  if (REGEX_CLASS_NAME.test(className)) {
+    throw new Error('className contains invalid characters')
+  }
 
   function ErrorClass () {
     Object.defineProperty(this, 'name', {
@@ -16,7 +21,9 @@ function createError (className) {
       writable: true
     })
 
-    Error.captureStackTrace(this, this.constructor)
+    if ('captureStackTrace' in Error) {
+      Error.captureStackTrace(this, this.constructor)
+    }
   }
 
   inherits(ErrorClass, Error)

package/lib/create-extend-error.js

@@ -4,12 +4,12 @@ const cleanStack = require('clean-stack')
 const mimicFn = require('mimic-fn')
 
 const addErrorProps = require('./add-error-props')
-const {isString} = require('./helpers')
+const { isString } = require('./helpers')
 
 function createExtendError (ErrorClass, classProps) {
   function ExtendError (props) {
     const error = new ErrorClass()
-    const errorProps = isString(props) ? {message: props} : props
+    const errorProps = isString(props) ? { message: props } : props
     addErrorProps(error, classProps, errorProps)
 
     error.stack = cleanStack(error.stack)

package/package.json

@@ -2,7 +2,7 @@
   "name": "whoops",
   "description": "It makes simple throw qualified errors.",
   "homepage": "https://github.com/Kikobeats/whoops",
-  "version": "4.0.1",
+  "version": "4.1.1",
   "main": "lib/index.js",
   "author": {
     "email": "josefrancisco.verdu@gmail.com",
@@ -24,15 +24,26 @@
     "throw"
   ],
   "dependencies": {
-    "clean-stack": "~1.3.0",
-    "mimic-fn": "~1.1.0"
+    "clean-stack": "~3.0.0",
+    "mimic-fn": "~3.1.0"
   },
   "devDependencies": {
-    "coveralls": "latest",
+    "@commitlint/cli": "latest",
+    "@commitlint/config-conventional": "latest",
+    "c8": "latest",
+    "ci-publish": "latest",
+    "conventional-github-releaser": "latest",
+    "finepack": "latest",
+    "git-authors-cli": "latest",
     "mocha": "latest",
-    "nyc": "latest",
+    "nano-staged": "latest",
+    "npm-check-updates": "latest",
+    "prettier-standard": "latest",
     "should": "latest",
-    "standard": "latest"
+    "simple-git-hooks": "latest",
+    "standard": "latest",
+    "standard-markdown": "latest",
+    "standard-version": "latest"
   },
   "engines": {
     "node": ">= 8"
@@ -42,12 +53,40 @@
   ],
   "scripts": {
     "clean": "rm -rf node_modules",
+    "contributors": "(git-authors-cli && finepack && git add package.json && git commit -m 'build: contributors' --no-verify) || true",
     "coveralls": "nyc report --reporter=text-lcov | coveralls",
     "lint": "standard lib",
+    "postrelease": "npm run release:tags && npm run release:github && (ci-publish || npm publish --access=public)",
+    "prerelease": "npm run update:check && npm run contributors",
     "pretest": "npm run lint",
-    "test": "nyc mocha"
+    "release": "standard-version -a",
+    "release:github": "conventional-github-releaser -p angular",
+    "release:tags": "git push --follow-tags origin HEAD:master",
+    "test": "c8 mocha",
+    "update": "ncu -u",
+    "update:check": "ncu -- --error-level 2"
   },
   "license": "MIT",
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "nano-staged": {
+    "*.js": [
+      "prettier-standard"
+    ],
+    "*.md": [
+      "standard-markdown"
+    ],
+    "package.json": [
+      "finepack"
+    ]
+  },
+  "simple-git-hooks": {
+    "commit-msg": "npx commitlint --edit",
+    "pre-commit": "npx nano-staged"
+  },
   "standard": {
     "env": "mocha"
   }

package/CHANGELOG.md

@@ -1,240 +0,0 @@
-<a name="4.0.1"></a>
-## 4.0.1 (2017-08-08)
-
-* Reducing library size ([ce26a2d](https://github.com/kikobeats/whoops/commit/ce26a2d))
-* Update README.md ([2e71ec2](https://github.com/kikobeats/whoops/commit/2e71ec2))
-
-
-
-<a name="4.0.0"></a>
-# 4.0.0 (2017-08-08)
-
-* refactor ([ca6e60e](https://github.com/kikobeats/whoops/commit/ca6e60e))
-* Remove unnecessasry ([6ec4220](https://github.com/kikobeats/whoops/commit/6ec4220))
-* Support attach props into constructor ([8dd67b9](https://github.com/kikobeats/whoops/commit/8dd67b9))
-* Update builds ([6e6275c](https://github.com/kikobeats/whoops/commit/6e6275c))
-* Update docs ([515c498](https://github.com/kikobeats/whoops/commit/515c498))
-* Update README.md ([a0dc9b0](https://github.com/kikobeats/whoops/commit/a0dc9b0))
-* Update README.md ([b289826](https://github.com/kikobeats/whoops/commit/b289826))
-* Update README.md ([bf87a1f](https://github.com/kikobeats/whoops/commit/bf87a1f))
-
-
-
-<a name="3.1.1"></a>
-## 3.1.1 (2017-07-18)
-
-* Update README.md ([4561a8b](https://github.com/kikobeats/whoops/commit/4561a8b))
-* docs(readme): add Greenkeeper badge ([9b93e2c](https://github.com/kikobeats/whoops/commit/9b93e2c))
-* chore(package): update clean-stack to version 1.2.0 ([b2cb039](https://github.com/kikobeats/whoops/commit/b2cb039))
-* chore(package): update clean-stack to version 1.3.0 ([12fb684](https://github.com/kikobeats/whoops/commit/12fb684))
-
-
-
-<a name="3.1.0"></a>
-# 3.1.0 (2016-12-19)
-
-* Add description field ([6b3b308](https://github.com/kikobeats/whoops/commit/6b3b308))
-* Drop node 5 from testing ([c223c7f](https://github.com/kikobeats/whoops/commit/c223c7f))
-
-
-
-<a name="3.0.3"></a>
-## 3.0.3 (2016-12-19)
-
-* 80 → 100 lines ([a117bb8](https://github.com/kikobeats/whoops/commit/a117bb8))
-* Avoid inline regexp declaration ([2f91173](https://github.com/kikobeats/whoops/commit/2f91173))
-* Better docs ([591d743](https://github.com/kikobeats/whoops/commit/591d743))
-* Test refactor ([58fb3dc](https://github.com/kikobeats/whoops/commit/58fb3dc))
-* Update deps ([c0d5a49](https://github.com/kikobeats/whoops/commit/c0d5a49))
-* Update README.md ([c9c32f8](https://github.com/kikobeats/whoops/commit/c9c32f8))
-
-
-
-<a name="3.0.2"></a>
-## 3.0.2 (2016-09-13)
-
-* chore(package): update clean-stack to version 1.0.0 ([ff0f4ce](https://github.com/kikobeats/whoops/commit/ff0f4ce))
-* Update ([ce66183](https://github.com/kikobeats/whoops/commit/ce66183))
-
-
-
-<a name="3.0.1"></a>
-## 3.0.1 (2016-08-01)
-
-* Avoid eval for setup function name ([1ecde20](https://github.com/kikobeats/whoops/commit/1ecde20))
-* Remove interface string façade ([14c5932](https://github.com/kikobeats/whoops/commit/14c5932))
-* Remove unncessary check ([6a4d469](https://github.com/kikobeats/whoops/commit/6a4d469))
-* Rename extend-error → create-extend-error ([fd3726e](https://github.com/kikobeats/whoops/commit/fd3726e))
-* Setup Error name in constructor ([4ac076d](https://github.com/kikobeats/whoops/commit/4ac076d))
-
-
-
-<a name="3.0.0"></a>
-# 3.0.0 (2016-07-30)
-
-* Add clean-stack dep ([7f32385](https://github.com/kikobeats/whoops/commit/7f32385))
-* Drop < 4 node support ([185ae66](https://github.com/kikobeats/whoops/commit/185ae66))
-* Fix dep ([a87c1ea](https://github.com/kikobeats/whoops/commit/a87c1ea))
-* Refactor fn template ([942a189](https://github.com/kikobeats/whoops/commit/942a189))
-* Remove capture-stack-trace dep ([5fdae23](https://github.com/kikobeats/whoops/commit/5fdae23))
-* Remove string interface with 3 params ([5439d61](https://github.com/kikobeats/whoops/commit/5439d61))
-* Remove unnecessary dep ([78d6dac](https://github.com/kikobeats/whoops/commit/78d6dac))
-* Update docs ([34f5e8c](https://github.com/kikobeats/whoops/commit/34f5e8c))
-
-
-
-<a name="2.2.0"></a>
-# 2.2.0 (2016-07-30)
-
-* Add coverage ([1547649](https://github.com/kikobeats/whoops/commit/1547649))
-* Move pretty on different pkg ([3640943](https://github.com/kikobeats/whoops/commit/3640943))
-* Refactor scaffold ([5907391](https://github.com/kikobeats/whoops/commit/5907391))
-* Remove browser build ([e0e3621](https://github.com/kikobeats/whoops/commit/e0e3621))
-
-
-
-<a name="2.1.0"></a>
-# 2.1.0 (2016-05-19)
-
-* Add missing dependency ([b832bf0](https://github.com/kikobeats/whoops/commit/b832bf0))
-* Add pretty output ([a1c6e4c](https://github.com/kikobeats/whoops/commit/a1c6e4c))
-* Update docs ([1b6c6a8](https://github.com/kikobeats/whoops/commit/1b6c6a8))
-* Update README.md ([30224fe](https://github.com/kikobeats/whoops/commit/30224fe))
-* Update travis builds ([44e69b5](https://github.com/kikobeats/whoops/commit/44e69b5))
-
-
-
-<a name="2.0.1"></a>
-## 2.0.1 (2016-02-07)
-
-
-* lock dependency ([9d36dd5](https://github.com/kikobeats/whoops/commit/9d36dd5))
-
-
-
-<a name="2.0.0"></a>
-# 2.0.0 (2016-02-03)
-
-
-* 2.0.0 releases ([c7ba44a](https://github.com/kikobeats/whoops/commit/c7ba44a))
-* Little refactor ([4fb84a1](https://github.com/kikobeats/whoops/commit/4fb84a1))
-* Refactor tests ([5fc36b1](https://github.com/kikobeats/whoops/commit/5fc36b1))
-* Setup correctly instanceof ([6436f3e](https://github.com/kikobeats/whoops/commit/6436f3e))
-* YEAH ([2c8b56b](https://github.com/kikobeats/whoops/commit/2c8b56b))
-
-
-
-<a name="1.1.1"></a>
-## 1.1.1 (2016-01-28)
-
-
-* 1.1.1 releases ([60cb701](https://github.com/kikobeats/whoops/commit/60cb701))
-* Add standard as devDependency ([313a136](https://github.com/kikobeats/whoops/commit/313a136))
-* Remove lodash.forEach dep ([f5f96ee](https://github.com/kikobeats/whoops/commit/f5f96ee))
-* setup correctly bumped ([75d190b](https://github.com/kikobeats/whoops/commit/75d190b))
-* Update README.md ([ec8d39c](https://github.com/kikobeats/whoops/commit/ec8d39c))
-* Update README.md ([ff486b4](https://github.com/kikobeats/whoops/commit/ff486b4))
-* Update README.md ([23527e7](https://github.com/kikobeats/whoops/commit/23527e7))
-
-
-
-<a name="1.1.0"></a>
-# 1.1.0 (2016-01-14)
-
-
-*  releases ([5fff532](https://github.com/kikobeats/whoops/commit/5fff532))
-* Add .create method ([1315768](https://github.com/kikobeats/whoops/commit/1315768))
-* Add coffe as devDependency ([ce75ae9](https://github.com/kikobeats/whoops/commit/ce75ae9))
-* Add custom message function in object factory ([470414c](https://github.com/kikobeats/whoops/commit/470414c))
-* bye coffee ([6a3a1d4](https://github.com/kikobeats/whoops/commit/6a3a1d4))
-* bye config ([e920003](https://github.com/kikobeats/whoops/commit/e920003))
-* Little tests refactor ([d3abb53](https://github.com/kikobeats/whoops/commit/d3abb53))
-* Update description and documentation ([0ad3cba](https://github.com/kikobeats/whoops/commit/0ad3cba))
-* Update scripts ([29240d2](https://github.com/kikobeats/whoops/commit/29240d2))
-
-
-
-<a name="1.0.1"></a>
-## 1.0.1 (2015-11-23)
-
-
-* 1.0.1 releases ([56e26f2](https://github.com/kikobeats/whoops/commit/56e26f2))
-* Fix typos in README.md ([e9063f2](https://github.com/kikobeats/whoops/commit/e9063f2))
-* Merge branch 'master' of github.com:kikobeats/whoops ([a363134](https://github.com/kikobeats/whoops/commit/a363134))
-* Merge pull request #4 from jorrit/patch-1 ([d9156f6](https://github.com/kikobeats/whoops/commit/d9156f6))
-* rewrite to avoid new ([23e586b](https://github.com/kikobeats/whoops/commit/23e586b))
-* update to upgrade bower.json ([b18589d](https://github.com/kikobeats/whoops/commit/b18589d))
-
-
-
-<a name="1.0.0"></a>
-# 1.0.0 (2015-11-20)
-
-
-* 1.0.0 releases ([447ae1e](https://github.com/kikobeats/whoops/commit/447ae1e))
-* refactored and renamed ([cf2b458](https://github.com/kikobeats/whoops/commit/cf2b458))
-* removed extra spaces ([931245d](https://github.com/kikobeats/whoops/commit/931245d))
-* updated ([9bf0fde](https://github.com/kikobeats/whoops/commit/9bf0fde))
-* updated bumped config ([4583c59](https://github.com/kikobeats/whoops/commit/4583c59))
-* updated dependencies ([3d7ec1b](https://github.com/kikobeats/whoops/commit/3d7ec1b))
-* updated documentation ([6ea514b](https://github.com/kikobeats/whoops/commit/6ea514b))
-* updated renaming ([4b9306c](https://github.com/kikobeats/whoops/commit/4b9306c))
-* updated travis builds ([a330eae](https://github.com/kikobeats/whoops/commit/a330eae))
-
-
-
-<a name="0.2.0"></a>
-# 0.2.0 (2015-10-01)
-
-
-* 0.2.0 releases ([aff1849](https://github.com/kikobeats/whoops/commit/aff1849))
-* Added format for string constructor ([d584188](https://github.com/kikobeats/whoops/commit/d584188))
-* improve example ([aa2d318](https://github.com/kikobeats/whoops/commit/aa2d318))
-* little suite of tests 😁 ([5e11def](https://github.com/kikobeats/whoops/commit/5e11def))
-* Update package.json ([1120535](https://github.com/kikobeats/whoops/commit/1120535))
-* updated ([d5fc2d9](https://github.com/kikobeats/whoops/commit/d5fc2d9))
-
-
-
-<a name="0.1.3"></a>
-## 0.1.3 (2015-07-28)
-
-
-* 0.1.3 releases ([e0de222](https://github.com/kikobeats/whoops/commit/e0de222))
-* fixed devDependencies ([bccbf41](https://github.com/kikobeats/whoops/commit/bccbf41))
-* updated bumped settings ([67ff23e](https://github.com/kikobeats/whoops/commit/67ff23e))
-
-
-
-<a name="0.1.2"></a>
-## 0.1.2 (2015-07-28)
-
-
-* 0.1.2 releases ([7273df6](https://github.com/kikobeats/whoops/commit/7273df6))
-
-
-
-<a name="0.1.1"></a>
-## 0.1.1 (2015-07-28)
-
-
-* 0.1.1 release ([6fcf6d7](https://github.com/kikobeats/whoops/commit/6fcf6d7))
-* 0.1.1 releases ([15d607b](https://github.com/kikobeats/whoops/commit/15d607b))
-* Update README.md ([d5e55b8](https://github.com/kikobeats/whoops/commit/d5e55b8))
-* Update README.md ([869be0a](https://github.com/kikobeats/whoops/commit/869be0a))
-* Update README.md ([8344dab](https://github.com/kikobeats/whoops/commit/8344dab))
-* updated dependencies ([afe3a10](https://github.com/kikobeats/whoops/commit/afe3a10))
-
-
-
-<a name="0.1.0"></a>
-# 0.1.0 (2015-07-26)
-
-
-* 0.1.0 releases ([594c110](https://github.com/kikobeats/whoops/commit/594c110))
-* added documentation and more examples ([3e68abb](https://github.com/kikobeats/whoops/commit/3e68abb))
-* first approach ([c52341b](https://github.com/kikobeats/whoops/commit/c52341b))
-* Update README.md ([e7172ab](https://github.com/kikobeats/whoops/commit/e7172ab))
-
-
-