ansi

Documentation

Index

• Variables
• func Bold(text string) string
• func Color(w io.Writer) aurora.Aurora
• func ColorizeJSON(json string, darkStyle bool, w io.Writer) string
• func ColorizeStatus(status int) aurora.Value
• func Faint(text string) string
• func Italic(text string) string
• func Linkify(text, url string, w io.Writer) string
• func StartNewSpinner(msg string, w io.Writer) *spinner.Spinner
• func StartSpinner(s *spinner.Spinner, msg string, w io.Writer)
• func StopSpinner(s *spinner.Spinner, msg string, w io.Writer)
• func StrikeThrough(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.

var HostStderrIsTerminal = true

HostStderrIsTerminal enables color on stderr output when this package is used in a plugin.

var HostStdoutIsTerminal = true

HostStdoutIsTerminal enables color on stdout output when this package is used in a plugin.

Functions

func Bold

func Bold(text string) string

Bold returns bolded text if the writer supports colors

func Color

func Color(w io.Writer) 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, w io.Writer) 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 Faint

func Faint(text string) string

Faint returns slightly offset color text if the writer supports it

func Italic

func Italic(text string) string

Italic returns italicized text if the writer supports it.

func Linkify

func Linkify(text, url string, w io.Writer) string

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

func StartNewSpinner

func StartNewSpinner(msg string, w io.Writer) *spinner.Spinner

StartNewSpinner starts a new spinner with the given message. If the writer is not a terminal or doesn't support colors, it simply prints the message.

func StartSpinner

func StartSpinner(s *spinner.Spinner, msg string, w io.Writer)

StartSpinner updates an existing spinner's message, and starts it if it was stopped

func StopSpinner

func StopSpinner(s *spinner.Spinner, msg string, w io.Writer)

StopSpinner stops a spinner with the given message. If the writer is not a terminal or doesn't support colors, it simply prints the message.

func StrikeThrough

func StrikeThrough(text string) string

StrikeThrough returns struck though text if the writer supports colors