glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2024-11-24 14:47:12 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #118 from liggitt/file_autocomplete_helper

Browse source 
Simplify setting file/extension annotations on a flag
This commit is contained in:
Eric Paris 2015-06-22 14:56:13 -05:00
commit a8f7f3dc25
2 changed files with 38 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
bash_completions.go
View file

@ -219,9 +219,13 @@ func writeFlagHandler(name string, annotations map[string][]string, out *bytes.B
case BashCompFilenameExt: case BashCompFilenameExt:
fmt.Fprintf(out, " flags_with_completion+=(%q)\n", name) fmt.Fprintf(out, " flags_with_completion+=(%q)\n", name)
ext := strings.Join(value, "|") if len(value) > 0 {
ext = "__handle_filename_extension_flag " + ext ext := "__handle_filename_extension_flag " + strings.Join(value, "|")
fmt.Fprintf(out, " flags_completion+=(%q)\n", ext) fmt.Fprintf(out, " flags_completion+=(%q)\n", ext)
} else {
ext := "_filedir"
fmt.Fprintf(out, " flags_completion+=(%q)\n", ext)
}
} }
} }
} }
@ -343,15 +347,24 @@ func (cmd *Command) GenBashCompletionFile(filename string) error {
return nil return nil
} }
func (cmd *Command) MarkFlagRequired(name string) { // MarkFlagRequired adds the BashCompOneRequiredFlag annotation to the named flag, if it exists.
flag := cmd.Flags().Lookup(name) func (cmd *Command) MarkFlagRequired(name string) error {
if flag == nil { return MarkFlagRequired(cmd.Flags(), name)
return }
}
if flag.Annotations == nil { // MarkFlagRequired adds the BashCompOneRequiredFlag annotation to the named flag in the flag set, if it exists.
flag.Annotations = make(map[string][]string) func MarkFlagRequired(flags *pflag.FlagSet, name string) error {
} return flags.SetAnnotation(name, BashCompOneRequiredFlag, []string{"true"})
annotation := make([]string, 1) }
annotation[0] = "true"
flag.Annotations[BashCompOneRequiredFlag] = annotation // MarkFlagFilename adds the BashCompFilenameExt annotation to the named flag, if it exists.
// Generated bash autocompletion will select filenames for the flag, limiting to named extensions if provided.
func (cmd *Command) MarkFlagFilename(name string, extensions ...string) error {
return MarkFlagFilename(cmd.Flags(), name, extensions...)
}
// MarkFlagFilename adds the BashCompFilenameExt annotation to the named flag in the flag set, if it exists.
// Generated bash autocompletion will select filenames for the flag, limiting to named extensions if provided.
func MarkFlagFilename(flags *pflag.FlagSet, name string, extensions ...string) error {
return flags.SetAnnotation(name, BashCompFilenameExt, extensions)
} }

24
bash_completions_test.go
View file

@ -42,23 +42,19 @@ func TestBashCompletions(t *testing.T) {
// required flag // required flag
c.MarkFlagRequired("introot") c.MarkFlagRequired("introot")
// valid nounds // valid nouns
validArgs := []string{"pods", "nodes", "services", "replicationControllers"} validArgs := []string{"pods", "nodes", "services", "replicationControllers"}
c.ValidArgs = validArgs c.ValidArgs = validArgs
// filename extentions // filename
annotations := make([]string, 3)
annotations[0] = "json"
annotations[1] = "yaml"
annotations[2] = "yml"
annotation := make(map[string][]string)
annotation[BashCompFilenameExt] = annotations
var flagval string var flagval string
c.Flags().StringVar(&flagval, "filename", "", "Enter a filename") c.Flags().StringVar(&flagval, "filename", "", "Enter a filename")
flag := c.Flags().Lookup("filename") c.MarkFlagFilename("filename", "json", "yaml", "yml")
flag.Annotations = annotation
// filename extensions
var flagvalExt string
c.Flags().StringVar(&flagvalExt, "filename-ext", "", "Enter a filename (extension limited)")
c.MarkFlagFilename("filename-ext")
out := new(bytes.Buffer) out := new(bytes.Buffer)
c.GenBashCompletion(out) c.GenBashCompletion(out)
@ -75,7 +71,9 @@ func TestBashCompletions(t *testing.T) {
check(t, str, `COMPREPLY=( "hello" )`) check(t, str, `COMPREPLY=( "hello" )`)
// check for required nouns // check for required nouns
check(t, str, `must_have_one_noun+=("pods")`) check(t, str, `must_have_one_noun+=("pods")`)
// check for filename extention flags // check for filename extension flags
check(t, str, `flags_completion+=("_filedir")`)
// check for filename extension flags
check(t, str, `flags_completion+=("__handle_filename_extension_flag json|yaml|yml")`) check(t, str, `flags_completion+=("__handle_filename_extension_flag json|yaml|yml")`)
checkOmit(t, str, cmdDeprecated.Name()) checkOmit(t, str, cmdDeprecated.Name())