mirror of
https://github.com/spf13/cobra.git
synced 2024-11-15 09:48:19 -07:00
2c5a0d300f
Replace the current Zsh completion with a Zsh completion solution based
on Go completions. This allows to support custom completions (based
on Go completions), but also to standardize the behavior of completion
across all shells.
Also, add support to Go completions for the bash completion annotations:
BashCompFilenameExt (including Command.MarkFlagFilename() family)
- still supported by zsh
BashCompSubdirsInDir - now supported by zsh
BashCompOneRequiredFlag (including Command.MarkFlagRequired() family)
- now supported by zsh and fish
Finally, remove the suggestin of the = form of flag completion.
The = form is supported, but it will not be suggested to avoid having
duplicated suggestions.
85 lines
3.7 KiB
Go
85 lines
3.7 KiB
Go
package cobra
|
|
|
|
import (
|
|
"github.com/spf13/pflag"
|
|
)
|
|
|
|
// MarkFlagRequired instructs the various shell completion implementations to
|
|
// prioritize the named flag when performing completion,
|
|
// and causes your command to report an error if invoked without the flag.
|
|
func (c *Command) MarkFlagRequired(name string) error {
|
|
return MarkFlagRequired(c.Flags(), name)
|
|
}
|
|
|
|
// MarkPersistentFlagRequired instructs the various shell completion implementations to
|
|
// prioritize the named persistent flag when performing completion,
|
|
// and causes your command to report an error if invoked without the flag.
|
|
func (c *Command) MarkPersistentFlagRequired(name string) error {
|
|
return MarkFlagRequired(c.PersistentFlags(), name)
|
|
}
|
|
|
|
// MarkFlagRequired instructs the various shell completion implementations to
|
|
// prioritize the named flag when performing completion,
|
|
// and causes your command to report an error if invoked without the flag.
|
|
func MarkFlagRequired(flags *pflag.FlagSet, name string) error {
|
|
return flags.SetAnnotation(name, BashCompOneRequiredFlag, []string{"true"})
|
|
}
|
|
|
|
// MarkFlagFilename instructs the various shell completion implementations to
|
|
// limit completions for the named flag to the specified file extensions.
|
|
func (c *Command) MarkFlagFilename(name string, extensions ...string) error {
|
|
return MarkFlagFilename(c.Flags(), name, extensions...)
|
|
}
|
|
|
|
// MarkFlagCustom adds the BashCompCustom annotation to the named flag, if it exists.
|
|
// The bash completion script will call the bash function f for the flag.
|
|
//
|
|
// This will only work for bash completion.
|
|
// It is recommended to instead use c.RegisterFlagCompletionFunc(...) which allows
|
|
// to register a Go function which will work across all shells.
|
|
func (c *Command) MarkFlagCustom(name string, f string) error {
|
|
return MarkFlagCustom(c.Flags(), name, f)
|
|
}
|
|
|
|
// MarkPersistentFlagFilename instructs the various shell completion
|
|
// implementations to limit completions for the named persistent flag to the
|
|
// specified file extensions.
|
|
func (c *Command) MarkPersistentFlagFilename(name string, extensions ...string) error {
|
|
return MarkFlagFilename(c.PersistentFlags(), name, extensions...)
|
|
}
|
|
|
|
// MarkFlagFilename instructs the various shell completion implementations to
|
|
// limit completions for the named flag to the specified file extensions.
|
|
func MarkFlagFilename(flags *pflag.FlagSet, name string, extensions ...string) error {
|
|
return flags.SetAnnotation(name, BashCompFilenameExt, extensions)
|
|
}
|
|
|
|
// MarkFlagCustom adds the BashCompCustom annotation to the named flag, if it exists.
|
|
// The bash completion script will call the bash function f for the flag.
|
|
//
|
|
// This will only work for bash completion.
|
|
// It is recommended to instead use c.RegisterFlagCompletionFunc(...) which allows
|
|
// to register a Go function which will work across all shells.
|
|
func MarkFlagCustom(flags *pflag.FlagSet, name string, f string) error {
|
|
return flags.SetAnnotation(name, BashCompCustom, []string{f})
|
|
}
|
|
|
|
// MarkFlagDirname instructs the various shell completion implementations to
|
|
// limit completions for the named flag to directory names.
|
|
func (c *Command) MarkFlagDirname(name string) error {
|
|
return MarkFlagDirname(c.Flags(), name)
|
|
}
|
|
|
|
// MarkPersistentFlagDirname instructs the various shell completion
|
|
// implementations to limit completions for the named persistent flag to
|
|
// directory names.
|
|
func (c *Command) MarkPersistentFlagDirname(name string) error {
|
|
return MarkFlagDirname(c.PersistentFlags(), name)
|
|
}
|
|
|
|
// MarkFlagDirname instructs the various shell completion implementations to
|
|
// limit completions for the named flag to directory names.
|
|
func MarkFlagDirname(flags *pflag.FlagSet, name string) error {
|
|
return flags.SetAnnotation(name, BashCompSubdirsInDir, []string{})
|
|
}
|