console

README

Console UI

The console UI is based on Buildkit's, which was pretty much perfect. The original authors at time of extraction are listed in AUTHORS.

Documentation

Index

• Constants
• func NewWriter(w io.Writer, opts ...WriterOpt) progrock.Writer
• type Components
  • func DefaultUI(out *termenv.Output) Components
• type Writer
  • func (w *Writer) Close() error
  • func (w *Writer) WriteStatus(status *progrock.StatusUpdate) error
• type WriterOpt
  • func ShowInternal(show bool) WriterOpt
  • func WithClock(clock clockwork.Clock) WriterOpt
  • func WithMessageLevel(level progrock.MessageLevel) WriterOpt
  • func WithUI(ui Components) WriterOpt

Constants

const AntiFlicker = 5 * time.Second

AntiFlicker is used to prevent bouncing between concurrent vertices too aggressively.

const MaxDelay = 10 * time.Second

MaxDelay is the maximum amount of time to favor the current vertex over other active vertices.

const MinProgressDelta = 0.05 // %

MinProgressDelta is the minimum progress percent to require before printing updates to a task.

const MinTimeDelta = 5 * time.Second

MinTimeDelta is the minimum amount of time to require before printing updates to a task.

Functions

func NewWriter

func NewWriter(w io.Writer, opts ...WriterOpt) progrock.Writer

Types

type Components

type Components struct {
	TextContextSwitched           string
	TextLogFormat                 string
	TextVertexRunning             string
	TextVertexCanceled            string
	TextVertexErrored             string
	TextVertexCached              string
	TextVertexDone                string
	TextVertexDoneDuration        string
	TextVertexGroup               string
	TextVertexTask                string
	TextVertexTaskDuration        string
	TextVertexTaskProgressBound   string
	TextVertexTaskProgressUnbound string

	RunningDuration, DoneDuration string
}

func DefaultUI

func DefaultUI(out *termenv.Output) Components

type Writer

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

func (*Writer) Close

func (w *Writer) Close() error

func (*Writer) WriteStatus

func (w *Writer) WriteStatus(status *progrock.StatusUpdate) error

type WriterOpt

type WriterOpt func(*Writer)

func ShowInternal

func ShowInternal(show bool) WriterOpt

func WithClock

func WithClock(clock clockwork.Clock) WriterOpt

func WithMessageLevel

func WithMessageLevel(level progrock.MessageLevel) WriterOpt

func WithUI

func WithUI(ui Components) WriterOpt