terminal

package

v12.120.0 Latest Latest Go to latest Published: Apr 29, 2024 License: Apache-2.0 Imports: 5 Imported by: 6

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/essentialkaos/ek

Links

Open Source Insights

Documentation ¶

Overview ¶

Package terminal provides methods for printing messages to terminal

Examples ¶

Error
Info
PrintActionMessage
PrintActionStatus
Warn

Constants ¶

This section is empty.

Variables ¶

View Source

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-}"
)

View Source

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 ¶ added in v12.70.0

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)

Output:

func Info ¶ added in v12.70.0

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")

Output:

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
}

Output:

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
}

Output:

func Warn ¶ added in v12.70.0

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)

Output:

Types ¶

This section is empty.

Source Files ¶

View all Source files

terminal.go

Directories ¶

Path	Synopsis
input Package input provides methods for reading user input	Package input provides methods for reading user input
tty Package tty provides methods for working with TTY	Package tty provides methods for working with TTY

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL