Documentation
¶
Overview ¶
Package out provides a mechanism for sending localized, stylized output to the console.
Package out provides a mechanism for sending localized, stylized output to the console.
Package out provides a mechanism for sending localized, stylized output to the console.
Index ¶
- Constants
- Variables
- func Boxed(format string, a ...V)
- func BoxedErr(format string, a ...V)
- func BoxedWithConfig(cfg box.Config, st style.Enum, title string, text string, a ...V)
- func Err(format string, a ...interface{})
- func ErrLn(format string, a ...interface{})
- func ErrT(st style.Enum, format string, a ...V)
- func Error(k reason.Kind, format string, a ...V)
- func FailureT(format string, a ...V)
- func FatalT(format string, a ...V)
- func Fmt(format string, a ...V) string
- func Infof(format string, a ...V)
- func IsTerminal(w fdWriter) bool
- func Ln(format string, a ...interface{})
- func LogEntries(msg string, err error, entries map[string][]string)
- func Output(file fdWriter, format string, a ...interface{})
- func SetErrFile(w fdWriter)
- func SetJSON(j bool)
- func SetOutFile(w fdWriter)
- func SetSilent(q bool)
- func Sprintf(st style.Enum, format string, a ...V) string
- func Step(st style.Enum, format string, a ...V)
- func String(format string, a ...interface{})
- func Styled(st style.Enum, format string, a ...V)
- func SuccessT(format string, a ...V)
- func WarnReason(k reason.Kind, format string, a ...V)
- func WarningT(format string, a ...V)
- type V
Constants ¶
const (
MaxLogEntries = 3
)
MaxLogEntries controls the number of log entries to show for each source
Variables ¶
var ( // OverrideEnv is the environment variable used to override color/emoji usage OverrideEnv = "MINIKUBE_IN_STYLE" // JSON is whether or not we should output stdout in JSON format. Set using SetJSON() JSON = false )
Functions ¶
func Boxed ¶ added in v1.19.0
Boxed writes a stylized and templated message in a box to stdout using the default style config
func BoxedErr ¶ added in v1.20.0
BoxedErr writes a stylized and templated message in a box to stderr using the default style config
func BoxedWithConfig ¶ added in v1.23.0
BoxedWithConfig writes a templated message in a box with customized style config to stdout
func ErrLn ¶
func ErrLn(format string, a ...interface{})
ErrLn writes a basic formatted string with a newline to stderr
func IsTerminal ¶ added in v1.19.0
func IsTerminal(w fdWriter) bool
IsTerminal returns whether we have a terminal or not
func Ln ¶
func Ln(format string, a ...interface{})
Ln writes a basic formatted string with a newline to stdout
func LogEntries ¶ added in v1.10.0
LogEntries outputs an error along with any important log entries.
func Output ¶ added in v1.19.0
func Output(file fdWriter, format string, a ...interface{})
Output writes a basic formatted string
func SetErrFile ¶
func SetErrFile(w fdWriter)
SetErrFile configures which writer error output goes to.
func SetOutFile ¶
func SetOutFile(w fdWriter)
SetOutFile configures which writer standard output goes to.
func SetSilent ¶ added in v1.19.0
func SetSilent(q bool)
SetSilent configures whether output is disabled or not
func String ¶
func String(format string, a ...interface{})
String writes a basic formatted string to stdout
func WarnReason ¶ added in v1.13.0
WarnReason shows a warning reason