From 8d84e2e222963f3f306ab5b16c2ed13547d7e1d6 Mon Sep 17 00:00:00 2001 From: Chmouel Boudjnah Date: Thu, 4 Jul 2019 16:16:22 +0200 Subject: [PATCH] Make sure we quote brackets when generating zsh completion Signed-off-by: Chmouel Boudjnah --- zsh_completions.go | 4 +++- zsh_completions_test.go | 11 +++++++++++ 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/zsh_completions.go b/zsh_completions.go index 12755482..b58a5d68 100644 --- a/zsh_completions.go +++ b/zsh_completions.go @@ -332,5 +332,7 @@ func zshCompFlagCouldBeSpecifiedMoreThenOnce(f *pflag.Flag) bool { } func zshCompQuoteFlagDescription(s string) string { - return strings.Replace(s, "'", `'\''`, -1) + return strings.NewReplacer("'", `'\''`, + "[", `\[`, + "]", `\]`).Replace(s) } diff --git a/zsh_completions_test.go b/zsh_completions_test.go index e53fa886..8079f6cf 100644 --- 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 {