stacktrace-metadata

Modify given err object to be more useful - adds at, line, column, place and filename properties and also cleans stack traces.

You might also be interested in clean-stacktrace.

Highlights

• Works on Windows and Node.js >= 0.10
• Always normalizes Windows paths to be Unix-style
• Customizable through options
• Cleans stack trace using clean-stacktrace, opts.cleanStack: false to disable
• Passing different current working directory to use, opts.cwd, using clean-stacktrace-relative-paths
• Makes paths relative against opts.cwd, opts.relativePaths: false to disable
• Makes stack trace short - top 4, opts.shortStack: false to disable
• Allow hiding the stack trace (making it empty string), opts.showStack: false to enable
• Adds useful properties like line, column and filename, using clean-stacktrace-metadata

Table of Contents

• Install
• Usage
• API
  • stacktraceMetadata
• Related
• Contributing
• Building docs
• Running tests
• Author
• License

(TOC generated by verb using markdown-toc)

Install

Install with npm

$ npm install stacktrace-metadata --save

or install using yarn

$ yarn add stacktrace-metadata

Usage

For more use-cases see the tests

const stacktraceMetadata = require('stacktrace-metadata')

API

stacktraceMetadata

Cleans stack trace and attaches few more metadata properties, such as at, line, column, filename and place. By default it cleans stack, makes is short (4 length) and makes paths relative. But all this is controllable through options object. Throws TypeError if error is not an instance of Error.

Params

• error {Error}: real error object, checked against instanceof Error
• options {Object}: optional options object for more control
• options.cleanStack {Boolean}: if false won't clean stack trace from node internals
• options.shortStack {Boolean}: if false full stack traces, otherwise they are just four
• options.showStack {Boolean}: if false the error.stack will be empty string
• options.relativePaths {Boolean}: if false paths in stack traces will be absolute
• options.mapper {Function}: called on each line of the stack with (line, index) signature
• options.cwd {String}: current working directory, default process.cwd()
• returns {Error}: same error object, but modified

Example

const metadata = require('stacktrace-metadata')

const error = new Error('foo quxie')
error.stack = `Error: foo quxie
    at zazz (/home/charlike/apps/alwa.js:8:10)
    at module.exports (/home/charlike/apps/foo.js:6:3)
    at Object.<anonymous> (/home/charlike/apps/dush.js:45:3)
    at Module._compile (module.js:409:26)
    at Object.Module._extensions..js (module.js:416:10)
    at Module.load (module.js:343:32)
    at Function.Module._load (module.js:300:12)
    at Function.Module.runMain (module.js:441:10)
    at startup (node.js:139:18)
`
const err = metadata(error)

console.log(err.line) // => 8
console.log(err.column) // => 10
console.log(err.filename) // => 'alwa.js'
console.log(err.place) // => 'zazz'
console.log(err.at) // => 'zazz (alwa.js:8:10)'
console.log(err.stack)
// =>
// Error: foo quxie
//     at zazz (alwa.js:8:10)
//     at module.exports (foo.js:6:3)
//     at Object.<anonymous> (dush.js:45:3)

Related

• abbrev-kindof: Use abbreviations for checking type of given value. Like kindof(val, 'soa') to check that value is string, object or array. | homepage
• assert-kindof: Check native type of value and throw AssertionError if not okey. Clean stack traces. Simplicity. Built on is-kindof. | homepage
• clean-stack: Clean up error stack traces | homepage
• clean-stacktrace-metadata: Plugin for clean-stacktrace lib. Parse each line to get additional info like filename, column and line of the error. | homepage
• clean-stacktrace-relative-paths: Meant to be used with clean-stacktrace as mapper function. Makes absolute paths inside stack traces to relative paths. | homepage
• clean-stacktrace: Clean up error stack traces from node internals | homepage
• dush: Microscopic & functional event emitter in ~260 bytes, extensible through plugins. | homepage
• is-kindof: Check type of given javascript value. Support promises, generators, streams, and native types. Built on kind-of lib. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guidelines for advice on opening issues, pull requests, and coding standards.
If you need some help and can spent some cash, feel free to contact me at CodeMentor.io too.

In short: If you want to contribute to that project, please follow these things

1. Please DO NOT edit README.md, CHANGELOG.md and .verb.md files. See "Building docs" section.
2. Ensure anything is okey by installing the dependencies and run the tests. See "Running tests" section.
3. Always use npm run commit to commit changes instead of git commit, because it is interactive and user-friendly. It uses commitizen behind the scenes, which follows Conventional Changelog idealogy.
4. Do NOT bump the version in package.json. For that we use npm run release, which is standard-version and follows Conventional Changelog idealogy.

Thanks a lot! :)

Building docs

Documentation and that readme is generated using verb-generate-readme, which is a verb generator, so you need to install both of them and then run verb command like that

$ npm install verbose/verb#dev verb-generate-readme --global && verb

Please don't edit the README directly. Any changes to the readme must be made in .verb.md.

Running tests

Clone repository and run the following in that cloned directory

$ npm install && npm test

Author

Charlike Mike Reagent

• github/tunnckoCore
• twitter/tunnckoCore
• codementor/tunnckoCore

License

Copyright © 2015, 2017, Charlike Mike Reagent. Released under the MIT License.

This file was generated by verb-generate-readme, v0.4.3, on March 15, 2017.
Project scaffolded using charlike cli.