herro
v0.2.6
Published
humanized stack traces for the error class
Downloads
374
Maintainers
Readme
herro!
What if stack traces looked like this?
Error: something broke
at Context.<anonymous> (./test/Herror.js:9:17)
at callFn ([email protected]/lib/runnable.js:266:21)
at Test.Runnable.run ([email protected]/lib/runnable.js:259:7)
at Runner.runTest ([email protected]/lib/runner.js:390:10)
at [email protected]/lib/runner.js:473:12
at next ([email protected]/lib/runner.js:315:14)
at [email protected]/lib/runner.js:325:7
at next ([email protected]/lib/runner.js:260:23)
at Immediate._onImmediate ([email protected]/lib/runner.js:292:5)
at processImmediate [as _immediateCallback] (timers.js:369:17)
--
cwd /Users/stringparser/code/herro
node-v1.5.0 2015-06-14T16:09:05.544Z
Changes paths that have
- The current working directory with
.
node_modules/<module>
with<module>@<version>
Adds a footer with
- The current working directory
- An ISO date and node version from were
error
was thrown
api
var herro = require('herro');
The module.exports
two functions
herro.Herror
herro.global
Herror
function Herror(String message)
Error
class with paths on its stack trace as <module>@<version>
instead of node_modules/<module>
. Inherits from the Error
class.
arguments
message
type string message for the error
returns
- a new
error
instance
usage
var Herror = require('herro').Herror;
if('something broke'){
throw new Herror('oh, no, you did not!');
}
global
function global([Boolean flag])
If flag
is truthy or undefined
, it will make all stack traces
have <module>@<version>
instead of node_modules/<module>
. If flag
is falsy it will revert stacktraces to their default format.
usage
var herro = require('herro');
herro.global(); // make it global
herro.global(false); // go back to the normal stack format
install
With npm
npm install herro
test
herro (master) ✔ npm test
herro
Herror
✓ should format stack traces
✓ should have an ISO date string
✓ should have the current node version
✓ should have the current working directory
npmize
✓ CWD/node_modules/module/file.js into module@version
✓ CWD/node_modules/m1/node_modules/m2/file.js into m1@version/m2@version2
global
✓ global(truthy || undefined) npmizes stacks
✓ global(falsy) brings back default format
8 passing (21ms)
license
The MIT License (MIT)
Copyright (c) 2014-present Javier Carrillo
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.