display

package
v5.5.1 Latest Latest
Warning

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

Go to latest
Published: Sep 3, 2026 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// ModeAuto detect console capabilities
	ModeAuto = "auto"
	// ModeTTY use terminal capability for advanced rendering
	ModeTTY = "tty"
	// ModePlain dump raw events to output
	ModePlain = "plain"
	// ModeQuiet don't display events
	ModeQuiet = "quiet"
	// ModeJSON outputs a machine-readable JSON stream
	ModeJSON = "json"
)
View Source
const (
	DRYRUN_PREFIX = " DRY-RUN MODE - "
)

Variables

View Source
var (
	DoneColor    colorFunc = aec.BlueF.Apply
	TimerColor   colorFunc = aec.BlueF.Apply
	CountColor   colorFunc = aec.YellowF.Apply
	WarningColor colorFunc = aec.YellowF.With(aec.Bold).Apply
	SuccessColor colorFunc = aec.GreenF.Apply
	ErrorColor   colorFunc = aec.RedF.With(aec.Bold).Apply
	PrefixColor  colorFunc = aec.CyanF.Apply
)
View Source
var Mode = ModeAuto

Mode is the effective progress rendering mode for the current command.

It starts as ModeAuto and is resolved during command setup by selectEventProcessor (cmd/compose), which assigns the mode matching the renderer it returns — so code running after setup never observes ModeAuto. The only other writers are the `--quiet` flags of `run` and `build`, which force ModeQuiet from their PreRun hooks.

Functions

func Full

func Full(out io.Writer, info io.Writer, detached bool) api.EventProcessor

Full creates an EventProcessor that render advanced UI within a terminal. On Start, TUI lists task with a progress timer

func JSON

func JSON(out io.Writer) api.EventProcessor

func NoColor

func NoColor()

func Plain

func Plain(out io.Writer) api.EventProcessor

func Quiet

func Quiet() api.EventProcessor

Types

type Spinner

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

func NewSpinner

func NewSpinner() *Spinner

func (*Spinner) Restart

func (s *Spinner) Restart()

func (*Spinner) Stop

func (s *Spinner) Stop()

func (*Spinner) String

func (s *Spinner) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL