color

Documentation

Index

• Constants
• type ColorConfig
  • func NewColorConfig(options ...ColorConfigOption) ColorConfig
  • func (cc ColorConfig) Reset(key ColorKey) string
• type ColorConfigOption
  • func WithColor(key ColorKey, color string) ColorConfigOption
• type ColorKey

Constants

const (
	Normal       = ""
	Reset        = "\033[0m"
	Bold         = "\033[1m"
	Black        = "\033[30m"
	Red          = "\033[31m"
	Green        = "\033[32m"
	Yellow       = "\033[33m"
	Blue         = "\033[34m"
	Magenta      = "\033[35m"
	Cyan         = "\033[36m"
	White        = "\033[37m"
	Default      = "\033[39m"
	BoldBlack    = "\033[1;30m"
	BoldRed      = "\033[1;31m"
	BoldGreen    = "\033[1;32m"
	BoldYellow   = "\033[1;33m"
	BoldBlue     = "\033[1;34m"
	BoldMagenta  = "\033[1;35m"
	BoldCyan     = "\033[1;36m"
	BoldWhite    = "\033[1;37m"
	BoldDefault  = "\033[1;39m"
	FaintBlack   = "\033[2;30m"
	FaintRed     = "\033[2;31m"
	FaintGreen   = "\033[2;32m"
	FaintYellow  = "\033[2;33m"
	FaintBlue    = "\033[2;34m"
	FaintMagenta = "\033[2;35m"
	FaintCyan    = "\033[2;36m"
	FaintWhite   = "\033[2;37m"
	FaintDefault = "\033[2;39m"
	BgBlack      = "\033[40m"
	BgRed        = "\033[41m"
	BgGreen      = "\033[42m"
	BgYellow     = "\033[43m"
	BgBlue       = "\033[44m"
	BgMagenta    = "\033[45m"
	BgCyan       = "\033[46m"
	BgWhilte     = "\033[47m"
	BgDefault    = "\033[49m"
	Faint        = "\033[2m"
	FaintItalic  = "\033[2;3m"
	Reverse      = "\033[7m"
)

Colors. See https://github.com/git/git/blob/v2.47.1/color.h#L25-L66.

Types

type ColorConfig

type ColorConfig map[ColorKey]string

A ColorConfig is a color configuration. A nil or empty ColorConfig corresponds to no color.

func NewColorConfig

func NewColorConfig(options ...ColorConfigOption) ColorConfig

NewColorConfig returns a new ColorConfig.

func (ColorConfig) Reset

func (cc ColorConfig) Reset(key ColorKey) string

Reset returns the ANSI escape sequence to reset the color with key set from cc. If no color was set then no reset is needed so it returns the empty string.

type ColorConfigOption

type ColorConfigOption func(ColorConfig)

A ColorConfigOption sets an option on a ColorConfig.

func WithColor

func WithColor(key ColorKey, color string) ColorConfigOption

WithColor sets the color for key.

type ColorKey

type ColorKey string

A ColorKey is a key into a ColorConfig map and also equal to the key in the diff.color subsection of the config. See https://github.com/git/git/blob/v2.26.2/diff.c#L83-L106.

const (
	Context                   ColorKey = "context"
	Meta                      ColorKey = "meta"
	Frag                      ColorKey = "frag"
	Old                       ColorKey = "old"
	New                       ColorKey = "new"
	Commit                    ColorKey = "commit"
	Whitespace                ColorKey = "whitespace"
	Func                      ColorKey = "func"
	OldMoved                  ColorKey = "oldMoved"
	OldMovedAlternative       ColorKey = "oldMovedAlternative"
	OldMovedDimmed            ColorKey = "oldMovedDimmed"
	OldMovedAlternativeDimmed ColorKey = "oldMovedAlternativeDimmed"
	NewMoved                  ColorKey = "newMoved"
	NewMovedAlternative       ColorKey = "newMovedAlternative"
	NewMovedDimmed            ColorKey = "newMovedDimmed"
	NewMovedAlternativeDimmed ColorKey = "newMovedAlternativeDimmed"
	ContextDimmed             ColorKey = "contextDimmed"
	OldDimmed                 ColorKey = "oldDimmed"
	NewDimmed                 ColorKey = "newDimmed"
	ContextBold               ColorKey = "contextBold"
	OldBold                   ColorKey = "oldBold"
	NewBold                   ColorKey = "newBold"
)

ColorKeys.