present

Documentation

Index

• func Confirm(title, description string, accessible bool) (bool, error)
• func GettingStarted(w io.Writer, color bool)
• func Human(w io.Writer, r report.Report, style Style)
• func HumanWatch(w io.Writer, timestamp string, severity report.Severity, message string, ...)
• func JSON(w io.Writer, r report.Report) error
• func NDJSON(w io.Writer, value any) error
• func PlainProgress(out io.Writer, work func(func(ProgressEvent)) (report.Report, error)) (report.Report, error)
• func RunProgress(ctx context.Context, out io.Writer, color bool, ...) (report.Report, error)
• func Select(title string, choices []Choice, accessible bool) (string, error)
• func SeverityLabel(severity report.Severity, color bool) string
• func WriteAtomic(path string, mode os.FileMode, write func(io.Writer) error) error
• type Choice
• type HomeChoice
  • func Home(accessible bool) (HomeChoice, error)
• type ProgressEvent
• type Style

Functions

func Confirm

func Confirm(title, description string, accessible bool) (bool, error)

func GettingStarted

func GettingStarted(w io.Writer, color bool)

func Human

func Human(w io.Writer, r report.Report, style Style)

func HumanWatch

func HumanWatch(w io.Writer, timestamp string, severity report.Severity, message string, color bool)

func JSON

func JSON(w io.Writer, r report.Report) error

func NDJSON

func NDJSON(w io.Writer, value any) error

func PlainProgress

func PlainProgress(out io.Writer, work func(func(ProgressEvent)) (report.Report, error)) (report.Report, error)

func RunProgress

func RunProgress(ctx context.Context, out io.Writer, color bool, work func(func(ProgressEvent)) (report.Report, error)) (report.Report, error)

func Select

func Select(title string, choices []Choice, accessible bool) (string, error)

func SeverityLabel

func SeverityLabel(severity report.Severity, color bool) string

func WriteAtomic

func WriteAtomic(path string, mode os.FileMode, write func(io.Writer) error) error

Types

type Choice

type Choice struct {
	Label string
	Value string
}

type HomeChoice

type HomeChoice struct {
	Task   string
	Target string
}

func Home

func Home(accessible bool) (HomeChoice, error)

type ProgressEvent

type ProgressEvent struct {
	ID       string
	Label    string
	Status   string
	Duration time.Duration
}

type Style

type Style struct {
	Color bool
	Width int
}