ansi

Documentation

Overview

vendored from https://github.com/mgutz/ansi

Index

• Constants
• Variables
• func Color(s, style string) string
• func ColorCode(style string) string
• func ColorFunc(style string) func(string) string
• func DisableColors(disable bool)

Constants

const (

	// Reset is the ANSI reset escape sequence
	Reset = "\033[0m"
	// DefaultBG is the default background
	DefaultBG = "\033[49m"
	// DefaultFG is the default foreground
	DefaultFG = "\033[39m"
)

Variables

var Black string

Black FG

var Blue string

Blue FG

var (

	// Colors maps common color names to their ANSI color code.
	Colors = map[string]int{
		"black":   black,
		"red":     red,
		"green":   green,
		"yellow":  yellow,
		"blue":    blue,
		"magenta": magenta,
		"cyan":    cyan,
		"white":   white,
		"default": defaultt,
	}
)

var Cyan string

Cyan FG

var Green string

Green FG

var LightBlack string

LightBlack FG

var LightBlue string

LightBlue FG

var LightCyan string

LightCyan FG

var LightGreen string

LightGreen FG

var LightMagenta string

LightMagenta FG

var LightRed string

LightRed FG

var LightWhite string

LightWhite FG

var LightYellow string

LightYellow FG

var Magenta string

Magenta FG

var Red string

Red FG

var White string

White FG

var Yellow string

Yellow FG

Functions

func Color

func Color(s, style string) string

Color colors a string based on the ANSI color code for style.

func ColorCode

func ColorCode(style string) string

ColorCode returns the ANSI color color code for style.

func ColorFunc

func ColorFunc(style string) func(string) string

ColorFunc creates a closure to avoid computation ANSI color code.

func DisableColors

func DisableColors(disable bool)

DisableColors disables ANSI color codes. The default is false (colors are on).