Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

72 lines (43 sloc) 1.991 kb

prettyjson Build Status

Package for formatting JSON data in a coloured YAML-style, perfect for CLI output

How to install

The easiest way is by installing it from the npm repository:

$ npm install prettyjson

If you'd prefer to install the latest master version of prettyjson, you can clone the GitHub source repository and then install it using npm:

$ git clone "https://github.com/rafeca/prettyjson.git"

$ npm install prettyjson/

How to use it

It's pretty easy to use it... you just have to include it in your script and call the render() method:

var prettyjson = require('prettyjson');

var data = {
  username: 'rafeca',
  url: 'https://github.com/rafeca',
  twitter_account: 'https://twitter.com/rafeca',
  projects: ['prettyprint', 'connfu']
};

console.log(prettyjson.render(data));

And will output:

Example 1

You can also configure the colors of the hash keys and array dashes (using colors.js colors syntax):

var prettyjson = require('prettyjson');

var data = {
  username: 'rafeca',
  url: 'https://github.com/rafeca',
  twitter_account: 'https://twitter.com/rafeca',
  projects: ['prettyprint', 'connfu']
};

console.log(prettyjson.render(data, {
  keysColor: 'rainbow', 
  dashColor: 'magenta'
}));

Will output something like:

Example 2

Annotated source

You can check the annotated source for more information about how it works

Running Tests

To run the test suite first invoke the following command within the repo, installing the development dependencies:

$ npm install --dev

then run the tests:

$ npm test
Jump to Line
Something went wrong with that request. Please try again.