fix: Don't complete _command on zsh (#1690)

twpayne · VorpalBlade · web-flow · commit 37d481d4d40a · 2022-06-05T15:45:59.000-04:00
Previously the generated zsh completion script started with the line

    #compdef _&lt;command&gt; &lt;command&gt;

where &lt;command&gt; is the command that the zsh completion script is
generated for.

This enabled completions for both &lt;command&gt; and _&lt;command&gt;, but
_&lt;command&gt; is the completion function itself and should not be
completed. Furthermore, attempting to autocomplete _&lt;command&gt; (e.g.
typing "_&lt;command&gt;&lt;Space&gt;&lt;Tab&gt;" in a zsh shell) causes zsh to hang.

This commit fixes the #compdef line to only complete &lt;command&gt;, not
_&lt;command&gt;.

Co-authored-by: Arvid Norlander &lt;VorpalBlade@users.noreply.github.com&gt;
diff --git a/zsh_completions.go b/zsh_completions.go
@@ -75,7 +75,7 @@ func genZshComp(buf io.StringWriter, name string, includeDesc bool) {
 	if !includeDesc {
 		compCmd = ShellCompNoDescRequestCmd
 	}
-	WriteStringAndCheck(buf, fmt.Sprintf(`#compdef _%[1]s %[1]s
+	WriteStringAndCheck(buf, fmt.Sprintf(`#compdef %[1]s
 
 # zsh completion for %-36[1]s -*- shell-script -*-
 

Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ func genZshComp(buf io.StringWriter, name string, includeDesc bool) {`
`75`	`75`	`if !includeDesc {`
`76`	`76`	`compCmd = ShellCompNoDescRequestCmd`
`77`	`77`	`}`
`78`		- WriteStringAndCheck(buf, fmt.Sprintf(`#compdef _%[1]s %[1]s
	`78`	+ WriteStringAndCheck(buf, fmt.Sprintf(`#compdef %[1]s
`79`	`79`
`80`	`80`	`# zsh completion for %-36[1]s -- shell-script --`
`81`	`81`