terminal

Documentation

Overview

Package terminal is for terminal outputting

Index

• Variables
• func DisplayBrevLogo(t *Terminal)
• func PromptGetInput(pc PromptContent) string
• func PromptSelectInput(pc PromptSelectContent) string
• type Confirmer
• type ProgressBar
• type PromptContent
• type PromptSelectContent
• type Selector
• type Terminal
  • func New() (t *Terminal)
  • func (t *Terminal) Eprint(a string)
  • func (t *Terminal) Eprintf(format string, a ...interface{})
  • func (t *Terminal) Errprint(err error, a string)
  • func (t *Terminal) NewSpinner() *spinner.Spinner
  • func (t *Terminal) Print(a string)
  • func (t *Terminal) Vprint(a string)
  • func (t *Terminal) Vprintf(format string, a ...interface{})

Variables

var ProgressBarMax = 100

Functions

func DisplayBrevLogo

func DisplayBrevLogo(t *Terminal)

func PromptGetInput

func PromptGetInput(pc PromptContent) string

func PromptSelectInput

func PromptSelectInput(pc PromptSelectContent) string

Types

type Confirmer

type Confirmer interface {
	ConfirmYesNo(label string) bool
}

Confirmer prompts for yes/no confirmation.

type ProgressBar

type ProgressBar struct {
	Bar            *progressbar.ProgressBar
	CurrPercentage int
}

type PromptContent

type PromptContent struct {
	ErrorMsg   string
	Label      string
	Default    string
	AllowEmpty bool
	Mask       rune
}

type PromptSelectContent

type PromptSelectContent struct {
	ErrorMsg string
	Label    string
	Items    []string
}

type Selector

type Selector interface {
	Select(label string, items []string) string
}

Selector prompts the user to choose from a list of items.

type Terminal

type Terminal struct {
	Green    func(format string, a ...interface{}) string
	Yellow   func(format string, a ...interface{}) string
	Red      func(format string, a ...interface{}) string
	Blue     func(format string, a ...interface{}) string
	White    func(format string, a ...interface{}) string
	BoldBlue func(format string, a ...interface{}) string

	Bar ProgressBar

	Spinner *spinner.Spinner
	// contains filtered or unexported fields
}

func New

func New() (t *Terminal)

func (*Terminal) Eprint

func (t *Terminal) Eprint(a string)

func (*Terminal) Eprintf

func (t *Terminal) Eprintf(format string, a ...interface{})

func (*Terminal) Errprint

func (t *Terminal) Errprint(err error, a string)

func (*Terminal) NewSpinner

func (t *Terminal) NewSpinner() *spinner.Spinner

func (*Terminal) Print

func (t *Terminal) Print(a string)

Explicit error handling for Print functions

func (*Terminal) Vprint

func (t *Terminal) Vprint(a string)

func (*Terminal) Vprintf

func (t *Terminal) Vprintf(format string, a ...interface{})