youch
    TypeScript icon, indicating that this package has built-in type declarations

    2.2.2 • Public • Published

    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)

    Adding helpful links

    Everytime an error occurs, we can help users we letting search for the error on Google, over even on the Github repo of our project.

    Youch let you define clickable links to redirect the user to a website with the error message.

    youch
    .addLink(({ message }) => {
      const url = `https://stackoverflow.com/search?q=${encodeURIComponent(`[adonis.js] ${message}`)}`
      return `<a href="${url}" target="_blank" title="Search on stackoverflow">Search stackoverflow</a>`
    })
    .toHTML()

    Also you can make use of Font awesome brands icons to display icons.

    If you will use fontawesome icons, then Youch will automatically load the CSS files from the font awesome CDN for you.

    youch
    .addLink(({ message }) => {
      const url = `https://stackoverflow.com/search?q=${encodeURIComponent(`[adonis.js] ${message}`)}`
      return `<a href="${url}" target="_blank" title="Search on stackoverflow"><i class="fab fa-stack-overflow"></i></a>`
    })
    .toHTML()

    Release History

    Checkout CHANGELOG.md file for release history.

    Meta

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

    Install

    npm i youch

    DownloadsWeekly Downloads

    28,990

    Version

    2.2.2

    License

    MIT

    Unpacked Size

    75.8 kB

    Total Files

    7

    Last publish

    Collaborators

    • virk