ariaminaei

pretty-error

alexgorbatchev

  "description": "See nodejs errors with less clutter",

    "test": "mocha \"test/**/*.coffee\"",

    "test:watch": "mocha \"test/**/*.coffee\" --watch",

    "compile": "coffee --bare --compile --output ./lib ./src",

    "compile:watch": "jitter src lib -b",

    "watch": "npm run compile:watch & npm run test:watch",

    "winwatch": "start/b npm run compile:watch & npm run test:watch",

    "url": "https://github.com/AriaMinaei/pretty-error.git"

    "url": "https://github.com/AriaMinaei/pretty-error/issues"

[![Dependency status](https://david-dm.org/AriaMinaei/pretty-error.svg)](https://david-dm.org/AriaMinaei/pretty-error)

[![Build Status](https://secure.travis-ci.org/AriaMinaei/pretty-error.svg?branch=master)](https://travis-ci.org/AriaMinaei/pretty-error)

[![Build Status](https://secure.travis-ci.org/AriaMinaei/pretty-error.svg?branch=master)](https://travis-ci.org/AriaMinaei/pretty-error) [![npm](https://img.shields.io/npm/dm/pretty-error.svg)](https://npmjs.org/package/pretty-error)

[![NPM](https://nodei.co/npm/pretty-error.svg)](https://npmjs.org/package/pretty-error)

A small tool to see node.js errors with less clutter:

![screenshot of pretty-error](https://github.com/AriaMinaei/pretty-error/raw/master/docs/images/pretty-error-screenshot.png)

... which is more readable compared to node's unformatted errors:

![screenshot of normal errors](https://github.com/AriaMinaei/pretty-error/raw/master/docs/images/normal-error-screenshot.png)

To see an error rendered with colors, you can do this:

var PrettyError = require('pretty-error');

var renderedError = pe.render(new Error('Some error message'));

Of course, you can render caught exceptions too:

But if you want pretty-error to render all errors, there is a shortcut for it:

// instantiate PrettyError, which can then be used to render error objects

You can also preload pretty-error into your code using node's [`--require`](https://nodejs.org/api/cli.html#cli_r_require_module) argument:

$ node --require pretty-error/start your-module.js

PrettyError turns error objects into something similar to an html document, and then uses [RenderKid](https://github.com/AriaMinaei/renderkid) to render the document using simple html/css-like commands. This allows PrettyError to be themed using simple css-like declarations.

PrettyError's default theme is a bunch of simple css-like rules. [Here](https://github.com/AriaMinaei/pretty-error/blob/master/src/defaultStyle.coffee) is the source of the default theme.

Since the default theme is all css, you can customize it to fit your taste. Let's do a minimal one:

// the start() shortcut returns an instance of PrettyError ...

// ... which we can then use to customize like this:

   // this is a simple selector to the element that says 'Error'

   'pretty-error > header > title > kind': {

      // we can use black, red, green, yellow, blue, magenta, cyan, white,

      // grey, bright-red, bright-green, bright-yellow, bright-blue,

      // bright-magenta, bright-cyan, and bright-white

      // we can also change the background color:

      padding: '0 1' // top/bottom left/right

      // The string inside the quotation mark gets used as the character

      // You can set its color/background color using tags.

      // This example sets the background color to white, and the text color

      // to cyan, the character will be a hyphen with a space character

      // example: '"<bg-white><cyan> - </cyan></bg-white>"'

      // Note that we should use a margin of 3, since the bullet will be

   'pretty-error > trace > item > header > pointer > file': {

   'pretty-error > trace > item > header > pointer > colon': {

   'pretty-error > trace > item > header > pointer > line': {

   'pretty-error > trace > item > header > what': {

   'pretty-error > trace > item > footer > addr': {

This is how our minimal theme will look like: ![screenshot of our custom theme](https://github.com/AriaMinaei/pretty-error/raw/master/docs/images/custom-theme-screenshot.png)

Read [RenderKid](https://github.com/AriaMinaei/renderkid)'s docs to learn about all the css rules that are supported.

There are a few methods to help you customize the contents of your error logs.

		{
		"name": "pretty-error",
		"version": "2.0.3",
		"version": "2.1.0",
		"description": "See nodejs errors with less clutter",
		@@ -5,0 +5,0 @@ "main": "./lib/PrettyError.js",

		# pretty-error

		[![Dependency status](https://david-dm.org/AriaMinaei/pretty-error.svg)](https://david-dm.org/AriaMinaei/pretty-error)
		[![Build Status](https://secure.travis-ci.org/AriaMinaei/pretty-error.svg?branch=master)](https://travis-ci.org/AriaMinaei/pretty-error)
		[![Build Status](https://secure.travis-ci.org/AriaMinaei/pretty-error.svg?branch=master)](https://travis-ci.org/AriaMinaei/pretty-error) [![npm](https://img.shields.io/npm/dm/pretty-error.svg)](https://npmjs.org/package/pretty-error)

		[![NPM](https://nodei.co/npm/pretty-error.svg)](https://npmjs.org/package/pretty-error)

		A small tool to see node.js errors with less clutter:
		@@ -60,2 +58,8 @@

		You can also preload pretty-error into your code using node's [`--require`](https://nodejs.org/api/cli.html#cli_r_require_module) argument:

		```
		$ node --require pretty-error/start your-module.js
		```

		## How it Works
		@@ -319,2 +323,2 @@

		MIT
		MIT

Improved metrics