say

Documentation

Index

• Constants
• Variables
• func Error(text ...interface{})
• func Fatal(text ...interface{})
• func Info(text ...interface{})
• func ProgressBar(totalSteps int64) *progressbar.Bar
• func ProgressBarFooter(totalSteps int64) *progressbar.Bar
• func Success(text ...interface{})
• func Text(text ...interface{})
• func Warning(text ...interface{})

Constants

const (
	// FooterPriority is used as priority for footer progressbars
	FooterPriority = 10000
)

Variables

var (
	// InfoPrefix should be used, when any kind of information is shown to the user, which is not part of the modules result
	InfoPrefix = color.SHiMagenta("[info] ")

	// WarningPrefix should be used, when a warning is displayed to the user
	WarningPrefix = color.SYellow("[warning] ")

	// ErrorPrefix should be used, when the module fails at something, but keeps running.
	// If the error is fatal, use say.Fatal
	ErrorPrefix = color.SHiRed("[error] ")

	// SuccessPrefix should be used, when something succeeded.
	SuccessPrefix = color.SGreen("[success] ")
)

Functions

func Error

func Error(text ...interface{})

Error outputs formatted text to the terminal.

func Fatal

func Fatal(text ...interface{})

Fatal outputs formatted text to the terminal.

func Info

func Info(text ...interface{})

Info outputs formatted text to the terminal.

func ProgressBar

func ProgressBar(totalSteps int64) *progressbar.Bar

ProgressBar hows a simple progressbar with a set maximum

func ProgressBarFooter

func ProgressBarFooter(totalSteps int64) *progressbar.Bar

ProgressBarFooter shows a simple progressbar with a set maximum at the bottom of the terminal

func Success

func Success(text ...interface{})

Success outputs formatted text to the terminal.

func Text

func Text(text ...interface{})

Text outputs formatted text to the terminal.

func Warning

func Warning(text ...interface{})

Warning outputs formatted text to the terminal.