wrash

Documentation

Index

• func NewHistory(base string, w io.Writer, entries []*Entry) prompt.History
• type Arg
  • func (o *Arg) ExpectsValue() bool
  • func (o *Arg) Suggest(arg string) []prompt.Suggest
• type ArgKind
• type CommandSuggestion
  • func (s *CommandSuggestion) Suggest(args []string, completeLast bool) []prompt.Suggest
• type EmptySuggestor
  • func (s *EmptySuggestor) Suggest([]string, bool) []prompt.Suggest
• type Entry
• type FlagSuggestion
• type Option
  • func OptionDisablePrompt() Option
  • func OptionFrozen(freeze bool) Option
  • func OptionHistory(h prompt.History) Option
  • func OptionStderr(w io.Writer) Option
  • func OptionStdin(r io.Reader) Option
  • func OptionStdout(w io.Writer) Option
  • func OptionSuggestor(suggestion Suggestor) Option
• type Session
  • func NewSession(base string, opts ...Option) (*Session, error)
  • func (s *Session) Run()
• type Suggestor
  • func LoadSuggestions(p string) (Suggestor, error)

Functions

func NewHistory

func NewHistory(base string, w io.Writer, entries []*Entry) prompt.History

Types

type Arg

type Arg struct {
	Kind    ArgKind  `yaml:"kind"`
	Choices []string `yaml:"choices"`
	Cmd     []string `yaml:"cmd"`
}

func (*Arg) ExpectsValue

func (o *Arg) ExpectsValue() bool

func (*Arg) Suggest

func (o *Arg) Suggest(arg string) []prompt.Suggest

type ArgKind

type ArgKind string

const (
	KindDefault ArgKind = ""
	KindValue   ArgKind = "value"
	KindPath    ArgKind = "path"
	KindNone    ArgKind = "none"
)

type CommandSuggestion

type CommandSuggestion struct {
	Description string                       `yaml:"description"`
	SubCommands map[string]CommandSuggestion `yaml:"subcommands"`

	// Flags is only used to determine if a flag expects a value, or when the arg to be completed starts with a dash.
	Flags map[string]FlagSuggestion `yaml:"flags"`
	Args  Arg                       `yaml:"args"`
}

func (*CommandSuggestion) Suggest

func (s *CommandSuggestion) Suggest(args []string, completeLast bool) []prompt.Suggest

type EmptySuggestor

type EmptySuggestor struct{}

func (*EmptySuggestor) Suggest

func (s *EmptySuggestor) Suggest([]string, bool) []prompt.Suggest

type Entry

type Entry struct {
	Base string
	Cmd  string
	// contains filtered or unexported fields
}

type FlagSuggestion

type FlagSuggestion struct {
	Description string `yaml:"description"`
	Args        Arg    `yaml:"args"`
}

type Option

type Option func(*Session) error

func OptionDisablePrompt

func OptionDisablePrompt() Option

func OptionFrozen

func OptionFrozen(freeze bool) Option

func OptionHistory

func OptionHistory(h prompt.History) Option

func OptionStderr

func OptionStderr(w io.Writer) Option

func OptionStdin

func OptionStdin(r io.Reader) Option

func OptionStdout

func OptionStdout(w io.Writer) Option

func OptionSuggestor

func OptionSuggestor(suggestion Suggestor) Option

type Session

type Session struct {
	Base string
	// contains filtered or unexported fields
}

func NewSession

func NewSession(base string, opts ...Option) (*Session, error)

func (*Session) Run

func (s *Session) Run()

type Suggestor

type Suggestor interface {
	Suggest(args []string, completeLast bool) []prompt.Suggest
}

func LoadSuggestions

func LoadSuggestions(p string) (Suggestor, error)