console

Documentation

Index

• Variables
• func IntToCheckmark(i int) string
• func StringToCheckmark(s string) string
• type Checkmark
  • func Btoc(b bool) Checkmark
  • func Itoc(i int) Checkmark
  • func Stoc(s string) Checkmark
  • func (c Checkmark) Inverse() Checkmark
  • func (c Checkmark) String() string
• type Converter
• type Option
  • func Headers(hs ...string) Option
• type Question
  • func ForBool(key, text string, def bool) Question
  • func ForPassword(key, text string) Question
  • func ForString(key, text, def string) Question
• type Survey
  • func (s *Survey) Ask(qs []Question, v interface{}) error
• type Table
  • func NewTable(opts ...Option) *Table
  • func (t *Table) Append(row []string)
  • func (t *Table) Print(w io.Writer)

Variables

var (
	// Red can be used as Sprintf, where the output it wrapped in escape characters which will render the text red in terminals.
	Red = color.New(color.Bold, color.FgRed).SprintfFunc()
	// Green can be used as Sprintf, where the output it wrapped in escape characters which will render the text green in terminals.
	Green = color.New(color.Bold, color.FgGreen).SprintfFunc()
	// Yellow can be used as Sprintf, where the output it wrapped in escape characters which will render the text yellow in terminals.
	Yellow = color.New(color.Bold, color.FgYellow).SprintfFunc()
)

Functions

func IntToCheckmark

func IntToCheckmark(i int) string

IntToCheckmark returns a string with ansi color instruction characters: a red ✘ if the argument is zero, a green ✔ otherwise.

func StringToCheckmark

func StringToCheckmark(s string) string

StringToCheckmark returns a string with ansi color instruction characters: a red ✘ if the argument is "0", a yellow ? if the argument is "", a green ✔ otherwise.

Types

type Checkmark

type Checkmark string

Checkmark type is a string with some functions attached.

func Btoc

func Btoc(b bool) Checkmark

Btoc returns a Checkmark from a boolean, red ✘ if the argument is false, a green ✔ otherwise.

func Itoc

func Itoc(i int) Checkmark

Itoc returns a Checkmark from an int.

func Stoc

func Stoc(s string) Checkmark

Stoc returns a Checkmark from a string.

func (Checkmark) Inverse

func (c Checkmark) Inverse() Checkmark

Inverse returns the opposite of the given Checkmark: a red ✘ if the argument is a green ✔ and vice versa, a yellow ? otherwise.

func (Checkmark) String

func (c Checkmark) String() string

type Converter

type Converter interface {
	// Convert performs the conversion.
	Convert(s string) (interface{}, error)
}

Converter converts strings to any type.

type Option

type Option func(t *Table)

Option allows to mutate the table.

func Headers

func Headers(hs ...string) Option

Headers is an option to store the header texts in the table.

type Question

type Question struct {
	Key          string                 // Key identifies the target field name.
	Text         string                 // Text is presented to the user.
	Converter    Converter              // Converter should map text input to a target type.
	CustomSource func() (string, error) // CustomSource may replace the custom input source.
	Defaulter    func() interface{}     // Defaulter may supply a fallback value when an empty input is supplied.
}

Question is a container for confronting the user to decide on an answer. codebeat:disable[TOO_MANY_IVARS]

func ForBool

func ForBool(key, text string, def bool) Question

ForBool creates a Question with a bool as target value.

func ForPassword

func ForPassword(key, text string) Question

ForPassword creates a Question with a sting as target value. The input from the terminal will not be echoed.

func ForString

func ForString(key, text, def string) Question

ForString creates a Question with a string as target value.

type Survey

type Survey struct {
	In  io.Reader // In is the input source, e.g. os.Stdin.
	Out io.Writer // Out is the output sink, e.g. os.Stdout.
}

Survey contains the configuration on how to present/obtain questions/answers to/from the user.

func (*Survey) Ask

func (s *Survey) Ask(qs []Question, v interface{}) error

Ask confronts the user with the passed questions. Questions are traversed in order.

type Table

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

Table contains the data to draw a table.

func NewTable

func NewTable(opts ...Option) *Table

NewTable creates a new table and applies the given Options to it.

func (*Table) Append

func (t *Table) Append(row []string)

Append extends the table body by one line. The length of the row should match the length of the headers as well as the other rows.

func (*Table) Print

func (t *Table) Print(w io.Writer)

Print writes the text representation of the table to a given io.Writer.