ui

Documentation

Overview

Package ui centralizes terminal presentation: lipgloss styles, status messages, and the styled DNS plan and record renderers.

Index

• func CheckLine(label string, width int, ok bool, reason string) string
• func Detail(s string) string
• func Heading(format string, a ...any) string
• func Info(format string, a ...any) string
• func OK(format string, a ...any) string
• func RecordLegend(rows []RecordRow) string
• func RenderPlan(p reconcile.Plan) string
• func RenderRecords(rows []RecordRow) string
• func Warn(format string, a ...any) string
• func WithSpinner(ctx context.Context, msg string, fn func(context.Context) error) error
• type Mark
  • func (m Mark) Label() string
• type RecordRow

Functions

func CheckLine

func CheckLine(label string, width int, ok bool, reason string) string

func Detail

func Detail(s string) string

Detail renders multi-line output (e.g. a remote command's logs) dimmed and indented so it reads as secondary context.

func Heading

func Heading(format string, a ...any) string

Heading renders a bold accented title.

func Info

func Info(format string, a ...any) string

Info renders a muted, secondary line.

func OK

func OK(format string, a ...any) string

OK renders a success line ("✓ …").

func RecordLegend

func RecordLegend(rows []RecordRow) string

func RenderPlan

func RenderPlan(p reconcile.Plan) string

RenderPlan renders a reconcile plan as a colored diff (+ create, ~ update, - delete, ! conflict).

func RenderRecords

func RenderRecords(rows []RecordRow) string

func Warn

func Warn(format string, a ...any) string

Warn renders a cautionary line ("! …").

func WithSpinner

func WithSpinner(ctx context.Context, msg string, fn func(context.Context) error) error

Types

type Mark

type Mark int

const (
	MarkNone Mark = iota
	MarkOK
	MarkMissing
	MarkDrift
	MarkConflict
	MarkNA
	MarkUnknown
)

func (Mark) Label

func (m Mark) Label() string

type RecordRow

type RecordRow struct {
	Zone                 string
	Record, Value, Proxy string
	Local, DNS, Remote   Mark
}