Skip to content

futurestudio/youch

 
 

Repository files navigation

Youch!

Pretty error reporting for Node.js 🚀





NPM Version Build Status Downloads Stats Appveyor

Gitter Channel Trello Patreon

Youch is inspired by Whoops but with a modern design. Reading stack trace of the console slows you down from active development. Instead Youch print those errors in structured HTML to the browser.

Features

  1. HTML reporter
  2. JSON reporter, if request accepts a json instead of text/html.
  3. Sorted frames of error stack.

Checkout youch terminal to beautify errors on terminal.

Installation

npm i --save youch

Basic Usage

Youch is used by AdonisJs, but it can be used by express or raw HTTP server as well.

const Youch = require('youch')
const http = require('http')

http.createServer(function (req, res) {

  // PERFORM SOME ACTION
  if (error) {
    const youch = new Youch(error, req)

    youch
    .toHTML()
    .then((html) => {
      res.writeHead(200, {'content-type': 'text/html'})
      res.write(html)
      res.end()
    })
  }

}).listen(8000)

Release History

Checkout CHANGELOG.md file for release history.

Meta

Checkout LICENSE.md for license information Harminder Virk (Aman) - https://github.com/thetutlage

About

Pretty error reporting for Node.js 🚀

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • JavaScript 50.8%
  • HTML 41.4%
  • CSS 7.8%