Documentation
¶
Overview ¶
Package output renders command results in one of three user-selected formats: a human-friendly table, JSON, or YAML.
Every service command should hand its result to Print so the global --output flag works uniformly. Table rendering is opt-in per command: callers describe the columns they want via Table; for JSON/YAML the value is encoded as-is.
Index ¶
Constants ¶
const ( FormatTable = "table" FormatJSON = "json" FormatYAML = "yaml" )
Format names. Kept as strings so the cobra flag can use them directly.
Variables ¶
var NoStyle = Style{StatusColumn: -1}
NoStyle is the zero value Style — no status column. Spelled out for readability at call sites.
Functions ¶
func IsInteractive ¶
IsInteractive reports whether w is a real terminal. Exported so command packages can decide whether to emit chatty stderr hints. Non-*os.File writers (test buffers, captured stderr) are treated as non-interactive.
func Print ¶
Print writes value to w in the requested format. For table format, value must be a Table[T]; for JSON/YAML, Table[T] is automatically unwrapped to its Items slice (the Rows function isn't marshallable).
func PrintPaged ¶
PrintPaged behaves like Print, but pipes the output through a pager program when (a) the format is table, (b) w is an interactive terminal, and (c) the user hasn't disabled paging via the flag.
The pager is taken from $NORCUBE_PAGER, then $PAGER, then "less". We set LESS=FRX so less:
- F: prints content inline and exits if it fits in one screen
- R: passes our ANSI color escapes through unmolested
- X: doesn't clear the screen on exit (output stays scrolled-back)
When the pager program can't be started (e.g. less isn't installed) we fall back to direct Print rather than failing the command.
Types ¶
type Style ¶
type Style struct {
// StatusColumn is the 0-based column index whose values should be
// recognised as success/failed/running etc. and colored. Negative
// means no column is treated as status.
StatusColumn int
}
Style controls how a Table is rendered. Header bold, status colors, and dim placeholders are all conditional on isInteractive(w) and the NO_COLOR environment variable — pipes and CI logs get plain text.
type Table ¶
type Table[T any] struct { Headers []string Rows func(T) []string Items []T MaxWidths []int Style Style }
Table describes how to render a slice of items as a table.
output.Print(w, format, output.Table[Foo]{
Headers: []string{"NAME", "ID"},
Rows: func(f Foo) []string { return []string{f.Name, f.ID} },
Items: foos,
MaxWidths: []int{40, 0}, // cap NAME at 40 runes; leave ID full
Style: output.Style{StatusColumn: 1},
})
MaxWidths is parallel to Headers. A zero (or out-of-range) entry means the column is uncapped. Cells longer than the cap are truncated to (max-1) runes and a "…" is appended.
Style controls header-bold, status-color, and dim-placeholder rendering. All styling is no-op'd when output isn't an interactive terminal or when NO_COLOR is set.