sq/cli/output/formatting.go

package output

import "github.com/fatih/color"

// Formatting describes color and pretty-printing options.
type Formatting struct {
	monochrome bool

	// ShowHeader indicates that a header (e.g. a header row) should
	// be printed where applicable.
	ShowHeader bool

	// Verbose indicates that verbose output should be printed where
	// applicable.
	Verbose bool

	// Pretty indicates that output should be pretty-printed.
	// Typically this means indentation, new lines, etc, but
	// varies by output format.
	Pretty bool

	// Indent is the indent string to use when pretty-printing,
	// typically two spaces.
	Indent string

	// Bool is the color for boolean values.
	Bool *color.Color

	// Bytes is the color for byte / binary values.
	Bytes *color.Color

	// Datetime is the color for time-related values.
	Datetime *color.Color

	// Null is the color for null.
	Null *color.Color

	// Number is the color for number values, including int,
	// float, decimal etc.
	Number *color.Color

	// String is the color for string values.
	String *color.Color

	// Success is the color for success elements.
	Success *color.Color

	// Error is the color for error elements such as an error message.
	Error *color.Color

	// Handle is the color for source handles such as "@my_db"
	Handle *color.Color

	// Header is the color for header elements in a table.
	Header *color.Color

	// Hilite is the color for highlighted elements.
	Hilite *color.Color

	// Faint is the color for faint elements - the opposite of Hilite.
	Faint *color.Color

	// Bold is the color for bold elements.
	Bold *color.Color

	// Key is the color for keys such as a JSON field name.
	Key *color.Color

	// Punc is the color for punctuation such as colons, braces, etc.
	// Frequently Punc will just be color.Bold.
	Punc *color.Color
}

// NewFormatting returns a Formatting instance. Color and pretty-print
// are enabled. The default indent is two spaces.
func NewFormatting() *Formatting {
	fm := &Formatting{
		ShowHeader: true,
		Verbose:    false,
		Pretty:     true,
		monochrome: false,
		Indent:     "  ",
		Bool:       color.New(color.FgYellow),
		Bold:       color.New(color.Bold),
		Bytes:      color.New(color.Faint),
		Datetime:   color.New(color.FgGreen, color.Faint),
		Error:      color.New(color.FgRed, color.Bold),
		Faint:      color.New(color.Faint),
		Handle:     color.New(color.FgBlue),
		Header:     color.New(color.FgBlue, color.Bold),
		Hilite:     color.New(color.FgHiBlue),
		Key:        color.New(color.FgBlue, color.Bold),
		Null:       color.New(color.Faint),
		Number:     color.New(color.FgCyan),
		String:     color.New(color.FgGreen),
		Success:    color.New(color.FgGreen, color.Bold),
		Punc:       color.New(color.Bold),
	}

	fm.EnableColor(true)
	return fm
}

// IsMonochrome returns true if in monochrome (no color) mode.
// Default is false (color enabled) for a new instance.
func (f *Formatting) IsMonochrome() bool {
	return f.monochrome
}

// EnableColor enables or disables all colors.
func (f *Formatting) EnableColor(enable bool) {
	if enable {
		f.monochrome = false

		f.Bool.EnableColor()
		f.Bytes.EnableColor()
		f.Datetime.EnableColor()
		f.Error.EnableColor()
		f.Faint.EnableColor()
		f.Header.EnableColor()
		f.Hilite.EnableColor()
		f.Key.EnableColor()
		f.Null.EnableColor()
		f.Success.EnableColor()
		f.Punc.EnableColor()
		f.Bold.EnableColor()
	} else {
		f.monochrome = true

		f.Bool.DisableColor()
		f.Bytes.DisableColor()
		f.Datetime.DisableColor()
		f.Error.DisableColor()
		f.Faint.DisableColor()
		f.Header.DisableColor()
		f.Hilite.DisableColor()
		f.Key.DisableColor()
		f.Null.DisableColor()
		f.Success.DisableColor()
		f.Punc.DisableColor()
		f.Bold.DisableColor()
	}
}