tui

Documentation

Index

• Constants
• func GetProgram(ctx context.Context) *tea.Program
• func NewLogCore(opts logging.LogOpts, verbosity Verbosity, program *tea.Program) zapcore.Core
• func NewModel(verbosity Verbosity) *model
• func RenderLogo() string
• func WithProgram(ctx context.Context, p *tea.Program) context.Context
• func WithProgress(ctx context.Context, progress Progress) context.Context
• type ErrorMessage
• type LogCore
  • func (c *LogCore) Check(e zapcore.Entry, ce *zapcore.CheckedEntry) *zapcore.CheckedEntry
  • func (c *LogCore) With(f []zapcore.Field) zapcore.Core
  • func (c *LogCore) Write(ent zapcore.Entry, fields []zapcore.Field) error
• type LogMessage
• type LogProgress
  • func (p LogProgress) Complete(status string)
  • func (p LogProgress) Update(status string, current, total int)
  • func (p LogProgress) UpdateIndeterminate(status string)
• type OutputMessage
• type Progress
  • func GetProgress(ctx context.Context) Progress
• type RingBuffer
  • func NewRingBuffer[T any](size int) *RingBuffer[T]
  • func (r *RingBuffer[T]) Cap() int
  • func (r *RingBuffer[T]) Clear()
  • func (r *RingBuffer[T]) ForEach(f func(int, T))
  • func (r *RingBuffer[T]) Get(i int) (T, bool)
  • func (r *RingBuffer[T]) Len() int
  • func (r *RingBuffer[T]) Pop() T
  • func (r *RingBuffer[T]) Push(v T)
  • func (r *RingBuffer[T]) Set(i int, v T) bool
• type TuiProgress
  • func (p *TuiProgress) Complete(status string)
  • func (p *TuiProgress) Update(status string, current, total int)
  • func (p *TuiProgress) UpdateIndeterminate(status string)
• type UpdateMessage
• type Verbosity
  • func (v Verbosity) CombineLogs() bool
  • func (v Verbosity) LogLevel() zapcore.Level

Constants

const LogoColor = "#816FA6"

Functions

func GetProgram

func GetProgram(ctx context.Context) *tea.Program

func NewLogCore

func NewLogCore(opts logging.LogOpts, verbosity Verbosity, program *tea.Program) zapcore.Core

func NewModel

func NewModel(verbosity Verbosity) *model

func RenderLogo

func RenderLogo() string

func WithProgram

func WithProgram(ctx context.Context, p *tea.Program) context.Context

func WithProgress

func WithProgress(ctx context.Context, progress Progress) context.Context

Types

type ErrorMessage

type ErrorMessage struct {
	Message string
}

type LogCore

type LogCore struct {
	zapcore.Core
	// contains filtered or unexported fields
}

func (*LogCore) Check

func (c *LogCore) Check(e zapcore.Entry, ce *zapcore.CheckedEntry) *zapcore.CheckedEntry

func (*LogCore) With

func (c *LogCore) With(f []zapcore.Field) zapcore.Core

func (*LogCore) Write

func (c *LogCore) Write(ent zapcore.Entry, fields []zapcore.Field) error

type LogMessage

type LogMessage struct {
	Construct string
	Message   string
}

type LogProgress

type LogProgress struct {
	Logger *zap.Logger
}

func (LogProgress) Complete

func (p LogProgress) Complete(status string)

func (LogProgress) Update

func (p LogProgress) Update(status string, current, total int)

func (LogProgress) UpdateIndeterminate

func (p LogProgress) UpdateIndeterminate(status string)

type OutputMessage

type OutputMessage struct {
	Construct string
	Name      string
	Value     any
}

type Progress

type Progress interface {
	// Update updates the progress status with the current and total count.
	Update(status string, current, total int)
	UpdateIndeterminate(status string)
	Complete(status string)
}

func GetProgress

func GetProgress(ctx context.Context) Progress

type RingBuffer

type RingBuffer[T any] struct {
	// contains filtered or unexported fields
}

func NewRingBuffer

func NewRingBuffer[T any](size int) *RingBuffer[T]

func (*RingBuffer[T]) Cap

func (r *RingBuffer[T]) Cap() int

func (*RingBuffer[T]) Clear

func (r *RingBuffer[T]) Clear()

func (*RingBuffer[T]) ForEach

func (r *RingBuffer[T]) ForEach(f func(int, T))

func (*RingBuffer[T]) Get

func (r *RingBuffer[T]) Get(i int) (T, bool)

func (*RingBuffer[T]) Len

func (r *RingBuffer[T]) Len() int

func (*RingBuffer[T]) Pop

func (r *RingBuffer[T]) Pop() T

func (*RingBuffer[T]) Push

func (r *RingBuffer[T]) Push(v T)

func (*RingBuffer[T]) Set

func (r *RingBuffer[T]) Set(i int, v T) bool

type TuiProgress

type TuiProgress struct {
	Prog      *tea.Program
	Construct string
}

func (*TuiProgress) Complete

func (p *TuiProgress) Complete(status string)

func (*TuiProgress) Update

func (p *TuiProgress) Update(status string, current, total int)

func (*TuiProgress) UpdateIndeterminate

func (p *TuiProgress) UpdateIndeterminate(status string)

type UpdateMessage

type UpdateMessage struct {
	Construct string
	Status    string

	Percent       float64
	Indeterminate bool
	Complete      bool
}

type Verbosity

type Verbosity int

var (
	VerbosityConcise   Verbosity = 0
	VerbosityVerbose   Verbosity = 1
	VerbosityDebug     Verbosity = 2
	VerbosityDebugMore Verbosity = 3
)

func (Verbosity) CombineLogs

func (v Verbosity) CombineLogs() bool

CombineLogs controls whether to show all logs commingled in the TUI. In other words, sorted by timestamp, not grouped by construct.

func (Verbosity) LogLevel

func (v Verbosity) LogLevel() zapcore.Level