display

Documentation

Index

• type Event
• type EventKind
• type KeyValue
• type Renderer
  • func NewRenderer(out io.Writer, err io.Writer, jsonOut bool) *Renderer
  • func (r *Renderer) Close()
  • func (r *Renderer) Emit(event Event)
  • func (r *Renderer) Events() Sink
  • func (r *Renderer) PrintCommandList(title string, commands []string) error
  • func (r *Renderer) PrintJSON(value any) error
  • func (r *Renderer) PrintKeyValues(values []KeyValue) error
  • func (r *Renderer) PrintSummary(title string, values []KeyValue) error
  • func (r *Renderer) PrintText(text string) error
  • func (r *Renderer) Stderr() io.Writer
  • func (r *Renderer) Stdout() io.Writer
  • func (r *Renderer) TTY() bool
• type Sink

Types

type Event

type Event struct {
	Kind    EventKind
	Phase   string
	Message string
}

type EventKind

type EventKind string

const (
	EventProgress       EventKind = "progress"
	EventProgressOutput EventKind = "progress_output"
	EventWarning        EventKind = "warning"
	EventDebug          EventKind = "debug"
	EventClear          EventKind = "clear"
)

type KeyValue

type KeyValue struct {
	Key   string
	Value string
}

type Renderer

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

func NewRenderer

func NewRenderer(out io.Writer, err io.Writer, jsonOut bool) *Renderer

func (*Renderer) Close

func (r *Renderer) Close()

func (*Renderer) Emit

func (r *Renderer) Emit(event Event)

func (*Renderer) Events

func (r *Renderer) Events() Sink

func (*Renderer) PrintCommandList

func (r *Renderer) PrintCommandList(title string, commands []string) error

func (*Renderer) PrintJSON

func (r *Renderer) PrintJSON(value any) error

func (*Renderer) PrintKeyValues

func (r *Renderer) PrintKeyValues(values []KeyValue) error

func (*Renderer) PrintSummary

func (r *Renderer) PrintSummary(title string, values []KeyValue) error

func (*Renderer) PrintText

func (r *Renderer) PrintText(text string) error

func (*Renderer) Stderr

func (r *Renderer) Stderr() io.Writer

func (*Renderer) Stdout

func (r *Renderer) Stdout() io.Writer

func (*Renderer) TTY

func (r *Renderer) TTY() bool

type Sink

type Sink interface {
	Emit(Event)
}