output

package
v0.9.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 28, 2026 License: MPL-2.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	SpinnerStyleDefault = "default"
	SpinnerStyleWASM    = "wasm"
	SpinnerStyleFancy   = "fancy"
)

Spinner style constants.

Variables

View Source 
var (
	RadRed           = color.New(color.FgRed).Add(color.Bold).SprintFunc()
	DeepNightBlue    = color.New(color.FgBlue).Add(color.FgBlack).SprintFunc()
	MegaportYellow   = color.New(color.FgHiYellow).SprintFunc()
	MegaportOrange   = color.New(color.FgHiRed).SprintFunc()
	MegaportRed      = color.New(color.FgRed).SprintFunc()
	MegaportPurple   = color.New(color.FgMagenta).SprintFunc()
	RadRedReadable   = color.New(color.FgHiRed).Add(color.Bold).SprintFunc()
	DeepBlueReadable = color.New(color.FgBlue).Add(color.Bold).SprintFunc()
	YellowReadable   = color.New(color.FgYellow).Add(color.Bold).SprintFunc()
	OrangeReadable   = color.New(color.FgRed).Add(color.FgYellow).SprintFunc()
	PurpleReadable   = color.New(color.FgHiMagenta).Add(color.Bold).SprintFunc()
	NexusBlue        = color.New(color.FgBlue).Add(color.Bold).SprintFunc()
	DodgerBlue       = color.New(color.FgHiBlue).Add(color.Bold).SprintFunc()
	SkyBlue          = color.New(color.FgHiCyan).SprintFunc()
	PurpleCloud      = color.New(color.FgMagenta).Add(color.Bold).SprintFunc()
	Plum             = color.New(color.FgHiMagenta).SprintFunc()
	Mauve            = color.New(color.FgHiMagenta).Add(color.Faint).SprintFunc()
	Pink             = color.New(color.FgMagenta).Add(color.Italic).SprintFunc()
	Magenta          = color.New(color.FgHiMagenta).Add(color.Bold).SprintFunc()
	SunsetOrange     = color.New(color.FgRed).Add(color.FgHiYellow).SprintFunc()
	BlackHole        = color.New(color.FgBlack).Add(color.Bold).SprintFunc()
	DarkBlue         = color.New(color.FgBlue).Add(color.Underline).SprintFunc()
	GoldYellow       = color.New(color.FgYellow).Add(color.Bold).SprintFunc()
	Teal             = color.New(color.FgCyan).Add(color.Bold).SprintFunc()
	LinkGreen        = color.New(color.FgGreen).Add(color.Bold).SprintFunc()
	ElectricLime     = color.New(color.FgHiGreen).SprintFunc()
)

Functions

func CaptureOutput 

func CaptureOutput(f func()) string

CaptureOutput runs f and returns everything it writes to stdout. Uses a temporary file instead of an OS pipe to avoid deadlocking when f() produces more output than the pipe buffer can hold. Must not be called reentrantly (the global stdoutMu is not reentrant).

func CaptureOutputErr 

func CaptureOutputErr(f func() error) (string, error)

func ClearScreen added in v0.5.8 

func ClearScreen()

ClearScreen clears the terminal screen using ANSI escape codes.

func DisplayChanges added in v0.5.9 

func DisplayChanges(changes []FieldChange, noColor bool)

DisplayChanges prints a formatted list of field changes for a resource update. Only changes where OldValue != NewValue are displayed. If no changes are found, a "No changes detected" message is printed.

func FormatBool added in v0.5.9 

func FormatBool(b bool) string

FormatBool returns "Yes" or "No" for a boolean value.

func FormatCommandName 

func FormatCommandName(name string, noColor bool) string

func FormatConfirmation 

func FormatConfirmation(msg string, noColor bool) string

func FormatExample 

func FormatExample(example string, noColor bool) string

func FormatJSONExample 

func FormatJSONExample(json string, noColor bool) string

func FormatNewValue added in v0.3.4 

func FormatNewValue(value string, noColor bool) string

func FormatOldValue added in v0.3.4 

func FormatOldValue(value string, noColor bool) string

func FormatOptionalFlag 

func FormatOptionalFlag(flag string, description string, noColor bool) string

func FormatOptionalString added in v0.5.9 

func FormatOptionalString(s string) string

FormatOptionalString returns the string value or "(none)" if empty.

func FormatPrompt 

func FormatPrompt(msg string, noColor bool) string

func FormatRequiredFlag 

func FormatRequiredFlag(flag string, description string, noColor bool) string

func FormatSuccess 

func FormatSuccess(msg string, noColor bool) string

func FormatUID 

func FormatUID(uid string, noColor bool) string

func GetNoPager added in v0.9.0 

func GetNoPager() bool

GetNoPager returns the current no-pager setting. Intended for tests that need to assert the output package was correctly wired by PersistentPreRunE.

func GetOutputFormat added in v0.9.0 

func GetOutputFormat() string

GetOutputFormat returns the currently active output format (e.g. "table", "json"). Exported so other packages can read the current output format without relying on an unexported helper.

func GetTemplateString added in v0.9.0 

func GetTemplateString() string

GetTemplateString returns the current Go template string under a read lock.

func IsQuiet added in v0.5.3 

func IsQuiet() bool

IsQuiet returns true when quiet mode is active. In quiet mode, informational messages and spinners are suppressed.

func IsTerminal added in v0.5.4 

func IsTerminal() bool

IsTerminal returns true if stdout is connected to a terminal (not piped).

func IsVerbose added in v0.5.3 

func IsVerbose() bool

IsVerbose returns true when verbose mode is active.

func PrintError 

func PrintError(format string, noColor bool, args ...interface{})

func PrintErrorJSON added in v0.9.0 

func PrintErrorJSON(code int, message string)

PrintErrorJSON writes a structured JSON error to stderr. Used by RunE wrappers when --output json is active so automation scripts can parse errors programmatically instead of scraping plain text.

func PrintInfo 

func PrintInfo(format string, noColor bool, args ...interface{})

func PrintOutput 

func PrintOutput[T OutputFields](data []T, format string, noColor bool) error

PrintOutput prints data in the specified format

func PrintResourceCreated 

func PrintResourceCreated(resourceType, uid string, noColor bool)

func PrintResourceDeleted 

func PrintResourceDeleted(resourceType, uid string, immediate, noColor bool)

func PrintResourceSuccess 

func PrintResourceSuccess(resourceType, action, uid string, noColor bool)

func PrintResourceUpdated 

func PrintResourceUpdated(resourceType, uid string, noColor bool)

func PrintSuccess 

func PrintSuccess(format string, noColor bool, args ...interface{})

func PrintSuccessWithOutput added in v0.4.7 

func PrintSuccessWithOutput(format string, noColor bool, outputFormat string, args ...interface{})

func PrintVerbose added in v0.5.3 

func PrintVerbose(format string, noColor bool, args ...interface{})

PrintVerbose prints a debug message only when verbose mode is active.

func PrintWarning 

func PrintWarning(format string, noColor bool, args ...interface{})

func ResetState added in v0.9.0 

func ResetState()

ResetState clears all package-level output configuration back to defaults. Intended for callers such as the WASM entry point that must ensure all output-related global state does not bleed between invocations.

func RunWithPager added in v0.9.0 

func RunWithPager(fn func() error) error

RunWithPager runs fn, capturing its stdout output. If stdout is a TTY, the pager is not disabled, and the captured line count exceeds the terminal height, the output is piped through the configured pager. Otherwise the output is written directly to stdout.

Terminal dimensions are read before os.Stdout is redirected so that table rendering (which calls getTerminalWidth via printTable) uses the real TTY width for column layout even while output is being buffered to a temp file. The temp file is streamed rather than loaded into memory, so paging large tables does not require holding the full output in RAM.

func SetConfig added in v0.9.1 

func SetConfig(c OutputConfig)

SetConfig applies every field of c by delegating to the individual setters. Those setters use a mix of per-field mutexes (Fields, Query, NoHeader, NoPager, Template) and atomic.Value (Format, Verbosity), so SetConfig is not atomic across fields — concurrent readers may observe a partial update. Callers should invoke SetConfig from the main goroutine before spawning work, which matches how the flag-driven RunE wrappers already use the individual setters.

func SetIsTerminal added in v0.5.4 

func SetIsTerminal(val bool)

SetIsTerminal overrides the cached TTY detection result. Intended for tests.

func SetNoHeader added in v0.9.0 

func SetNoHeader(v bool)

SetNoHeader sets whether table and CSV output should suppress column headers. This function is goroutine-safe. Tests should call defer SetNoHeader(false) to reset state between test cases.

func SetNoPager added in v0.9.0 

func SetNoPager(v bool)

SetNoPager disables or enables the pager. When true, output is always written directly to stdout even if it exceeds the terminal height.

func SetOutputFields added in v0.5.8 

func SetOutputFields(fields []string)

SetOutputFields sets the field filter applied by all PrintOutput calls. Only fields whose json tag name or header display name (case-insensitive) appears in fields will be included in output. Passing nil or an empty slice restores full output (all fields). This function is goroutine-safe. Tests should call defer SetOutputFields(nil) to reset state between test cases.

The slice is copied before being stored, so callers may mutate or reuse the backing array after the call returns without affecting the filter.

func SetOutputFormat added in v0.4.7 

func SetOutputFormat(format string)

func SetOutputQuery added in v0.5.8 

func SetOutputQuery(query string)

SetOutputQuery sets the JMESPath query applied by printJSON. Pass "" to disable. This function is goroutine-safe. Tests should call defer SetOutputQuery("") to reset state between test cases.

func SetTemplateString added in v0.9.0 

func SetTemplateString(s string)

SetTemplateString sets the Go template string applied by printGoTemplate. Pass "" to disable. This function is goroutine-safe.

func SetVerbosity added in v0.5.3 

func SetVerbosity(level string)

SetVerbosity sets the global verbosity level ("normal", "quiet", or "verbose").

func StripANSIColors 

func StripANSIColors(s string) string

Types

type FieldChange added in v0.5.9 

type FieldChange struct {
	Label    string
	OldValue string
	NewValue string
}

FieldChange represents a single field that changed between two versions of a resource.

type Output 

type Output interface {
	// contains filtered or unexported methods
}

Output is a marker interface embedded by output structs.

type OutputConfig added in v0.9.1 

type OutputConfig struct {
	// Fields is the list of field names (json tag or header display name,
	// case-insensitive) to include in output. Nil or empty means all fields.
	// The slice is copied by SetOutputFields, so callers may reuse the
	// backing array after SetConfig returns.
	Fields   []string
	Query    string
	NoHeader bool
	NoPager  bool
	Template string
	Format   string
	// Verbosity is one of "normal", "quiet", or "verbose".
	Verbosity string
}

OutputConfig bundles every field that the package-level setters accept. Callers that need to apply several settings at once (most notably the WASM entry point on re-invocation and test cleanup helpers) can assemble an OutputConfig and pass it to SetConfig rather than calling each setter by hand. The individual setters remain the primary API; SetConfig is a convenience on top of them.

SetConfig writes every field verbatim — there is no "leave unchanged" sentinel. Callers that want defaults should start from DefaultOutputConfig() and override the fields they care about.

func DefaultOutputConfig added in v0.9.1 

func DefaultOutputConfig() OutputConfig

DefaultOutputConfig returns the defaults that ResetState applies.

type OutputFields 

type OutputFields interface {
	any
}

OutputFields is a constraint for types that can be output

type ResourceTag added in v0.4.3 

type ResourceTag struct {
	Key   string `json:"key" header:"Key"`
	Value string `json:"value" header:"Value"`
}

ResourceTag represents a key-value tag pair

type Spinner added in v0.4.0 

type Spinner struct {
	// contains filtered or unexported fields
}

func NewSpinner added in v0.4.0 

func NewSpinner(noColor bool) *Spinner

func NewSpinnerWasm added in v0.4.9 

func NewSpinnerWasm(noColor bool, outputFormat string) *Spinner

NewSpinnerWasm creates a spinner optimized for WASM display This is the non-WASM build version that uses the regular spinner

func NewSpinnerWithOutput added in v0.4.7 

func NewSpinnerWithOutput(noColor bool, outputFormat string) *Spinner

func PrintCustomSpinner added in v0.4.4 

func PrintCustomSpinner(action, resourceId string, noColor bool) *Spinner

func PrintListingResourceTags added in v0.4.3 

func PrintListingResourceTags(resourceType, uid string, noColor bool) *Spinner

func PrintLoggingIn added in v0.4.3 

func PrintLoggingIn(noColor bool) *Spinner

func PrintLoggingInWithOutput added in v0.4.7 

func PrintLoggingInWithOutput(noColor bool, outputFormat string) *Spinner

func PrintResourceCreating added in v0.4.0 

func PrintResourceCreating(resourceType, uid string, noColor bool) *Spinner

func PrintResourceDeleting added in v0.4.0 

func PrintResourceDeleting(resourceType, uid string, noColor bool) *Spinner

func PrintResourceGetting added in v0.4.0 

func PrintResourceGetting(resourceType, uid string, noColor bool) *Spinner

func PrintResourceGettingWithOutput added in v0.4.7 

func PrintResourceGettingWithOutput(resourceType, uid string, noColor bool, outputFormat string) *Spinner

func PrintResourceListing added in v0.4.0 

func PrintResourceListing(resourceType string, noColor bool) *Spinner

func PrintResourceProvisioning added in v0.5.6 

func PrintResourceProvisioning(resourceType, uid string, noColor bool) *Spinner

func PrintResourceUpdating added in v0.4.0 

func PrintResourceUpdating(resourceType, uid string, noColor bool) *Spinner

func PrintResourceValidating added in v0.4.3 

func PrintResourceValidating(resourceType string, noColor bool) *Spinner

func (*Spinner) Start added in v0.4.0 

func (s *Spinner) Start(prefix string)

func (*Spinner) StartWithElapsed added in v0.5.6 

func (s *Spinner) StartWithElapsed(prefix string)

StartWithElapsed starts the spinner, appending "(Xs elapsed)" to the prefix each animation tick.

func (*Spinner) Stop added in v0.4.0 

func (s *Spinner) Stop()

func (*Spinner) StopWithSuccess added in v0.4.0 

func (s *Spinner) StopWithSuccess(msg string)

type SpinnerInterface added in v0.4.9 

type SpinnerInterface interface {
	Start(message string)
	Stop()
}

SpinnerInterface allows different spinner implementations (WASM vs native)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.