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 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
|
// Package jsoncolor is a replacement for encoding/json's Marshal and
// MarshalIndent producing colorized output.
package jsoncolor
import (
"bytes"
"encoding/json"
"fmt"
"io"
"strings"
"github.com/fatih/color"
)
// Marshal is like encoding/json's Marshal but colorizes the output.
func Marshal(v interface{}) ([]byte, error) {
return marshalIndent(v, "", "")
}
// MarshalIndent is like encoding/json's MarshalIndent but colorizes
// the output.
func MarshalIndent(v interface{}, prefix, indent string) ([]byte, error) {
return marshalIndent(v, prefix, indent)
}
func marshalIndent(v interface{}, prefix, indent string) ([]byte, error) {
f := NewFormatter()
f.Prefix = prefix
f.Indent = indent
b, err := json.Marshal(v)
if err != nil {
return nil, err
}
buf := bytes.NewBuffer(make([]byte, 0, len(b)))
err = f.Format(buf, b)
if err != nil {
return nil, err
}
return buf.Bytes(), nil
}
type frame struct {
object bool
field bool
array bool
empty bool
indent int
}
func (f *frame) inArray() bool {
if f == nil {
return false
}
return f.array
}
func (f *frame) inObject() bool {
if f == nil {
return false
}
return f.object
}
func (f *frame) inArrayOrObject() bool {
if f == nil {
return false
}
return f.object || f.array
}
func (f *frame) inField() bool {
if f == nil {
return false
}
return f.object && f.field
}
func (f *frame) toggleField() {
if f == nil {
return
}
f.field = !f.field
}
func (f *frame) isEmpty() bool {
if f == nil {
return false
}
return (f.object || f.array) && f.empty
}
type SprintfFuncer interface {
SprintfFunc() func(format string, a ...interface{}) string
}
var (
DefaultSpaceColor = color.New()
DefaultCommaColor = color.New(color.Bold)
DefaultColonColor = color.New(color.Bold)
DefaultObjectColor = color.New(color.Bold)
DefaultArrayColor = color.New(color.Bold)
DefaultFieldQuoteColor = color.New(color.FgBlue, color.Bold)
DefaultFieldColor = color.New(color.FgBlue, color.Bold)
DefaultStringQuoteColor = color.New(color.FgGreen)
DefaultStringColor = color.New(color.FgGreen)
DefaultTrueColor = color.New()
DefaultFalseColor = color.New()
DefaultNumberColor = color.New()
DefaultNullColor = color.New(color.FgBlack, color.Bold)
// By default, no prefix is used.
DefaultPrefix = ""
// By default, an indentation of two spaces is used.
DefaultIndent = " "
)
// Formatter colorizes buffers containing JSON.
type Formatter struct {
// Color for whitespace characters.
SpaceColor SprintfFuncer
// Color for comma character ',' delimiting object and array
// fields.
CommaColor SprintfFuncer
// Color for colon character ':' separating object field names
// and values.
ColonColor SprintfFuncer
// Color for object delimiter characters '{' and '}'.
ObjectColor SprintfFuncer
// Color for array delimiter characters '[' and ']'.
ArrayColor SprintfFuncer
// Color for quotes '" surrounding object field names.
FieldQuoteColor SprintfFuncer
// Color for object field names.
FieldColor SprintfFuncer
// Color for quotes '"' surrounding string values.
StringQuoteColor SprintfFuncer
// Color for string values.
StringColor SprintfFuncer
// Color for 'true' boolean values.
TrueColor SprintfFuncer
// Color for 'false' boolean values.
FalseColor SprintfFuncer
// Color for number values.
NumberColor SprintfFuncer
// Color for null values.
NullColor SprintfFuncer
// Prefix is prepended before indentation to newlines.
Prefix string
// Indent is prepended to newlines one or more times according
// to indentation nesting.
Indent string
}
// NewFormatter returns a new formatter.
func NewFormatter() *Formatter {
return &Formatter{
SpaceColor: DefaultSpaceColor,
CommaColor: DefaultCommaColor,
ColonColor: DefaultColonColor,
ObjectColor: DefaultObjectColor,
ArrayColor: DefaultArrayColor,
FieldQuoteColor: DefaultFieldQuoteColor,
FieldColor: DefaultFieldColor,
StringQuoteColor: DefaultStringQuoteColor,
StringColor: DefaultStringColor,
TrueColor: DefaultTrueColor,
FalseColor: DefaultFalseColor,
NumberColor: DefaultNumberColor,
NullColor: DefaultNullColor,
Prefix: DefaultPrefix,
Indent: DefaultIndent,
}
}
// Format appends to dst a colorized form of the JSON-encoded src.
func (f *Formatter) Format(dst io.Writer, src []byte) error {
return newFormatterState(f, dst).format(dst, src)
}
type formatterState struct {
compact bool
indent string
frames []*frame
printSpace func(string)
printComma func()
printColon func()
printObject func(json.Delim)
printArray func(json.Delim)
printField func(k string) error
printString func(s string) error
printBool func(b bool)
printNumber func(n json.Number)
printNull func()
printIndent func()
}
func newFormatterState(f *Formatter, dst io.Writer) *formatterState {
sprintfSpace := f.SpaceColor.SprintfFunc()
sprintfComma := f.CommaColor.SprintfFunc()
sprintfColon := f.ColonColor.SprintfFunc()
sprintfObject := f.ObjectColor.SprintfFunc()
sprintfArray := f.ArrayColor.SprintfFunc()
sprintfFieldQuote := f.FieldQuoteColor.SprintfFunc()
sprintfField := f.FieldColor.SprintfFunc()
sprintfStringQuote := f.StringQuoteColor.SprintfFunc()
sprintfString := f.StringColor.SprintfFunc()
sprintfTrue := f.TrueColor.SprintfFunc()
sprintfFalse := f.FalseColor.SprintfFunc()
sprintfNumber := f.NumberColor.SprintfFunc()
sprintfNull := f.NullColor.SprintfFunc()
fs := &formatterState{
compact: len(f.Prefix) == 0 && len(f.Indent) == 0,
indent: "",
frames: []*frame{
{},
},
printComma: func() {
fmt.Fprint(dst, sprintfComma(","))
},
printColon: func() {
fmt.Fprint(dst, sprintfColon(":"))
},
printObject: func(t json.Delim) {
fmt.Fprint(dst, sprintfObject(t.String()))
},
printArray: func(t json.Delim) {
fmt.Fprint(dst, sprintfArray(t.String()))
},
printField: func(k string) error {
sbuf, err := json.Marshal(&k)
if err != nil {
return err
}
fmt.Fprint(dst, sprintfFieldQuote(`"`))
fmt.Fprint(dst, sprintfField("%s", string(sbuf[1:len(sbuf)-1])))
fmt.Fprint(dst, sprintfFieldQuote(`"`))
return nil
},
printString: func(s string) error {
sbuf, err := json.Marshal(&s)
if err != nil {
return err
}
fmt.Fprint(dst, sprintfStringQuote(`"`))
fmt.Fprint(dst, sprintfString("%s", string(sbuf[1:len(sbuf)-1])))
fmt.Fprint(dst, sprintfStringQuote(`"`))
return nil
},
printBool: func(b bool) {
if b {
fmt.Fprint(dst, sprintfTrue("%v", b))
} else {
fmt.Fprint(dst, sprintfFalse("%v", b))
}
},
printNumber: func(n json.Number) {
fmt.Fprint(dst, sprintfNumber("%v", n))
},
printNull: func() {
fmt.Fprint(dst, sprintfNull("null"))
},
}
fs.printSpace = func(s string) {
if fs.compact {
return
}
fmt.Fprint(dst, sprintfSpace(s))
}
fs.printIndent = func() {
if fs.compact {
return
}
if len(f.Prefix) > 0 {
fmt.Fprint(dst, f.Prefix)
}
indent := fs.frame().indent
if indent > 0 {
ilen := len(f.Indent) * indent
if len(fs.indent) < ilen {
fs.indent = strings.Repeat(f.Indent, indent)
}
fmt.Fprint(dst, sprintfSpace(fs.indent[:ilen]))
}
}
return fs
}
func (fs *formatterState) frame() *frame {
return fs.frames[len(fs.frames)-1]
}
func (fs *formatterState) enterFrame(t json.Delim, empty bool) *frame {
indent := fs.frames[len(fs.frames)-1].indent + 1
fs.frames = append(fs.frames, &frame{
object: t == json.Delim('{'),
array: t == json.Delim('['),
indent: indent,
empty: empty,
})
return fs.frame()
}
func (fs *formatterState) leaveFrame() *frame {
fs.frames = fs.frames[:len(fs.frames)-1]
return fs.frame()
}
func (fs *formatterState) formatToken(t json.Token) error {
switch x := t.(type) {
case json.Delim:
if x == json.Delim('{') || x == json.Delim('}') {
fs.printObject(x)
} else {
fs.printArray(x)
}
case json.Number:
fs.printNumber(x)
case string:
if !fs.frame().inField() {
return fs.printString(x)
}
return fs.printField(x)
case bool:
fs.printBool(x)
case nil:
fs.printNull()
default:
return fmt.Errorf("unknown type %T", t)
}
return nil
}
func (fs *formatterState) format(dst io.Writer, src []byte) error {
dec := json.NewDecoder(bytes.NewReader(src))
dec.UseNumber()
frame := fs.frame()
for {
t, err := dec.Token()
if err == io.EOF {
break
}
if err != nil {
return err
}
more := dec.More()
printComma := frame.inArrayOrObject() && more
if x, ok := t.(json.Delim); ok {
if x == json.Delim('{') || x == json.Delim('[') {
if frame.inObject() {
fs.printSpace(" ")
} else {
fs.printIndent()
}
err = fs.formatToken(x)
if more {
fs.printSpace("\n")
}
frame = fs.enterFrame(x, !more)
} else {
empty := frame.isEmpty()
frame = fs.leaveFrame()
if !empty {
fs.printIndent()
}
err = fs.formatToken(x)
if printComma {
fs.printComma()
}
if len(fs.frames) > 1 {
fs.printSpace("\n")
}
}
} else {
printIndent := frame.inArray()
if _, ok := t.(string); ok {
printIndent = !frame.inObject() || frame.inField()
}
if printIndent {
fs.printIndent()
}
if !frame.inField() {
fs.printSpace(" ")
}
err = fs.formatToken(t)
if frame.inField() {
fs.printColon()
} else {
if printComma {
fs.printComma()
}
if len(fs.frames) > 1 {
fs.printSpace("\n")
}
}
}
if frame.inObject() {
frame.toggleField()
}
if err != nil {
return err
}
}
return nil
}
|