catamphetamine / print-error

Javascript print error stack trace (pretty, terminal, html, markdown, etc)
MIT License
1 stars 2 forks source link

print-error

npm version npm downloads coverage

Prints javascript error stack trace in different flavours:

Installation

npm install print-error --save

Usage

import {
    html,
    htmlErrorStack,
    HTML_ERROR_STACK_STYLE,
    markdown,
    terminal
} from 'print-error'

// Outputs an HTML page.
html(new Error(), { fontSize: '16px' })

// Outputs just the contents of the `<body/>` of the HTML page.
htmlErrorStack(new Error())

// Outputs Markdown.
markdown(new Error())

// Outputs colored terminal output.
terminal(new Error())

Terminal

This library uses pretty-error for coloured terminal error stack trace printing.

Contributing

After cloning this repo, ensure dependencies are installed by running:

npm install

This module is written in ES6 and uses Babel for ES5 transpilation. Widely consumable JavaScript can be produced by running:

npm run build

Once npm run build has run, you may import or require() directly from node.

After developing, the full test suite can be evaluated by running:

npm test

When you're ready to test your new functionality on a real project, you can run

npm pack

It will build, test and then create a .tgz archive which you can then install in your project folder

npm install [module name with version].tar.gz

License

MIT