Meant to be used with [clean-stacktrace][] as mapper function. Makes absolute paths inside stack traces to relative paths.
npm install clean-stacktrace-relative-paths> Meant to be used with [clean-stacktrace][] as mapper function. Makes absolute paths inside stack traces to relative paths.
[![code climate][codeclimate-img]][codeclimate-url]
[![code style][standard-img]][standard-url]
[![linux build][travis-img]][travis-url]
[![windows build][appveyor-img]][appveyor-url]
[![code coverage][coverage-img]][coverage-url]
[![dependency status][david-img]][david-url]
[![paypal donate][paypalme-img]][paypalme-url]
You might also be interested in always-done.
_(TOC generated by verb using markdown-toc)_
``
$ npm install clean-stacktrace-relative-paths --save
or install using yarn
`
$ yarn add clean-stacktrace-relative-paths
`js`
const cleanStacktraceRelativePaths = require('clean-stacktrace-relative-paths')
if you want to customize, otherwise process.cwd() is used by default.Meant to be used as
mapper argument in [clean-stacktrace][]Params
*
[cwd] {String}: custom current working directory
* returns {Function}: a function that can be passed as mapper to [clean-stacktrace][] Example
`js
const cleanStack = require('clean-stacktrace')
const relativePaths = require('clean-stacktrace-relative-paths')const error = new Error('Missing unicorn')
console.log(error.stack)
// =>
// Error: Missing unicorn
// at Object. (/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)
const mapper = relativePaths()
const stack = cleanStack(error.stack, mapper)
console.log(stack)
// =>
// Error: Missing unicorn
// at Object. (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
- assert-kindof: Check native type of value and throw AssertionError if not okey. Clean stack traces. Simplicity. Built on [is-kindof][]. | homepage
- clean-stacktrace: Clean up error stack traces - just a fork of [clean-stack][]. Working on node.js v0.10 and above. | homepage
- is-async-function: Is function really asynchronous function? Trying to guess that based on check if [common-callback-names][] exists as function arguments names or… more | homepage
- kind-of-extra: Additional functionality to [kind-of][] type check utility. Support promises, generators, streams, errors. | homepage
- minibase: Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… more | homepage
- redolent: Simple promisify with sane defaults, works on node 0.10 if you provide custom Promise through options | 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 | homepageContributing
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
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
+ github/tunnckoCore
+ twitter/tunnckoCore
+ codementor/tunnckoCore
*
_This file was generated by verb-generate-readme, v0.4.3, on March 12, 2017._
_Project scaffolded using [charlike][] cli._
[always-done]: https://github.com/hybridables/always-done
[async-done]: https://github.com/gulpjs/async-done
[base]: https://github.com/node-base/base
[charlike]: https://github.com/tunnckocore/charlike
[clean-stack]: https://github.com/sindresorhus/clean-stack
[clean-stacktrace]: https://github.com/tunnckocore/clean-stacktrace
[commitizen]: https://github.com/commitizen/cz-cli
[common-callback-names]: https://github.com/tunnckocore/common-callback-names
[dezalgo]: https://github.com/npm/dezalgo
[is-kindof]: https://github.com/tunnckocore/is-kindof
[kind-of]: https://github.com/jonschlinkert/kind-of
[once]: https://github.com/isaacs/once
[standard-version]: https://github.com/conventional-changelog/standard-version
[verb-generate-readme]: https://github.com/verbose/verb-generate-readme
[verb]: https://github.com/verbose/verb
[license-url]: https://www.npmjs.com/package/clean-stacktrace-relative-paths
[license-img]: https://img.shields.io/npm/l/clean-stacktrace-relative-paths.svg
[downloads-url]: https://www.npmjs.com/package/clean-stacktrace-relative-paths
[downloads-img]: https://img.shields.io/npm/dt/clean-stacktrace-relative-paths.svg
[codeclimate-url]: https://codeclimate.com/github/tunnckoCore/clean-stacktrace-relative-paths
[codeclimate-img]: https://img.shields.io/codeclimate/github/tunnckoCore/clean-stacktrace-relative-paths.svg
[travis-url]: https://travis-ci.org/tunnckoCore/clean-stacktrace-relative-paths
[travis-img]: https://img.shields.io/travis/tunnckoCore/clean-stacktrace-relative-paths/master.svg?label=linux
[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/clean-stacktrace-relative-paths
[appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/clean-stacktrace-relative-paths/master.svg?label=windows
[coverage-url]: https://codecov.io/gh/tunnckoCore/clean-stacktrace-relative-paths
[coverage-img]: https://img.shields.io/codecov/c/github/tunnckoCore/clean-stacktrace-relative-paths/master.svg
[david-url]: https://david-dm.org/tunnckoCore/clean-stacktrace-relative-paths
[david-img]: https://img.shields.io/david/tunnckoCore/clean-stacktrace-relative-paths.svg
[standard-url]: https://github.com/feross/standard
[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[paypalme-url]: https://www.paypal.me/tunnckoCore
[paypalme-img]: https://img.shields.io/badge/paypal-donate-brightgreen.svg