https://github.com/nknapp/trace-and-clarify-if-possible

Use `trace` and `clarify` if supported by the current node version
https://github.com/nknapp/trace-and-clarify-if-possible

Last synced: 6 days ago
JSON representation

Use `trace` and `clarify` if supported by the current node version

• Host: GitHub
• URL: https://github.com/nknapp/trace-and-clarify-if-possible
• Owner: nknapp
• License: mit
• Created: 2016-12-19T20:53:32.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2019-02-16T20:42:37.000Z (over 5 years ago)
• Last Synced: 2024-10-06T03:41:35.365Z (about 1 month ago)
• Language: JavaScript
• Size: 101 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# trace-and-clarify-if-possible 

[![NPM version](https://img.shields.io/npm/v/trace-and-clarify-if-possible.svg)](https://npmjs.com/package/trace-and-clarify-if-possible)

[![Travis Build Status](https://travis-ci.org/nknapp/trace-and-clarify-if-possible.svg?branch=master)](https://travis-ci.org/nknapp/trace-and-clarify-if-possible)

[![Coverage Status](https://img.shields.io/coveralls/nknapp/trace-and-clarify-if-possible.svg)](https://coveralls.io/r/nknapp/trace-and-clarify-if-possible)

> Use `trace` and `clarify` if supported by the current node version

[trace](https://npmjs.com/package/trace) and [clarify](https://npmjs.com/package/clarify) can help greatly to analyze stack-traces

* `trace` shows the part of the stack that would otherwise disappear due to asynchronous callbacks

* `clarify` removes uninteresting parts of the stack

Sadly, `trace` can is only compatible with NodeJS version >=4. It makes sense to include `trace` in your tests all the time (not in production code though). However, when you run the test in [Travis CI](https://travis-ci.org/) with multiple node versions <4, the tests will break.

This package include `trace` and `clarify` only for supported node versions.

# Installation

```

npm install trace-and-clarify-if-possible

```

## Usage

Put the following line a module that is loaded at the start of your program or testcase-spec (remember, do not use in production).

```js

require('trace-and-clarify-if-possible')

```

Or, you can put `--require trace-and-clarify-if-possible into your `test/mocha.opts` to activate it for all tests

# License

`trace-and-clarify-if-possible` is published under the MIT-license.

See [LICENSE.md](LICENSE.md) for details.

# Release-Notes

 

For release notes, see [CHANGELOG.md](CHANGELOG.md)

 

# Contributing guidelines

See [CONTRIBUTING.md](CONTRIBUTING.md).