summaryrefslogtreecommitdiff
path: root/vendor/github.com/TylerBrock/colorjson/README.md
blob: f5b1d26e84db9bc096ffa507c014bf665cfb67d1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
ColorJSON: The Fast Color JSON Marshaller for Go
================================================
![ColorJSON Output](https://i.imgur.com/pLtCXhb.png)
What is this?
-------------

This package is based heavily on hokaccha/go-prettyjson but has some noticible differences:
 - Over twice as fast (recursive descent serialization uses buffer instead of string concatenation)
   ```
   BenchmarkColorJSONMarshall-4     500000      2498 ns/op
   BenchmarkPrettyJSON-4            200000      6145 ns/op
   ```
 - more customizable (ability to have zero indent, print raw json strings, etc...)
 - better defaults (less bold colors)

ColorJSON was built in order to produce fast beautiful colorized JSON output for [Saw](http://github.com/TylerBrock/saw).

Installation
------------

```sh
go get -u github.com/TylerBrock/colorjson
```

Usage
-----

Setup

```go
import "github.com/TylerBrock/colorjson"

str := `{
  "str": "foo",
  "num": 100,
  "bool": false,
  "null": null,
  "array": ["foo", "bar", "baz"],
  "obj": { "a": 1, "b": 2 }
}`

// Create an intersting JSON object to marshal in a pretty format
var obj map[string]interface{}
json.Unmarshal([]byte(str), &obj)
```

Vanilla Usage

```go
s, _ := colorjson.Marshal(obj)
fmt.Println(string(s))
```

Customization (Custom Indent)
```go
f := colorjson.NewFormatter()
f.Indent = 2

s, _ := f.Marshal(v)
fmt.Println(string(s))
```