Package Exports

@buzuli/json
@buzuli/json/lib/json.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@buzuli/json) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

json

Serialize JSON in color.

Installation

npm install --save @buzuli/json

Usage

const json = require('@buzuli/json')
const jsonOptions = { indent: 4 }

console.log(json(require('./package.json'), jsonOptions))

Customization

color

You can disable color via the color option (enabled by default). Set to a falsey value to disable.

indent

You can configure indentation via the indent option. Accepts a boolean, number, or string.

To disable, set to false or a negative number.

To customize then indentation:

You can specify a number which is translated as the number of spaces to indent.
You can supply a string to replace the default indentation text (two space).

CLI

There is a CLI utility paired with this module that is exposed as the command json.

This command has the same configuration options as the utility function.

Just pipe some data to it to format it with friendly colors.

cat package.json | json

Want a flat structure indented?

cat flat.json | json -C

Want an indented structure flattend?

cat indented.json | json -CI