| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384 |
- 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{})
- }
|