beauty-error/index.js

Getting a beauty error. Oriented for well printed errors. Be beauty, no ugly.

'use strict'

const { flow, isNil, castArray, first } = require('lodash')
const PrettyError = require('pretty-error')
const ensureError = require('ensure-error')
const cleanStack = require('clean-stack')
const isIterable = require('is-iterable')

const DEFAULT_PRETTY = {
  // this is a simple selector to the element that says 'Error'
  'pretty-error > header > title > kind': {
    background: 'none',
    color: 'bright-red',
    marginRight: 1
  },

  'pretty-error > header > colon': {
    display: 'none'
  },

  'pretty-error > header > message': {
    color: 'grey'
  },

  'pretty-error > trace > item > header > pointer > file': {
    color: 'grey'
  },

  'pretty-error > trace > item > header > pointer > colon': {
    color: 'grey'
  },

  'pretty-error > trace > item > header > pointer > line': {
    color: 'grey'
  },

  'pretty-error > trace > item > header > what': {
    color: 'grey'
  }
}

const createPretty = opts => {
  const pretty = new PrettyError()
  pretty.appendStyle(opts)
  return pretty
}

const pretty = createPretty(DEFAULT_PRETTY)

const getPretty = opts => (isNil(opts) ? pretty : createPretty(opts))

const cleanError = error => {
  if (error.stack) {
    try {
      error.stack = cleanStack(error.stack)
    } catch (_) {}
  }

  return error
}

const beautyError = (error, opts) => {
  const pretty = getPretty(opts)
  return pretty.render(error)
}

const getError = rawError => {
  const genericError = ensureError(rawError)

  return first(isIterable(genericError) ? Array.from(genericError) : castArray(genericError))
}

module.exports = flow([getError, cleanError, beautyError])
module.exports.beautyError = beautyError
module.exports.cleanError = cleanError
module.exports.getError = getError