Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var DefaultOptions = &Options{Width: 80, Prefix: "", Indent: " ", SortKeys: false}
DefaultOptions is the default options for pretty formats.
Functions ¶
func BestOptions ¶
BestOptions is like Pretty but with customized options.
func Color ¶
Color will colorize the json. The style parma is used for customizing the colors. Passing nil to the style param will use the default TerminalStyle.
func Pretty ¶
Pretty converts the input json into a more human readable format where each element is on it's own line with clear indentation.
func Spec ¶
Spec strips out comments and trailing commas and convert the input to a valid JSON per the official spec: https://tools.ietf.org/html/rfc8259
The resulting JSON will always be the same length as the input and it will include all of the same line breaks at matching offsets. This is to ensure the result can be later processed by a external parser and that that parser will report messages or errors with the correct offsets.
func SpecInPlace ¶
SpecInPlace is the same as Spec, but this method reuses the input json buffer to avoid allocations. Do not use the original bytes slice upon return.
func Ugly ¶
Ugly removes insignificant space characters from the input json byte slice and returns the compacted result.
func UglyInPlace ¶
UglyInPlace removes insignificant space characters from the input json byte slice and returns the compacted result. This method reuses the input json buffer to avoid allocations. Do not use the original bytes slice upon return.
Types ¶
type Options ¶
type Options struct {
// Width is an max column width for single line arrays
// Default is 80
Width int
// Prefix is a prefix for all lines
// Default is an empty string
Prefix string
// Indent is the nested indentation
// Default is two spaces
Indent string
// SortKeys will sort the keys alphabetically
// Default is false
SortKeys bool
}
Options is Pretty options
Source Files