diff --git a/zsh_completions.go b/zsh_completions.go index 12755482f..e2476b62f 100644 --- a/zsh_completions.go +++ b/zsh_completions.go @@ -25,6 +25,7 @@ var ( "extractFlags": zshCompExtractFlag, "genFlagEntryForZshArguments": zshCompGenFlagEntryForArguments, "extractArgsCompletions": zshCompExtractArgumentCompletionHintsForRendering, + "escapeText": zshCompQuoteFlagDescription, } zshCompletionText = ` {{/* should accept Command (that contains subcommands) as parameter */}} @@ -41,7 +42,7 @@ function {{$cmdPath}} { case $state in cmnds) commands=({{range .Commands}}{{if not .Hidden}} - "{{.Name}}:{{.Short}}"{{end}}{{end}} + "{{.Name}}:{{.Short | escapeText}}"{{end}}{{end}} ) _describe "command" commands ;; @@ -332,5 +333,9 @@ 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 e53fa886e..a9405fe10 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 { @@ -229,6 +240,25 @@ func TestGenZshCompletion(t *testing.T) { `--ptest\[ptest]:filename:_files -g "-\(/\)"`, }, }, + { + name: "escape text in subcommand description", + root: func() *Command { + r := &Command{ + Use: "rootcmd", + Long: "Long rootcmd description", + } + d := &Command{ + Use: "subcmd1", + Short: "$(echo foo)", + Run: emptyRun, + } + r.AddCommand(d) + return r + }(), + expectedExpressions: []string{ + `\$\(echo foo\)`, + }, + }, } for _, tc := range tcs {