format

Documentation

Index

• Constants
• func Command() command
• func Confirmf(format string, a ...any) (bool, error)
• func ExitIfErrorf(err error, args ...interface{}) error
• func FailureMessagef(icon, format string, a ...any) string
• func InterpolateFlagPlaceholders(vars kong.Vars) func(*kong.Kong) error
• 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 PrintSuccessf(icon, format string, a ...any)
• func ProgressMessagef(icon, format string, a ...any) string
• func SuccessMessagef(icon, format string, a ...any) string
• type PrintOpts

Constants

const (
	LoginCommand  = "auth login"
	LogoutCommand = "auth logout"
	SetOrgCommand = "auth set-org"
)

const (
	SuccessChar = "✓"
	FailureChar = "✗"
)

Functions

func Command

func Command() command

Command can be used to print how certain nctl commands can be executed

func Confirmf

func Confirmf(format string, a ...any) (bool, error)

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

func ExitIfErrorf(err error, args ...interface{}) error

ExitIfErrorf prints Usage + friendly message on error (and exits).

func FailureMessagef

func FailureMessagef(icon, format string, a ...any) string

FailureMessagef is a formatted message for indicating a failed step.

func InterpolateFlagPlaceholders

func InterpolateFlagPlaceholders(vars kong.Vars) func(*kong.Kong) error

InterpolateFlagPlaceholders will return a function which walks the whole kong model and interpolates variables in placeholders in flags.

func MissingChildren

func MissingChildren(node *kong.Node) bool

MissingChildren detects missing commands/args. Logic taken from github.com/alecthomas/kong/context.go

func NewSpinner

func NewSpinner(message, stopMessage string) (*yacspin.Spinner, error)

NewSpinner returns a new spinner with the default config

func PrettyPrintObject

func PrettyPrintObject(obj any, opts PrintOpts) error

PrettyPrintObject prints the supplied object in "pretty" colored yaml with some metadata, status and other default fields stripped out.

func PrettyPrintObjects

func PrettyPrintObjects[T any](objs []T, opts PrintOpts) error

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

func PrintFailuref(icon, format string, a ...any)

PrintFailuref prints a failure message.

func PrintSuccessf

func PrintSuccessf(icon, format string, a ...any)

PrintSuccessf prints a success message.

func ProgressMessagef

func ProgressMessagef(icon, format string, a ...any) string

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 SuccessMessagef

func SuccessMessagef(icon, format string, a ...any) string

SuccessMessagef is a formatted message for indicating a successful step.

Types

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
}

PrintOpts customizes the printing.