processtree

Documentation

Index

• Constants
• func TraverseTreeAndCall(items []*ProcessTreeItem, callback func(*ProcessTreeItem) error) error
• type ProcessTree
  • func NewProcessTree(opts []ProcessTreeOption, tree ...*ProcessTreeItem) (*ProcessTree, error)
  • func (pt *ProcessTree) Init() tea.Cmd
  • func (pt *ProcessTree) Start() error
  • func (pt *ProcessTree) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (pt ProcessTree) View() string
• type ProcessTreeItem
  • func NewProcessTreeItem(textLeft, textRight string, process SpinnerProcess, ...) *ProcessTreeItem
  • func (pti *ProcessTreeItem) Write(p []byte) (int, error)
• type ProcessTreeOption
  • func IsParallel(parallel bool) ProcessTreeOption
  • func WithFailFast(failFast bool) ProcessTreeOption
  • func WithLogger(l log.Logger) ProcessTreeOption
  • func WithRenderer(norender bool) ProcessTreeOption
  • func WithVerb(verb string) ProcessTreeOption
• type SpinnerProcess
• type SpinnerProcessStatus

Constants

const (
	INDENTS = 4
	LOGLEN  = 5
)

Functions

func TraverseTreeAndCall

func TraverseTreeAndCall(items []*ProcessTreeItem, callback func(*ProcessTreeItem) error) error

Types

type ProcessTree

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

func NewProcessTree

func NewProcessTree(opts []ProcessTreeOption, tree ...*ProcessTreeItem) (*ProcessTree, error)

func (*ProcessTree) Init

func (pt *ProcessTree) Init() tea.Cmd

func (*ProcessTree) Start

func (pt *ProcessTree) Start() error

func (*ProcessTree) Update

func (pt *ProcessTree) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (ProcessTree) View

func (pt ProcessTree) View() string

type ProcessTreeItem

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

func NewProcessTreeItem

func NewProcessTreeItem(textLeft, textRight string, process SpinnerProcess, children ...*ProcessTreeItem) *ProcessTreeItem

func (*ProcessTreeItem) Write

func (pti *ProcessTreeItem) Write(p []byte) (int, error)

Write implements `io.Writer` so we can correctly direct the output from tree process to an inline fancy logger

type ProcessTreeOption

type ProcessTreeOption func(pt *ProcessTree) error

func IsParallel

func IsParallel(parallel bool) ProcessTreeOption

func WithFailFast

func WithFailFast(failFast bool) ProcessTreeOption

func WithLogger

func WithLogger(l log.Logger) ProcessTreeOption

func WithRenderer

func WithRenderer(norender bool) ProcessTreeOption

func WithVerb

func WithVerb(verb string) ProcessTreeOption

type SpinnerProcess

type SpinnerProcess func(l log.Logger) error

type SpinnerProcessStatus

type SpinnerProcessStatus uint

const (
	StatusPending SpinnerProcessStatus = iota
	StatusRunning
	StatusRunningChild
	StatusRunningButAChildHasFailed
	StatusFailed
	StatusFailedChild
	StatusSuccess
)