ui

Documentation

Index

• func Bold(s string) string
• func Cyan(s string) string
• func Dim(s string) string
• func Error(msg string)
• func Green(s string) string
• func Header(msg string)
• func Info(msg string)
• func PrintJSON(v interface{}) error
• func Red(s string) string
• func StatusColor(status string) string
• func Step(msg string)
• func Success(msg string)
• func Table(headers []string, rows [][]string)
• func Warning(msg string)
• func Yellow(s string) string
• type Spinner
  • func NewSpinner(msg string) *Spinner
  • func (s *Spinner) Fail(errMsg string)
  • func (s *Spinner) Start()
  • func (s *Spinner) Stop(successMsg string)

Functions

func Bold

func Bold(s string) string

Bold returns a bold string.

func Cyan

func Cyan(s string) string

Cyan returns a cyan-colored string.

func Dim

func Dim(s string) string

Dim returns a dimmed string.

func Error

func Error(msg string)

Error prints a red error message with an X.

func Green

func Green(s string) string

Green returns a green-colored string.

func Header

func Header(msg string)

Header prints a bold section header.

func Info

func Info(msg string)

Info prints a cyan informational message.

func PrintJSON

func PrintJSON(v interface{}) error

PrintJSON pretty-prints a value as JSON.

func Red

func Red(s string) string

Red returns a red-colored string.

func StatusColor

func StatusColor(status string) string

StatusColor returns a colored status string.

func Step

func Step(msg string)

Step prints an in-progress step message (→ message).

func Success

func Success(msg string)

Success prints a green success message with a checkmark.

func Table

func Table(headers []string, rows [][]string)

Table renders a table to stdout.

func Warning

func Warning(msg string)

Warning prints a yellow warning message.

func Yellow

func Yellow(s string) string

Yellow returns a yellow-colored string.

Types

type Spinner

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

Spinner is a simple terminal spinner.

func NewSpinner

func NewSpinner(msg string) *Spinner

NewSpinner creates a new spinner with the given message.

func (*Spinner) Fail

func (s *Spinner) Fail(errMsg string)

Fail halts the spinner and prints an error message.

func (*Spinner) Start

func (s *Spinner) Start()

Start begins rendering the spinner in a goroutine.

func (*Spinner) Stop

func (s *Spinner) Stop(successMsg string)

Stop halts the spinner and prints a success message.