Documentation
¶
Index ¶
- Constants
- func Command() command
- func Confirm(message string) (bool, error)
- func Confirmf(format string, a ...any) (bool, error)
- func ExitIfErrorf(err error, args ...any) error
- func FailureMessagef(icon, format string, a ...any) string
- func InterpolateFlagPlaceholders(vars kong.Vars) func(*kong.Kong) error
- func IsInteractiveEnvironment(out io.Writer) bool
- func MissingChildren(node *kong.Node) bool
- func NewSpinner(message, stopMessage string) (*yacspin.Spinner, error)
- func PrettyPrintObject(obj any, opts PrintOpts) error
- func PrettyPrintObjects[T any](objs []T, opts PrintOpts) error
- func PrintFailuref(icon, format string, a ...any)
- func PrintSuccess(icon, message string)
- func PrintSuccessf(icon, format string, a ...any)
- func PrintWarningf(msg string, a ...any)
- func ProgressMessage(icon, message string) string
- func ProgressMessagef(icon, format string, a ...any) string
- func SuccessMessage(icon, message string) string
- func SuccessMessagef(icon, format string, a ...any) string
- type JSONOutputOptions
- type OutputFormatType
- type PrintOpts
Constants ¶
const ( LoginCommand = "login" LogoutCommand = "logout" )
const ( SuccessChar = "✓" FailureChar = "✗" OutputFormatTypeYAML OutputFormatType = 0 OutputFormatTypeJSON OutputFormatType = 1 )
Variables ¶
This section is empty.
Functions ¶
func Command ¶ added in v1.1.1
func Command() command
Command can be used to print how certain nctl commands can be executed
func Confirm ¶ added in v1.8.3
Confirm prints a confirm dialog using the supplied message and then waits until prompt is confirmed or denied. Only y and yes are accepted for confirmation.
func Confirmf ¶
Confirmf prints a confirm dialog using format and then waits until prompt is confirmed or denied. Only y and yes are accepted for confirmation.
func ExitIfErrorf ¶ added in v1.2.0
ExitIfErrorf prints Usage + friendly message on error (and exits).
func FailureMessagef ¶
FailureMessagef is a formatted message for indicating a failed step.
func InterpolateFlagPlaceholders ¶ added in v1.2.0
InterpolateFlagPlaceholders will return a function which walks the whole kong model and interpolates variables in placeholders in flags.
func IsInteractiveEnvironment ¶ added in v1.8.2
func MissingChildren ¶ added in v1.2.0
MissingChildren detects missing commands/args. Logic taken from github.com/alecthomas/kong/context.go
func NewSpinner ¶
NewSpinner returns a new spinner with the default config
func PrettyPrintObject ¶ added in v1.2.2
PrettyPrintObject prints the supplied object in "pretty" colored yaml with some metadata, status and other default fields stripped out.
func PrettyPrintObjects ¶
PrettyPrintObjects prints the supplied objects in "pretty" colored yaml with some metadata, status and other default fields stripped out. If multiple objects are supplied, they will be divided with a yaml divider.
func PrintFailuref ¶
PrintFailuref prints a failure message.
func PrintSuccess ¶ added in v1.8.3
func PrintSuccess(icon, message string)
PrintSuccess prints a success message.
func PrintSuccessf ¶
PrintSuccessf prints a success message.
func PrintWarningf ¶ added in v1.7.0
func ProgressMessage ¶ added in v1.8.3
ProgressMessage is a formatted message for use with a spinner.Suffix. An icon can be added which is displayed at the end of the message.
func ProgressMessagef ¶
ProgressMessagef is a formatted message for use with a spinner.Suffix. An icon can be added which is displayed at the end of the message.
func SuccessMessage ¶ added in v1.8.3
SuccessMessage returns a message for indicating a successful step.
func SuccessMessagef ¶
SuccessMessagef is a formatted message for indicating a successful step.
Types ¶
type JSONOutputOptions ¶ added in v1.9.0
type JSONOutputOptions struct {
// PrintSingleItem will print a single item of an array as is
// (without the array notation)
PrintSingleItem bool
}
type OutputFormatType ¶ added in v1.9.0
type OutputFormatType int
type PrintOpts ¶
type PrintOpts struct {
// Out will be used to print to if set instead of stdout.
Out io.Writer
// ExcludeAdditional allows to exclude more fields of the object
ExcludeAdditional [][]string
// format type of the output, e.g. yaml or json
Format OutputFormatType
// JSONOpts defines special options for JSON output
JSONOpts JSONOutputOptions
// AllFields prints all fields of the object.
AllFields bool
}
PrintOpts customizes the printing.
Source Files