ui

Mar 11, 2023

Changes in this version

type Responder

+ func RespondDefault() Responder

Mar 10, 2023

Changes in this version

+ type PromptOpt func(params *PromptParams)

+ func WithHelp(text string) PromptOpt

+ func WithValidation(rules string) PromptOpt

+ type PromptParams struct

+ Help string

+ ValidationRules string

+ func GetPromptParams(opts ...PromptOpt) *PromptParams

Mar 9, 2023

Changes in this version

+ func EnvColorDisabled() bool

+ func EnvColorForced() bool

+ func IsTerminal(stream IOStream) bool

+ func MatchAny(p Prompt) bool

+ type Formatter struct

+ func NewFormatter(enabled bool) *Formatter

+ func (f *Formatter) Blue(t string) string

+ func (f *Formatter) Bluef(t string, args ...interface{}) string

+ func (f *Formatter) Bold(t string) string

+ func (f *Formatter) Boldf(t string, args ...interface{}) string

+ func (f *Formatter) Color(s string, style string) string

+ func (f *Formatter) Cyan(t string) string

+ func (f *Formatter) Cyanf(t string, args ...interface{}) string

+ func (f *Formatter) Failure(t string) string

+ func (f *Formatter) FailureIcon() string

+ func (f *Formatter) Gray(t string) string

+ func (f *Formatter) Grayf(t string, args ...interface{}) string

+ func (f *Formatter) Green(t string) string

+ func (f *Formatter) Greenf(t string, args ...interface{}) string

+ func (f *Formatter) Info(t string) string

+ func (f *Formatter) InfoIcon() string

+ func (f *Formatter) Magenta(t string) string

+ func (f *Formatter) Magentaf(t string, args ...interface{}) string

+ func (f *Formatter) Red(t string) string

+ func (f *Formatter) Redf(t string, args ...interface{}) string

+ func (f *Formatter) Success(t string) string

+ func (f *Formatter) SuccessIcon() string

+ func (f *Formatter) Underline(t string) string

+ func (f *Formatter) Underlinef(t string, args ...interface{}) string

+ func (f *Formatter) Warning(t string) string

+ func (f *Formatter) WarningIcon() string

+ func (f *Formatter) Yellow(t string) string

+ func (f *Formatter) Yellowf(t string, args ...interface{}) string

+ type IOStream interface

+ Fd func() uintptr

+ Lines func() []string

+ String func() string

+ type IOStreams struct

+ Err IOStream

+ In IOStream

+ Out IOStream

+ func NewIOStreams() *IOStreams

+ func NewTestIOStreams() *IOStreams

+ func (s *IOStreams) Formatter() *Formatter

+ func (s *IOStreams) IsColorEnabled() bool

+ func (s *IOStreams) IsInteractive() bool

+ func (s *IOStreams) IsStderrTTY() bool

+ func (s *IOStreams) IsStdinTTY() bool

+ func (s *IOStreams) IsStdoutTTY() bool

+ func (s *IOStreams) ProgressIndicator() *ProgressIndicator

+ func (s *IOStreams) Prompter() *SurveyPrompter

+ func (s *IOStreams) SetColorEnabled(v bool)

+ func (s *IOStreams) SetInteractive(v bool)

+ func (s *IOStreams) SetStderrTTY(isTTY bool)

+ func (s *IOStreams) SetStdinTTY(isTTY bool)

+ func (s *IOStreams) SetStdoutTTY(isTTY bool)

+ type Matcher func(p Prompt) bool

+ func MatchConfirm(msg string) Matcher

+ func MatchInput(msg string) Matcher

+ func MatchMultiSelect(msg string) Matcher

+ func MatchSelect(msg string) Matcher

+ type ProgressIndicator struct

+ func NewProgressIndicator(ios *IOStreams) *ProgressIndicator

+ func (pi *ProgressIndicator) IsEnabled() bool

+ func (pi *ProgressIndicator) Start()

+ func (pi *ProgressIndicator) StartWithLabel(label string)

+ func (pi *ProgressIndicator) Stop()

+ type Prompt struct

+ Help string

+ Message string

+ Options any

+ Type PromptType

+ Value any

+ func (p Prompt) String() string

+ type PromptType int

+ var PromptTypeConfirm PromptType = 1

+ var PromptTypeInput PromptType = 2

+ var PromptTypeMultiSelect PromptType = 3

+ var PromptTypeSelect PromptType = 4

+ var PromptTypeUnknown PromptType = 0

+ func (pt PromptType) String() string

+ type Responder func(prompt Prompt) (response any, err error)

+ func RespondBool(response bool) Responder

+ func RespondError(err error) Responder

+ func RespondString(response string) Responder

+ func RespondStringSlice(response []string) Responder

+ type Stub struct

+ Matched bool

+ Matcher Matcher

+ Responder Responder

+ type StubPrompter struct

+ func NewStubPrompter(ios *IOStreams) *StubPrompter

+ func (sp *StubPrompter) Confirm(msg string, value bool, help string) (bool, error)

+ func (sp *StubPrompter) Input(msg string, value string, help string) (string, error)

+ func (sp *StubPrompter) MultiSelect(msg string, options []string, values []string, help string) ([]string, error)

+ func (sp *StubPrompter) RegisterStub(matcher Matcher, responder Responder) *StubPrompter

+ func (sp *StubPrompter) Select(msg string, options []string, value string, help string) (string, error)

+ func (sp *StubPrompter) VerifyStubs(test testable)

+ type UserInterface struct

+ ProgressIndicator *ProgressIndicator

+ Prompter Prompter

+ func NewUserInterface(ios *IOStreams) *UserInterface

+ func (ui *UserInterface) Confirm(msg string, value bool, help string) (bool, error)

+ func (ui *UserInterface) Err(s string, args ...any)

+ func (ui *UserInterface) Input(msg string, value string, help string) (string, error)

+ func (ui *UserInterface) IsStubbed() bool

+ func (ui *UserInterface) MultiSelect(msg string, options []string, values []string, help string) ([]string, error)

+ func (ui *UserInterface) Out(s string, args ...any)

+ func (ui *UserInterface) RegisterStub(matcher Matcher, responder Responder) *UserInterface

+ func (ui *UserInterface) Select(msg string, options []string, value string, help string) (string, error)

+ func (ui *UserInterface) VerifyStubs(t testable)

+ func (ui *UserInterface) WithStubbing() *UserInterface

Nov 6, 2022

Changes in this version

+ type PrompterMock struct

+ ConfirmFunc func(msg string, value bool, help string) (bool, error)

+ InputFunc func(msg string, value string, help string) (string, error)

+ MultiSelectFunc func(msg string, options []string, values []string, help string) ([]string, error)

+ SelectFunc func(msg string, options []string, value string, help string) (string, error)

+ func NewPrompterMock() *PrompterMock

+ func (mock *PrompterMock) Confirm(msg string, value bool, help string) (bool, error)

+ func (mock *PrompterMock) ConfirmCalls() []struct{ ... }

+ func (mock *PrompterMock) Input(msg string, value string, help string) (string, error)

+ func (mock *PrompterMock) InputCalls() []struct{ ... }

+ func (mock *PrompterMock) MultiSelect(msg string, options []string, values []string, help string) ([]string, error)

+ func (mock *PrompterMock) MultiSelectCalls() []struct{ ... }

+ func (mock *PrompterMock) Select(msg string, options []string, value string, help string) (string, error)

+ func (mock *PrompterMock) SelectCalls() []struct{ ... }

Nov 2, 2022

Changes in this version

+ type Messenger struct

+ func NewMessenger(ios *ioutil.IOStreams) *Messenger

+ func (m *Messenger) Failure(line string, args ...any)

+ func (m *Messenger) FailureErr(line string, args ...any)

+ func (m *Messenger) FailureTag(tag string, line string, args ...any)

+ func (m *Messenger) FailureTagErr(tag string, line string, args ...any)

+ func (m *Messenger) Info(line string, args ...any)

+ func (m *Messenger) InfoErr(line string, args ...any)

+ func (m *Messenger) InfoTag(tag string, line string, args ...any)

+ func (m *Messenger) InfoTagErr(tag string, line string, args ...any)

+ func (m *Messenger) Success(line string, args ...any)

+ func (m *Messenger) SuccessErr(line string, args ...any)

+ func (m *Messenger) SuccessTag(tag string, line string, args ...any)

+ func (m *Messenger) SuccessTagErr(tag string, line string, args ...any)

+ func (m *Messenger) Warning(line string, args ...any)

+ func (m *Messenger) WarningErr(line string, args ...any)

+ func (m *Messenger) WarningTag(tag string, line string, args ...any)

+ func (m *Messenger) WarningTagErr(tag string, line string, args ...any)

+ type Prompter interface

+ Confirm func(msg string, value bool, help string) (bool, error)

+ Input func(msg string, value string, help string) (string, error)

+ MultiSelect func(msg string, options []string, values []string, help string) ([]string, error)

+ Select func(msg string, options []string, value string, help string) (string, error)

+ type SurveyPrompter struct

+ func NewSurveyPrompter(in fileReader, out fileWriter, err fileWriter, s session) *SurveyPrompter

+ func (p *SurveyPrompter) Confirm(prompt string, defaultValue bool, help string) (bool, error)

+ func (p *SurveyPrompter) Input(prompt string, defaultValue string, help string) (string, error)

+ func (p *SurveyPrompter) MultiSelect(prompt string, options []string, defaultValues []string, help string) ([]string, error)

+ func (p *SurveyPrompter) Select(prompt string, options []string, defaultValue string, help string) (string, error)