completion

Documentation

Index

• func AddFixedSuggestionsToFlag(cmd *cobra.Command, flagName string, va ValidArgs) error
• func AddSuggestionsToFlag(cmd *cobra.Command, flagName string, suggestFn suggestFn) error
• func CombineSuggestionsToArgs(fns ...suggestFn) ...
• func GenZshCompletion(cmd *cobra.Command, w io.Writer) error
• type ValidArgs
  • func EmptySuggestionFuncion(_ *cobra.Command, _ []string, _ string) (ValidArgs, error)
  • func EmptyValidArgs() ValidArgs
• type ValigsArgsMap
  • func (va ValigsArgsMap) IntoUse() string
  • func (va ValigsArgsMap) IntoValidArgs() []string
  • func (va ValigsArgsMap) OnlyArgs() []string
  • func (va ValigsArgsMap) Set(k, v string) ValigsArgsMap
• type ValigsArgsSlide
  • func (va ValigsArgsSlide) IntoUse() string
  • func (va ValigsArgsSlide) IntoValidArgs() []string
  • func (va ValigsArgsSlide) OnlyArgs() []string

Functions

func AddFixedSuggestionsToFlag

func AddFixedSuggestionsToFlag(cmd *cobra.Command, flagName string, va ValidArgs) error

AddFixedSuggestionsToFlag add fixed suggestions to a flag

func AddSuggestionsToFlag

func AddSuggestionsToFlag(cmd *cobra.Command, flagName string, suggestFn suggestFn) error

AddSuggestionsToFlag add fixed suggestions to a flag

func CombineSuggestionsToArgs

func CombineSuggestionsToArgs(fns ...suggestFn) func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

CombineSuggestionsToArgs combine one or more suggestion resolver functions and call then accordingly with arg count

func GenZshCompletion

func GenZshCompletion(cmd *cobra.Command, w io.Writer) error

Types

type ValidArgs

type ValidArgs interface {
	IntoUse() string
	OnlyArgs() []string
	IntoValidArgs() []string
}

func EmptySuggestionFuncion

func EmptySuggestionFuncion(_ *cobra.Command, _ []string, _ string) (ValidArgs, error)

func EmptyValidArgs

func EmptyValidArgs() ValidArgs

EmptyValidArgs returns a ValidArgs with no options

type ValigsArgsMap

type ValigsArgsMap map[string]string

func (ValigsArgsMap) IntoUse

func (va ValigsArgsMap) IntoUse() string

func (ValigsArgsMap) IntoValidArgs

func (va ValigsArgsMap) IntoValidArgs() []string

func (ValigsArgsMap) OnlyArgs

func (va ValigsArgsMap) OnlyArgs() []string

func (ValigsArgsMap) Set

func (va ValigsArgsMap) Set(k, v string) ValigsArgsMap

type ValigsArgsSlide

type ValigsArgsSlide []string

func (ValigsArgsSlide) IntoUse

func (va ValigsArgsSlide) IntoUse() string

func (ValigsArgsSlide) IntoValidArgs

func (va ValigsArgsSlide) IntoValidArgs() []string

func (ValigsArgsSlide) OnlyArgs

func (va ValigsArgsSlide) OnlyArgs() []string