ui

Documentation

Index

• Variables
• func Debug(a ...interface{})
• func Deprecate(a ...interface{})
• func Error(a ...interface{})
• func Info(a ...interface{})
• func PrintCommand(command, context string)
• func PrintCommandError(err error)
• func PrintCommandWithParenthetical(command, context, parenthetical string)
• func PrintEnvironment(variables map[string]*string)
• func PrintSkipped(command string, reason string)
• func PrintTask(taskName string, asSubTask bool)
• func PrintTaskCompleted(taskName string, asSubTask bool)
• func PrintTaskFinally(taskName string, asSubTask bool)
• func Println(a ...interface{})
• func Warn(a ...interface{})
• type VerbosityLevel
  • func (v VerbosityLevel) String() string

Variables

var (
	// Verbosity allows the verbosity of output to be set.
	Verbosity = VerbosityLevelNormal

	// LoggerStdout is a logger that prints to stdout.
	LoggerStdout = log.New(os.Stdout, "", 0)

	// LoggerStderr is a logger that prints to stderr.
	LoggerStderr = log.New(os.Stderr, "", 0)
)

Functions

func Debug

func Debug(a ...interface{})

Debug prints info only in verbose mode.

func Deprecate

func Deprecate(a ...interface{})

Deprecate prints a deprecation warning no more than once.

func Error

func Error(a ...interface{})

Error prints an application error.

func Info

func Info(a ...interface{})

Info prints application info.

func PrintCommand

func PrintCommand(command, context string)

PrintCommand prints the command to be executed.

func PrintCommandError

func PrintCommandError(err error)

PrintCommandError prints an error from a running command.

func PrintCommandWithParenthetical

func PrintCommandWithParenthetical(command, context, parenthetical string)

PrintCommandWithParenthetical prints a command with additional information.

func PrintEnvironment

func PrintEnvironment(variables map[string]*string)

PrintEnvironment prints when environment variables are set.

func PrintSkipped

func PrintSkipped(command string, reason string)

PrintSkipped prints the command skipped and the reason.

func PrintTask

func PrintTask(taskName string, asSubTask bool)

PrintTask prints when a task has begun.

func PrintTaskCompleted

func PrintTaskCompleted(taskName string, asSubTask bool)

PrintTaskCompleted prints when a task has completed.

func PrintTaskFinally

func PrintTaskFinally(taskName string, asSubTask bool)

PrintTaskFinally prints when a task's finally clause has begun.

func Println

func Println(a ...interface{})

Println prints a message to stdout.

func Warn

func Warn(a ...interface{})

Warn prints an application warning.

Types

type VerbosityLevel

type VerbosityLevel int

VerbosityLevel describes the verbosity of output.

const (
	// VerbosityLevelSilent does not print any output to stderr/stdout.
	VerbosityLevelSilent VerbosityLevel = iota
	// VerbosityLevelQuiet only prints command output and error messages.
	VerbosityLevelQuiet VerbosityLevel = iota
	// VerbosityLevelNormal is the normal level of verbosity.
	VerbosityLevelNormal VerbosityLevel = iota
	// VerbosityLevelVerbose prints all messages, include debug info.
	VerbosityLevelVerbose VerbosityLevel = iota
)

func (VerbosityLevel) String

func (v VerbosityLevel) String() string