terminal

Documentation

Overview

Package terminal provides methods for printing messages to terminal

Index

• Variables
• func Error(message any, args ...any)
• func Info(message any, args ...any)
• func PrintActionMessage(message string)
• func PrintActionStatus(status int)
• func Warn(message any, args ...any)

Examples

• Error
• Info
• PrintActionMessage
• PrintActionStatus
• Warn

Variables

var (
	// ErrorColorTag is fmtc color tag used for error messages
	ErrorColorTag = "{r}"

	// WarnColorTag is fmtc color tag used for warning messages
	WarnColorTag = "{y}"

	// InfoColorTag is fmtc color tag used for info messages
	InfoColorTag = "{c-}"
)

var (
	// ErrorPrefix is prefix for error messages
	ErrorPrefix = ""

	// WarnPrefix is prefix for warning messages
	WarnPrefix = ""

	// InfoPrefix is prefix for info messages
	InfoPrefix = ""
)

Functions

func Error

func Error(message any, args ...any)

Error prints error message

Example

// Add custom error message prefix
ErrorPrefix = "▲ "

// Print red text to stderr
Error("Error while sending data to %s", "https://example.com")

// Print message from error struct
err := errors.New("My error")
Error(err)

func Info

func Info(message any, args ...any)

Info prints info message

Example

// Add custom info message prefix
InfoPrefix = "❕ "

// Print cyan text to stdout
Warn("User %q will be created automatically", "bob")

func PrintActionMessage

func PrintActionMessage(message string)

PrintActionMessage prints message about action currently in progress

Example

statusOk := true

PrintActionMessage("Starting service my-service")

switch statusOk {
case true:
	PrintActionStatus(0) // Print OK
case false:
	PrintActionStatus(1) // Print ERROR
}

func PrintActionStatus

func PrintActionStatus(status int)

PrintActionStatus prints message with action execution status

Example

statusOk := true

PrintActionMessage("Starting service my-service")

switch statusOk {
case true:
	PrintActionStatus(0) // Print OK
case false:
	PrintActionStatus(1) // Print ERROR
}

func Warn

func Warn(message any, args ...any)

Warn prints warning message

Example

// Add custom warning message prefix
WarnPrefix = "△ "

// Print yellow text to stderr
Warn("Warning file %s is not found", "/home/john/test.txt")

// Print message from error struct
err := errors.New("My warning")
Warn(err)