Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Package for formatting JSON data in a coloured YAML-style, perfect for CLI output
JavaScript

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
docs
lib
site
spec
.gitignore
.travis.yml
AUTHORS
History.md
Jakefile
LICENSE
README.md
package.json

README.md

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

Using it (from the CLI)

This package installs a command line interface to render JSON data in a more convenient way. You can use the CLI in three different ways:

Decode a JSON file: If you want to see the contents of a JSON file, just pass it as the first argument to the CLI:

$ prettyjson package.json

Example 1

Decode the stdin: You can also pipe the result of a command (for example an HTTP request) to the CLI to see the JSON result in a clearer way:

$ curl https://api.github.com/users/rafeca | prettyjson

Example 2

Decode random strings: if you call the CLI with no arguments, you'll get a prompt where you can past JSON strings and they'll be automatically displayed in a clearer way:

Example 3

If you install the package globally (with npm install -g prettyjson), the CLI will be installed automatically in your PATH thanks to npm.

Using it (from Node.js)

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 4

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 5

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
Something went wrong with that request. Please try again.