Make sure we quote brackets when generating zsh completion

Signed-off-by: Chmouel Boudjnah <[email protected]>
spf13 · Jul 17, 2019 · 4720dca · 4720dca
1 parent 2d7544e
commit 4720dca
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 1 deletion.
diff --git a/zsh_completions.go b/zsh_completions.go
@@ -332,5 +332,6 @@ func zshCompFlagCouldBeSpecifiedMoreThenOnce(f *pflag.Flag) bool {
 }
 
 func zshCompQuoteFlagDescription(s string) string {
-	return strings.Replace(s, "'", `'\''`, -1)
+	replacer := strings.NewReplacer("'", `'\''`, "[", `\[`, "]", `\]`)
+	return replacer.Replace(s)
 }
diff --git a/zsh_completions_test.go b/zsh_completions_test.go
@@ -157,6 +157,17 @@ func TestGenZshCompletion(t *testing.T) {
 				`--private\[Don'\\''t show public info]`,
 			},
 		},
+		{
+			name: "flag description with brackets ([]) shouldn't break the completion file",
+			root: func() *Command {
+				r := genTestCommand("root", true)
+				r.Flags().Bool("level", false, "[ALERT]")
+				return r
+			}(),
+			expectedExpressions: []string{
+				`--level[\[ALERT\]]`,
+			},
+		},
 		{
 			name: "argument completion for file with and without patterns",
 			root: func() *Command {