userio

Documentation

Index

• Variables
• func IsTerminalInteractive(in io.Reader, out io.Writer) bool
• func Required(s string) (string, error)
• func ValidateFilePath(path string, opt FileValidatorOptions) error
• type FilePicker
  • func (ifp *FilePicker) GetInput(streams IOStreams) (string, error)
• type FileValidatorOptions
• type IOStreams
  • func NewIOStreams(stdin io.Reader, stdout io.Writer, stderr io.Writer) IOStreams
  • func NewIOStreamsWithInteractive(stdin io.Reader, stdout io.Writer, stderr io.Writer, isInteractive bool) IOStreams
  • func NewTestIOStreams(in io.Reader, out io.Writer, isInteractive bool) IOStreams
  • func (s IOStreams) Error(messages string)
  • func (s *IOStreams) Execute(model tea.Model, opts ...tea.ProgramOption) (tea.Model, error)
  • func (s IOStreams) GetOutput() io.Writer
  • func (s IOStreams) Info(messages string)
  • func (s IOStreams) IsInteractive() bool
  • func (s IOStreams) MsgE(message string, style lipgloss.Style, stream *lipgloss.Renderer) error
  • func (s IOStreams) Print(messages string)
  • func (s IOStreams) Warn(messages string)
  • func (s *IOStreams) Wizard(title string, completedTitle string) wizard.Handler
• type InputPrompt
• type InputSourceSwitch
  • func (iss *InputSourceSwitch[V, T]) GetValue(streams IOStreams) (T, error)
  • func (iss *InputSourceSwitch[V, T]) Validate(streams IOStreams) error
• type MultiSelect
  • func (op *MultiSelect) GetInput(streams IOStreams) ([]string, error)
• type NonInteractiveStyles
  • func NewNonInteractiveStyles() NonInteractiveStyles
• type SingleSelect
  • func (op *SingleSelect) GetInput(streams IOStreams) (string, error)
• type TextInput
  • func (ti *TextInput[V]) GetInput(streams IOStreams) (V, error)
• type ValidateAndMap
  • func NewFileValidator(opt FileValidatorOptions) ValidateAndMap[string, string]
• type ValidateTextAndMapFn
• type Zeroable
  • func AsZeroable[V comparable](value V) Zeroable[V]
  • func AsZeroableSlice[V []T, T any](value V) Zeroable[V]

Variables

var (
	ErrInterrupted = errors.New("input was interrupted")
)

var (
	ErrValueIsNotSet = errors.New("value is not set")
)

Functions

func IsTerminalInteractive

func IsTerminalInteractive(in io.Reader, out io.Writer) bool

func Required

func Required(s string) (string, error)

func ValidateFilePath

func ValidateFilePath(path string, opt FileValidatorOptions) error

Types

type FilePicker

type FilePicker struct {
	Prompt         string
	WorkingDir     string
	InitialValue   string
	ValidateAndMap ValidateAndMap[string, string]
}

func (*FilePicker) GetInput

func (ifp *FilePicker) GetInput(streams IOStreams) (string, error)

type FileValidatorOptions

type FileValidatorOptions struct {
	ExistingOnly bool
	DirsOnly     bool
	DirIsEmpty   bool
	FilesOnly    bool
	Optional     bool
}

type IOStreams

type IOStreams struct {
	CurrentHandler wizard.Handler
	// contains filtered or unexported fields
}

func NewIOStreams

func NewIOStreams(stdin io.Reader, stdout io.Writer, stderr io.Writer) IOStreams

func NewIOStreamsWithInteractive

func NewIOStreamsWithInteractive(stdin io.Reader, stdout io.Writer, stderr io.Writer, isInteractive bool) IOStreams

func NewTestIOStreams

func NewTestIOStreams(in io.Reader, out io.Writer, isInteractive bool) IOStreams

func (IOStreams) Error

func (s IOStreams) Error(messages string)

func (*IOStreams) Execute

func (s *IOStreams) Execute(model tea.Model, opts ...tea.ProgramOption) (tea.Model, error)

func (IOStreams) GetOutput

func (s IOStreams) GetOutput() io.Writer

func (IOStreams) Info

func (s IOStreams) Info(messages string)

func (IOStreams) IsInteractive

func (s IOStreams) IsInteractive() bool

func (IOStreams) MsgE

func (s IOStreams) MsgE(message string, style lipgloss.Style, stream *lipgloss.Renderer) error

func (IOStreams) Print

func (s IOStreams) Print(messages string)

func (IOStreams) Warn

func (s IOStreams) Warn(messages string)

func (*IOStreams) Wizard

func (s *IOStreams) Wizard(title string, completedTitle string) wizard.Handler

type InputPrompt

type InputPrompt[V any] interface {
	GetInput(streams IOStreams) (V, error)
}

type InputSourceSwitch

type InputSourceSwitch[V, T any] struct {
	DefaultValue        Zeroable[V]
	Optional            bool
	InteractivePromptFn func() (InputPrompt[V], error)
	ValidateAndMap      ValidateAndMap[V, T]
	ErrMessage          string
	// contains filtered or unexported fields
}

func (*InputSourceSwitch[V, T]) GetValue

func (iss *InputSourceSwitch[V, T]) GetValue(streams IOStreams) (T, error)

func (*InputSourceSwitch[V, T]) Validate

func (iss *InputSourceSwitch[V, T]) Validate(streams IOStreams) error

type MultiSelect

type MultiSelect struct {
	Prompt         string
	Items          []string
	ValidateAndMap ValidateAndMap[[]string, []string]
}

func (*MultiSelect) GetInput

func (op *MultiSelect) GetInput(streams IOStreams) ([]string, error)

type NonInteractiveStyles

type NonInteractiveStyles struct {
	InfoStyle         lipgloss.Style
	ErrorHeadingStyle lipgloss.Style
	ErrorMessageStyle lipgloss.Style
	WarnHeadingStyle  lipgloss.Style
	WarnMessageStyle  lipgloss.Style
	Bold              lipgloss.Style
	Status            wizard.TaskStatusStyle
}

func NewNonInteractiveStyles

func NewNonInteractiveStyles() NonInteractiveStyles

type SingleSelect

type SingleSelect struct {
	Prompt          string
	Items           []string
	PreselectedItem string
}

func (*SingleSelect) GetInput

func (op *SingleSelect) GetInput(streams IOStreams) (string, error)

type TextInput

type TextInput[V interface{}] struct {
	Prompt         string
	InitialValue   string
	Placeholder    string
	ValidateAndMap ValidateTextAndMapFn[V]
}

func (*TextInput[V]) GetInput

func (ti *TextInput[V]) GetInput(streams IOStreams) (V, error)

type ValidateAndMap

type ValidateAndMap[V, T any] func(V) (T, error)

func NewFileValidator

func NewFileValidator(opt FileValidatorOptions) ValidateAndMap[string, string]

type ValidateTextAndMapFn

type ValidateTextAndMapFn[V interface{}] func(string) (V, error)

type Zeroable

type Zeroable[V any] interface {
	Value() V
	IsZeroValue() bool
}

Zeroable this interface is required to check if a value is not set we could use simply "comparable" as generic constraint, but slices are not comparable, which makes them impossible to use. This interface abstracts helps mitigate the issue

func AsZeroable

func AsZeroable[V comparable](value V) Zeroable[V]

func AsZeroableSlice

func AsZeroableSlice[V []T, T any](value V) Zeroable[V]