output

package

v0.19.0 Latest Latest Go to latest Published: Apr 16, 2024 License: MPL-2.0 Imports: 3 Imported by: 0

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

Package output is responsible for formatting the final output / errors the user sees in the CLI.

This section is empty.

This section is empty.

func FormatError(summary string, err error) string

FormatError outputs the error with proper formatting for CLI.

type UI struct {
	BasicUI cli.Ui
}

UI is used for interfacing with the terminal

func (u *UI) Ask(query string) (string, error)

Ask asks the user for input using the given query. The response is returned as the given string, or an error.

func (u *UI) AskSecret(query string) (string, error)

AskSecret asks the user for input using the given query, but does not echo the keystrokes to the terminal.

func (u *UI) Error(message string)

Error is used to output error messages

func (u *UI) Info(message string)

Info is used to output info messages

func (u *UI) Output(message string)

Output is used to output messages with no formatting applied

func (u *UI) Warn(message string)

Warn is used to output warn messages