json-colorizer

A library for colorizing JSON strings


This package is a simple console syntax highlighter for JSON.

Installation

npm install --save json-colorizer

Usage

``js
const { colorize } = require('json-colorizer');
console.log(colorize({ "foo": "bar" }));
`

You can also pass a JavaScript object to the colorize function:

`js
const { colorize } = require('json-colorizer');
console.log(colorize({
foo: 'bar',
baz: 42
}));
`

Pretty-printing output

By default, the output JSON will be pretty-printed with an indentation of 2 spaces. You can adjust this by passing the indent option.

`js
const { colorize } = require('json-colorizer');
console.log(colorize({
foo: 'bar',
baz: 42
}, { indent: 4 }));
`

Customizing the colors

You can override any of the colors used for token types by providing a colors option. This should map token types to the names of color functions. These color functions are contained in the color object exported by the library.

`js
const { colorize, color } = require('json-colorizer');

console.log(colorize({ foo: 'bar' }, {
colors: {
StringLiteral: color.red
}
}));
`

The list of valid token types and color functions are listed below.

$3

- Brace: curly braces ({, })
- Bracket: square brackets ([, ])
- Colon: colon character (:)
- Comma: comma character (,)
- StringKey: the key in a key/value pair
- NumberLiteral: a number value
- StringLiteral: a string value
- BooleanLiteral: a boolean literal (true, false)
- NullLiteral: the literal null value

$3

- black
- red
- green
- yellow
- blue
- magenta
- cyan
- white
- gray`