reporter

Documentation

Index

• Constants
• Variables
• func GetTerminalSize(w io.Writer) (width, height int, err error)
• func IsTerminal(w io.Writer) bool
• type ProgressTask
  • func (pt *ProgressTask) Done()
  • func (pt *ProgressTask) Name() string
  • func (pt *ProgressTask) Update(v float64)
• type Reporter
  • func New(out io.Writer) *Reporter
  • func (r *Reporter) AddRow(name string) *Row
  • func (r *Reporter) DeleteRow(row *Row)
  • func (r *Reporter) IsTerminal() bool
  • func (r *Reporter) LogErrorSink() io.Writer
  • func (r *Reporter) LogSink() io.Writer
  • func (r *Reporter) Refresh()
• type Row
  • func (row *Row) AddProgressTask(name string) *ProgressTask
  • func (row *Row) AddStatus(s *Status)
  • func (row *Row) Name() string
  • func (row *Row) RemoveStatus(s *Status) bool
• type Status

Constants

const (
	RefreshInterval = 100 * time.Millisecond
)

Variables

var (
	StatusDockerPush = &Status{
		Text:      "pushing image",
		TextWidth: 13,
		Priority:  1,
	}
	StatusDockerPull = &Status{
		Text:      "pulling image",
		TextWidth: 13,
		Priority:  1,
	}
	StatusWaiting = &Status{
		TextWidth: 7,
		Text:      "waiting",
		Priority:  0,
	}
	StatusRunning = &Status{
		Text:      "running ⭐️",
		TextWidth: 10,
		Priority:  2,
	}
	StatusReady = &Status{
		Text:      "ready ⭐️",
		TextWidth: 8,
		Priority:  3,
	}
)

Functions

func GetTerminalSize

func GetTerminalSize(w io.Writer) (width, height int, err error)

func IsTerminal

func IsTerminal(w io.Writer) bool

Types

type ProgressTask

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

func (*ProgressTask) Done

func (pt *ProgressTask) Done()

func (*ProgressTask) Name

func (pt *ProgressTask) Name() string

func (*ProgressTask) Update

func (pt *ProgressTask) Update(v float64)

type Reporter

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

func New

func New(out io.Writer) *Reporter

func (*Reporter) AddRow

func (r *Reporter) AddRow(name string) *Row

func (*Reporter) DeleteRow

func (r *Reporter) DeleteRow(row *Row)

func (*Reporter) IsTerminal

func (r *Reporter) IsTerminal() bool

func (*Reporter) LogErrorSink

func (r *Reporter) LogErrorSink() io.Writer

func (*Reporter) LogSink

func (r *Reporter) LogSink() io.Writer

func (*Reporter) Refresh

func (r *Reporter) Refresh()

type Row

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

func (*Row) AddProgressTask

func (row *Row) AddProgressTask(name string) *ProgressTask

func (*Row) AddStatus

func (row *Row) AddStatus(s *Status)

func (*Row) Name

func (row *Row) Name() string

func (*Row) RemoveStatus

func (row *Row) RemoveStatus(s *Status) bool

type Status

type Status struct {
	Priority  int
	Text      string
	TextWidth int
}