colorjson

Documentation

Overview

Package colorjson is gojq:s cli/encoder.go extract to be reusable and have non-global color config TODO: possible gojq can export it?

The MIT License (MIT) Copyright (c) 2019-2022 itchyny

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• type Colors
• type Encoder
  • func NewEncoder(opts Options) *Encoder
  • func (e *Encoder) Marshal(v any, w io.Writer) error
• type Options

Types

type Colors

type Colors struct {
	Reset     []byte
	Null      []byte
	False     []byte
	True      []byte
	Number    []byte
	String    []byte
	ObjectKey []byte
	Array     []byte
	Object    []byte
}

type Encoder

type Encoder struct {
	// contains filtered or unexported fields
}

func NewEncoder

func NewEncoder(opts Options) *Encoder

func (*Encoder) Marshal

func (e *Encoder) Marshal(v any, w io.Writer) error

type Options

type Options struct {
	Color   bool
	Tab     bool
	Indent  int
	ValueFn func(v any) (any, error)
	Colors  Colors
}