interact

README

Interactive methods

console interactive methods

• ReadInput
• ReadLine
• ReadFirst
• Prompt
• Confirm
• Query/Question/Ask
• Select/Choice
• MultiSelect/Checkbox
• ReadPassword

Documentation

Overview

Package interact collect some interactive methods for CLI

Index

• Constants
• func AnswerIsYes(defVal ...bool) bool
• func Ask(question, defVal string, fn func(ans string) error, maxTimes ...int) string
• func Checkbox(title string, options interface{}, defOpts []string, allowQuit ...bool) []string
• func Choice(title string, options interface{}, defOpt string, allowQuit ...bool) string
• func Confirm(message string, defVal ...bool) bool
• func GetHiddenInput(message string, trimmed bool) string
• func MultiSelect(title string, options interface{}, defOpts []string, allowQuit ...bool) []string
• func Prompt(ctx context.Context, query, defaultAnswer string) (string, error)
• func Query(question, defVal string, fn func(ans string) error, maxTimes ...int) string
• func ReadFirst(question string) (string, error)
• func ReadInput(question string) (string, error)
• func ReadLine(question string) (string, error)
• func ReadPassword(message ...string) string
• func SingleSelect(title string, options interface{}, defOpt string, allowQuit ...bool) string
• func Unconfirmed(message string, defVal ...bool) bool
• type Interactive
  • func New(name string) *Interactive
• type Option
• type Question
  • func NewQuestion(q string, defVal ...string) *Question
  • func (q *Question) Run() *Value
• type RunFace
• type Select
  • func NewSelect(title string, options interface{}) *Select
  • func (s *Select) Run() *Value
• type StepHandler
• type StepsRun
  • func (s *StepsRun) Err() error
  • func (s *StepsRun) Run()
  • func (s *StepsRun) Stop()
• type Value
  • func (v Value) Int() (val int)
  • func (v Value) IsEmpty() bool
  • func (v Value) Set(val interface{})
  • func (v Value) String() string
  • func (v Value) Strings() (ss []string)
  • func (v Value) Val() interface{}

Constants

const (
	// OK success exit code
	OK = 0
	// ERR error exit code
	ERR = 2
)

Functions

func AnswerIsYes

func AnswerIsYes(defVal ...bool) bool

AnswerIsYes check user inputted answer is right Usage:

fmt.Print("are you OK?")
ok := AnswerIsYes()
ok := AnswerIsYes(true)

func Ask

func Ask(question, defVal string, fn func(ans string) error, maxTimes ...int) string

Ask a question and return the result of the input. Usage:

answer := Ask("Your name?", "", nil)
answer := Ask("Your name?", "tom", nil)
answer := Ask("Your name?", "", nil, 3)

func Checkbox

func Checkbox(title string, options interface{}, defOpts []string, allowQuit ...bool) []string

Checkbox is alias of method MultiSelect()

func Choice

func Choice(title string, options interface{}, defOpt string, allowQuit ...bool) string

Choice is alias of method SingleSelect()

func Confirm

func Confirm(message string, defVal ...bool) bool

Confirm a question, returns bool

func GetHiddenInput

func GetHiddenInput(message string, trimmed bool) string

GetHiddenInput interactively prompts for input without echoing to the terminal. usage:

// askPassword
pwd := GetHiddenInput("Enter Password:")

func MultiSelect

func MultiSelect(title string, options interface{}, defOpts []string, allowQuit ...bool) []string

MultiSelect select multi of the options, returns selected option values. like SingleSelect(), but allow select multi option

func Prompt

func Prompt(ctx context.Context, query, defaultAnswer string) (string, error)

Prompt query and read user answer.

Usage:

answer,err := Prompt(context.TODO(), "your name?", "")

from package golang.org/x/tools/cmd/getgo

func Query

func Query(question, defVal string, fn func(ans string) error, maxTimes ...int) string

Query is alias of method Ask()

func ReadFirst

func ReadFirst(question string) (string, error)

ReadFirst read first char

func ReadInput

func ReadInput(question string) (string, error)

ReadInput read user input form Stdin

func ReadLine

func ReadLine(question string) (string, error)

ReadLine read one line from user input. Usage:

in := ReadLine("")
ans := ReadLine("your name?")

func ReadPassword

func ReadPassword(message ...string) string

ReadPassword from terminal

func SingleSelect

func SingleSelect(title string, options interface{}, defOpt string, allowQuit ...bool) string

SingleSelect select one of the options, returns selected option value map options:

	{
   // option value => option name
   'a' => 'chengdu',
   'b' => 'beijing'
	}

array options:

	{
   // only name, value will use index
   'chengdu',
   'beijing'
	}

func Unconfirmed

func Unconfirmed(message string, defVal ...bool) bool

Unconfirmed a question, returns bool

Types

type Interactive

type Interactive struct {
	Name string
}

Interactive

func New

func New(name string) *Interactive

type Option

type Option struct {
	Quit bool
	// default value
	DefVal string
}

Option

type Question

type Question struct {
	// Q the question string
	Q string
	// Func validate user input answer is right.
	// if not set, will only check answer is empty.
	Func func(ans string) error
	// DefVal default value
	DefVal string
	// MaxTimes maximum allowed number of errors, 0 is don't limited
	MaxTimes int
	// contains filtered or unexported fields
}

Question definition

func NewQuestion

func NewQuestion(q string, defVal ...string) *Question

NewQuestion instance. usage:

q := NewQuestion("Please input your name?")
val := q.Run().String()

func (*Question) Run

func (q *Question) Run() *Value

Run run and returns value

type RunFace

type RunFace interface {
	Run() *Value
}

RunFace for interact methods

type Select

type Select struct {
	// Title message for select. e.g "Your city?"
	Title string
	// Options the options data for select. allow: []int,[]string,map[string]string
	Options interface{}
	// DefOpt default option when not input answer
	DefOpt string
	// DefOpts use for `MultiSelect` is true
	DefOpts []string
	// DisableQuit option. if is false, will display "quit" option. default False
	DisableQuit bool
	// MultiSelect allow multi select. default False
	MultiSelect bool
	// contains filtered or unexported fields
}

Select definition

func NewSelect

func NewSelect(title string, options interface{}) *Select

NewSelect instance. usage:

s := NewSelect("Your city?", []string{"chengdu", "beijing"})
val := s.Run().String() // "1"

func (*Select) Run

func (s *Select) Run() *Value

Run select and receive use input answer

type StepHandler

type StepHandler func(ctx context.Context) error

StepHandler for steps run

type StepsRun

type StepsRun struct {

	// Steps step name and handler define.
	// {
	//	// step 1
	// 	func(ctx context.Context) { do something.}
	//	// step 2
	// 	func(ctx context.Context) { do something.}
	// }
	Steps []StepHandler
	// contains filtered or unexported fields
}

StepsRun follow the steps to run

func (*StepsRun) Err

func (s *StepsRun) Err() error

Err get error

func (*StepsRun) Run

func (s *StepsRun) Run()

Run all steps

func (*StepsRun) Stop

func (s *StepsRun) Stop()

Stop set stop run

type Value

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

Value data store

func (Value) Int

func (v Value) Int() (val int)

Int value

func (Value) IsEmpty

func (v Value) IsEmpty() bool

IsEmpty value

func (Value) Set

func (v Value) Set(val interface{})

Set val

func (Value) String

func (v Value) String() string

String value

func (Value) Strings

func (v Value) Strings() (ss []string)

Strings value

func (Value) Val

func (v Value) Val() interface{}

Val get