clean-stacktrace-metadata
v1.0.6
Published
Plugin for `clean-stacktrace` lib. Parse each line to get additional info like `filename`, `column` and `line` of the error.
Downloads
75
Readme
clean-stacktrace-metadata
Plugin for
clean-stacktrace
lib. Parse each line to get additional info likefilename
,column
andline
of the error.
You might also be interested in clean-stacktrace.
Table of Contents
Install
Install with npm
$ npm install clean-stacktrace-metadata --save
or install using yarn
$ yarn add clean-stacktrace-metadata
Usage
For more use-cases see the tests
const cleanStacktraceMetadata = require('clean-stacktrace-metadata')
API
cleanStacktraceMetadata
Parses each line in stack and pass
info
object to the givenplugin
function. Thatplugin
function is passed with(line, info, index)
signature, whereline
is string representing the stacktrace line, andinfo
is an object with.line
,.column
and.filename
properties. That's useful, you can attach them to some error object.
Meant to be used inside mapper
of the clean-stacktrace,
another useful mapper is clean-stacktrace-relative-paths to show
relative paths inside stacktrace, instead of absolute paths.
Params
plugin
{Function}: A function passed with(line, info, index)
signature.returns
{Function}mapper
: Function that can be passed to clean-stacktrace
Example
const metadata = require('clean-stacktrace-metadata')
const cleanStack = require('clean-stacktrace')
const err = new Error('Missing unicorn')
console.log(error.stack)
// =>
// Error: Missing unicorn
// at quxie (/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 mapper = metadata((line, info, index) => {
if (index === 1) {
err.line = info.line
err.column = info.column
err.filename = info.filename
err.place = info.place
}
return line
})
const stack = cleanStack(error.stack, mapper)
console.log(stack)
// =>
// Error: Missing unicorn
// at quxie (/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)
console.log(err.place) // => 'quxie'
console.log(err.line) // => 8
console.log(err.column) // => 10
console.log(err.filename) // => '/home/charlike/apps/alwa.js'
Related
- always-done: Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement… more | 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-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
- is-kindof: Check type of given javascript value. Support promises, generators, streams, and native types. Built on kind-of lib. | homepage
- minibase: Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… more | homepage
- stacktrace-metadata: Modify given
err
object to be more useful. Addsline
,column
andfilename
properties. | homepage - try-catch-core: Low-level package to handle completion and errors of sync or asynchronous functions, using once and dezalgo libs. Useful for and… more | 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
- Please DO NOT edit README.md, CHANGELOG.md and .verb.md files. See "Building docs" section.
- Ensure anything is okey by installing the dependencies and run the tests. See "Running tests" section.
- Always use
npm run commit
to commit changes instead ofgit commit
, because it is interactive and user-friendly. It uses commitizen behind the scenes, which follows Conventional Changelog idealogy. - 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
License
Copyright © 2017, Charlike Mike Reagent. Released under the MIT License.
This file was generated by verb-generate-readme, v0.4.3, on March 13, 2017.
Project scaffolded using charlike cli.