prettyjson / 1.0.0 last updated 5 months ago created on Oct 10th 2011
Install
npm install --save prettyjson
Clone
git clone git@github.com:rafeca/prettyjson.git
maintainers
versions
20 total
1.0.0 | 5 months ago | rafeca |
0.13.0 | 6 months ago | rafeca |
0.12.1 | 6 months ago | rafeca |
0.12.0 | 7 months ago | rafeca |
0.11.1 | 7 months ago | rafeca |
0.11.0 | 7 months ago | rafeca |
0.10.0 | 9 months ago | rafeca |
0.9.0 | 11 months ago | rafeca |
0.8.1 | a year ago | rafeca |
0.8.0 | 2 years ago | rafeca |
0.7.1 | 2 years ago | rafeca |
0.4.0 | 3 years ago | rafeca |
0.3.1 | 3 years ago | rafeca |
0.3.0 | 3 years ago | rafeca |
0.2.1 | 3 years ago | rafeca |
0.2.0 | 3 years ago | rafeca |
0.1.4 | 3 years ago | rafeca |
0.1.3 | 3 years ago | rafeca |
0.1.2 | 3 years ago | rafeca |
0.1.1 | 3 years ago | rafeca |
readme
prettyjson
Package for formatting JSON data in a coloured YAML-style, perfect for CLI output.
How to install
Just install it via NPM:
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:
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:
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:
If you install the package globally (with npm install -g prettyjson
), the CLI
will be installed automatically in your PATH thanks to npm.
Command line options
It's possible to customize the output through some command line options:
Deprecation Notice: The old configuration through environment variables is deprecated and it will be removed in the next major version (1.0.0).
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:
And will output:
You can also configure the colors of the hash keys and array dashes (using colors.js colors syntax):
Will output something like:
Running Tests
To run the test suite first invoke the following command within the repo, installing the development dependencies:
then run the tests:
On windows, you can run the tests with: