glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2024-06-17 09:19:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

zsh-completion: two fixes for identifying flag usage:

Browse source 
Fixed after input from @eparis:
- Decide on option parameter by checking NoOptDefVal
- Slices also could be specified multiple times.
This commit is contained in:
Haim Ashkenazi 2018-02-28 21:52:35 +02:00 committed by Steve Francia
parent e9ee8f0446
commit df12a0a249
2 changed files with 26 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
zsh_completions.go
View file

@ -131,7 +131,7 @@ func genFlagEntryForZshArguments(f *pflag.Flag) string {
func genFlagEntryForSingleOptionFlag(f *pflag.Flag) string {
var option, multiMark, extras string
if f.Value.Type() == "stringArray" {
if flagCouldBeSpecifiedMoreThenOnce(f) {
multiMark = "*"
}
@ -147,7 +147,7 @@ func genFlagEntryForSingleOptionFlag(f *pflag.Flag) string {
func genFlagEntryForMultiOptionFlag(f *pflag.Flag) string {
var options, parenMultiMark, curlyMultiMark, extras string
if f.Value.Type() == "stringArray" {
if flagCouldBeSpecifiedMoreThenOnce(f) {
parenMultiMark = "*"
curlyMultiMark = "\\*"
}
@ -165,9 +165,14 @@ func genZshFlagEntryExtras(f *pflag.Flag) string {
_, pathSpecified := f.Annotations[BashCompFilenameExt]
if pathSpecified {
extras = ":filename:_files"
} else if !strings.HasPrefix(f.Value.Type(), "bool") {
} else if f.NoOptDefVal == "" {
extras = ":" // allow option variable without assisting
}
return extras
}
func flagCouldBeSpecifiedMoreThenOnce(f *pflag.Flag) bool {
return strings.Contains(f.Value.Type(), "Slice") ||
strings.Contains(f.Value.Type(), "Array")
}

19
zsh_completions_test.go
View file

@ -15,6 +15,7 @@ func TestGenZshCompletion(t *testing.T) {
name string
root *Command
expectedExpressions []string
skip string
}{
{
name: "simple command",
@ -99,7 +100,7 @@ func TestGenZshCompletion(t *testing.T) {
name: "repeated variables both with and without value",
root: func() *Command {
r := genTestCommand("mycmd", true)
_ = r.Flags().StringArrayP("debug", "d", []string{}, "debug usage")
_ = r.Flags().BoolSliceP("debug", "d", []bool{}, "debug usage")
_ = r.Flags().StringArray("option", []string{}, "options")
return r
}(),
@ -108,6 +109,18 @@ func TestGenZshCompletion(t *testing.T) {
`"\(\*-d \*--debug\)"{\\\*-d,\\\*--debug}`,
},
},
{
name: "boolSlice should not accept arguments",
root: func() *Command {
r := genTestCommand("mycmd", true)
r.Flags().BoolSlice("verbose", []bool{}, "verbosity level")
return r
}(),
expectedExpressions: []string{
`"\*--verbose\[verbosity level]"`,
},
skip: "BoolSlice behaves strangely both with NoOptDefVal and type (identifies as bool)",
},
}
for _, tc := range tcs {
@ -119,6 +132,10 @@ func TestGenZshCompletion(t *testing.T) {
}
output := buf.Bytes()
if tc.skip != "" {
t.Skip("Skipping:", tc.skip)
}
for _, expr := range tc.expectedExpressions {
rgx, err := regexp.Compile(expr)
if err != nil {