ansi

Documentation

Index

• Variables
• func Blue(text string) string
• func Bold(text string) string
• func BrightRed(text string) string
• func BrightYellow(text string) string
• func Color() aurora.Aurora
• func ColorizeJSON(json string, darkStyle bool) string
• func ColorizeStatus(status int) aurora.Value
• func Cyan(text string) string
• func Faint(text string) string
• func Green(text string) string
• func InitConsole()
• func Italic(text string) string
• func Linkify(text, url string) string
• func Magenta(text string) string
• func Red(text string) string
• func Spinner(text string, fn func() error) error
• func StrikeThrough(text string) string
• func Waiting(fn func() error) error
• func Yellow(text string) string

Variables

var DisableColors = false

DisableColors disables all colors and other ANSI sequences.

var EnvironmentOverrideColors = true

EnvironmentOverrideColors overs coloring based on `CLICOLOR` and `CLICOLOR_FORCE`. Cf. https://bixense.com/clicolors/

var ForceColors = false

ForceColors forces the use of colors and other ANSI sequences.

Functions

func Blue

func Blue(text string) string

Blue returns text colored blue

func Bold

func Bold(text string) string

Bold returns bolded text if the writer supports colors

func BrightRed

func BrightRed(text string) string

BrightRed returns text colored bright red

func BrightYellow

func BrightYellow(text string) string

BrightYellow returns text colored bright yellow

func Color

func Color() aurora.Aurora

Color returns an aurora.Aurora instance with colors enabled or disabled depending on whether the writer supports colors.

func ColorizeJSON

func ColorizeJSON(json string, darkStyle bool) string

ColorizeJSON returns a colorized version of the input JSON, if the writer supports colors.

func ColorizeStatus

func ColorizeStatus(status int) aurora.Value

ColorizeStatus returns a colorized number for HTTP status code

func Cyan

func Cyan(text string) string

Cyan returns text colored cyan

func Faint

func Faint(text string) string

Faint returns slightly offset color text if the writer supports it

func Green

func Green(text string) string

Green returns text colored green

func InitConsole

func InitConsole()

InitConsole initializes any platform-specific aspect of the terminal. This method will run for all except Windows.

func Italic

func Italic(text string) string

Italic returns italicized text if the writer supports it.

func Linkify

func Linkify(text, url string) string

Linkify returns an ANSI escape sequence with an hyperlink, if the writer supports colors.

func Magenta

func Magenta(text string) string

Magenta returns text colored magenta

func Red

func Red(text string) string

Red returns text colored red

func Spinner

func Spinner(text string, fn func() error) error

func StrikeThrough

func StrikeThrough(text string) string

StrikeThrough returns struck though text if the writer supports colors

func Waiting

func Waiting(fn func() error) error

func Yellow

func Yellow(text string) string

Yellow returns text colored yellow