Novelty Plastic Moustache

    clean-stacktrace

    1.1.0 • Public • Published

    clean-stacktrace NPM version mit license NPM monthly downloads npm total downloads

    Clean up error stack traces from node internals

    code climate code style linux build windows build code coverage dependency status paypal donate

    You might also be interested in stack-utils.

    Table of Contents

    (TOC generated by verb using markdown-toc)

    Install

    Install with npm

    $ npm install clean-stacktrace --save
    

    or install using yarn

    $ yarn add clean-stacktrace
    

    Usage

    For more use-cases see the tests

    const cleanStacktrace = require('clean-stacktrace')

    API

    cleanStacktrace

    Removes mostly not needed internal Nodejs entries. If you pass mapper function, you can make more changes to each line of the stack - for example making the paths to be relative, not absolute.

    Params

    • stack {String}: an error stack trace
    • mapper {Function}: more customization for each line
    • returns {String}: modified and cleaned stack

    Example

    var cleanStack = require('clean-stacktrace')
    var error = new Error('Missing unicorn')
     
    console.log(error.stack)
    // =>
    // Error: Missing unicorn
    //     at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15)
    //     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)
     
    console.log(cleanStack(error.stack))
    // =>
    // Error: Missing unicorn
    //     at Object.<anonymous> (/Users/sindresorhus/dev/clean-stack/unicorn.js:2:15)
     
    // or making paths relative
    var path = require('path')
    var stack = clean(error.stack, (line) => {
      var m = /.*\((.*)\).?/.exec(line) || []
      return m[1] ? line.replace(m[1], path.relative(process.cwd(), m[1])) : line
    })
    // =>
    // Error: Missing unicorn
    //     at Object.<anonymous> (unicorn.js:2:15)

    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
    • minibase: Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… more | 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

    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

    License

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


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

    Install

    npm i clean-stacktrace

    DownloadsWeekly Downloads

    4,034

    Version

    1.1.0

    License

    MIT

    Last publish

    Collaborators

    • vanchoy
    • tunnckocore