https://github.com/joeattardi/json-colorizer

A library for colorizing JSON strings
https://github.com/joeattardi/json-colorizer

chalk json syntax-highlighting

Last synced: 1 day ago
JSON representation

A library for colorizing JSON strings

• Host: GitHub
• URL: https://github.com/joeattardi/json-colorizer
• Owner: joeattardi
• License: mit
• Created: 2016-10-29T01:29:25.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2024-04-30T11:07:44.000Z (7 months ago)
• Last Synced: 2024-05-02T00:47:46.333Z (7 months ago)
• Topics: chalk, json, syntax-highlighting
• Language: TypeScript
• Size: 200 KB
• Stars: 81
• Watchers: 6
• Forks: 18
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# JSON Colorizer

![Logo](logo.png)

A library for colorizing JSON strings

![](https://raw.githubusercontent.com/joeattardi/json-colorizer/master/screenshot.png)

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.

### Token types

- `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

### Color functions in the `color` object

- `black`

- `red`

- `green`

- `yellow`

- `blue`

- `magenta`

- `cyan`

- `white`

- `gray`