Socket
Socket
Sign inDemoInstall

prettyjson

Package Overview
Dependencies
2
Maintainers
1
Versions
35
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

prettyjson

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


Version published
Maintainers
1
Weekly downloads
777,545
decreased by-9.47%

Weekly downloads

Readme

Source

prettyjson Build Status NPM version Coverage Status

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

How to install

Just install it via NPM:

$ npm install -g prettyjson

This will install prettyjson globally, so it will be added automatically to your PATH.

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

Command line options

It's possible to customize the output through some command line options:

# Change colors
$ prettyjson --string=red --multiline_string=cyan --keys=blue --dash=yellow --number=green package.json

# Do not use colors
$ prettyjson --nocolor=1 package.json

# Change indentation
$ prettyjson --indent=4 package.json

# Render arrays elements in a single line
$ prettyjson --inline-arrays=1 package.json

# Escape conflictive strings
$ prettyjson --escape=1 package.json

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:

var prettyjson = require('prettyjson');

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

var options = {
  noColor: true
};

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

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',
  stringColor: 'white',
  multilineStringColor: 'cyan'
}));

Will output something like:

Example 5

Running Tests

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

$ npm install

then run the tests:

$ npm test

On windows, you can run the tests with:

C:\git\prettyjson> npm run-script testwin

Keywords

FAQs

Last updated on 11 Jan 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc