ui

Documentation

Overview

Package ui helps get user input from the terminal, and formats output.

Index

• Variables
• func Accept(question string) bool
• func Blue(in string) string
• func BlueBold(in string) string
• func BlueBoldUnderlined(in string) string
• func BlueDark(in string) string
• func BlueUnderlined(in string) string
• func Edit(oldValue string) (string, error)
• func GetInput(in *os.File) (string, error)
• func Green(in string) string
• func GreenBold(in string) string
• func GreenUnderlined(in string) string
• func Header(msg string, args ...interface{})
• func Red(in string) string
• func RedBold(in string) string
• func RedUnderlined(in string) string
• func RemoveColor(str string) string
• func SelectAmongOptions(title, usage string, options []string, optionTags map[string]string) (string, error)
• func SelectAmongStrictOptions(title, usage string, options []string, optionTags map[string]string) (string, error)
• func SelectAmongValues(title, usage string, options []string, optionTags map[string]string) (string, error)
• func SelectLongOptionalValue(title, usage string, options []string) (string, error)
• func SelectLongValue(title, usage string, options []string) (string, error)
• func SelectOptionalValue(title, usage string, options []string) (string, error)
• func SelectValue(title, usage string, options []string) (string, error)
• func SpinWhileThingsHappen(title string, f func() error) error
• func TabulateMap(input map[string]int, firstHeader string, secondHeader string) (table string)
• func TabulateRows(rows [][]string, headers ...string) (table string)
• func Title(msg string, args ...interface{})
• func Usage(msg string, args ...interface{})
• func UserChoice(msg string, args ...interface{})
• func Warning(in string) string
• func Yellow(in string) string
• func YellowBold(in string) string
• func YellowUnderlined(in string) string

Variables

var (
	ErrorSkipped = errors.New("skipped choice")
)

Functions

func Accept

func Accept(question string) bool

Accept asks a question and returns the answer.

func Blue

func Blue(in string) string

Blue outputs a string in blue.

func BlueBold

func BlueBold(in string) string

BlueBold outputs a string in blue bold.

func BlueBoldUnderlined

func BlueBoldUnderlined(in string) string

BlueBold outputs a string in blue bold.

func BlueDark

func BlueDark(in string) string

Blue outputs a string in blue.

func BlueUnderlined

func BlueUnderlined(in string) string

BlueUnderlined outputs a string in blue, underlined.

func Edit

func Edit(oldValue string) (string, error)

Edit long value using external $EDITOR.

func GetInput

func GetInput(in *os.File) (string, error)

GetInput from user.

func Green

func Green(in string) string

Green outputs a string in green.

func GreenBold

func GreenBold(in string) string

GreenBold outputs a string in green bold.

func GreenUnderlined

func GreenUnderlined(in string) string

GreenUnderlined outputs a string in green, underlined.

func Header

func Header(msg string, args ...interface{})

Header message logging.

func Red

func Red(in string) string

Red outputs a string in red.

func RedBold

func RedBold(in string) string

RedBold outputs a string in red bold.

func RedUnderlined

func RedUnderlined(in string) string

RedUnderlined outputs a string in red, underlined.

func RemoveColor

func RemoveColor(str string) string

func SelectAmongOptions

func SelectAmongOptions(title, usage string, options []string, optionTags map[string]string) (string, error)

func SelectAmongStrictOptions

func SelectAmongStrictOptions(title, usage string, options []string, optionTags map[string]string) (string, error)

func SelectAmongValues

func SelectAmongValues(title, usage string, options []string, optionTags map[string]string) (string, error)

func SelectLongOptionalValue

func SelectLongOptionalValue(title, usage string, options []string) (string, error)

func SelectLongValue

func SelectLongValue(title, usage string, options []string) (string, error)

func SelectOptionalValue

func SelectOptionalValue(title, usage string, options []string) (string, error)

func SelectValue

func SelectValue(title, usage string, options []string) (string, error)

func SpinWhileThingsHappen

func SpinWhileThingsHappen(title string, f func() error) error

SpinWhileThingsHappen is a way to launch a function and display a spinner while it is being executed.

func TabulateMap

func TabulateMap(input map[string]int, firstHeader string, secondHeader string) (table string)

TabulateMap of map[string]int.

func TabulateRows

func TabulateRows(rows [][]string, headers ...string) (table string)

TabulateRows of map[string]int.

func Title

func Title(msg string, args ...interface{})

Title message logging.

func Usage

func Usage(msg string, args ...interface{})

Usage message logging.

func UserChoice

func UserChoice(msg string, args ...interface{})

UserChoice message logging.

func Warning

func Warning(in string) string

Warning output.

func Yellow

func Yellow(in string) string

Yellow outputs a string in yellow.

func YellowBold

func YellowBold(in string) string

YellowBold outputs a string in bold yellow.

func YellowUnderlined

func YellowUnderlined(in string) string

YellowUnderlined outputs a string in yellow, underlined.