Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Zsh completion V2 using Go completion
The current Zsh completion support is not well aligned with Bash completion and requires to have special code for Zsh, and different code for Bash. This commit introduces a V2 version which is based on Custom Go Completions and aims to standardize completion definition and behaviour across the different shells (Bash, Zsh, Fish). Signed-off-by: Marc Khouzam <marc.khouzam@montreal.ca>
- Loading branch information
1 parent
8c638d3
commit 37bd6e8
Showing
2 changed files
with
182 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| package cobra | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "fmt" | ||
| "io" | ||
| "os" | ||
| ) | ||
|
|
||
| func genZshCompV2(buf *bytes.Buffer, name string, includeDesc bool) { | ||
| compCmd := ShellCompRequestCmd | ||
| if !includeDesc { | ||
| compCmd = ShellCompNoDescRequestCmd | ||
| } | ||
| buf.WriteString(fmt.Sprintf(`#compdef __%[1]s %[1]s | ||
| # zsh completion for %-36[1]s -*- shell-script -*- | ||
| __%[1]s_debug() | ||
| { | ||
| local file="$BASH_COMP_DEBUG_FILE" | ||
| if [[ -n ${file} ]]; then | ||
| echo "$*" >> "${file}" | ||
| fi | ||
| } | ||
| _%[1]s() | ||
| { | ||
| local lastParam lastChar flagPrefix requestComp out directive compCount comp lastComp | ||
| local -a completions | ||
| __%[1]s_debug "\n========= starting completion logic ==========" | ||
| __%[1]s_debug "CURRENT: ${CURRENT}, words[*]: ${words[*]}" | ||
| lastParam=${words[-1]} | ||
| lastChar=${lastParam[-1]} | ||
| __%[1]s_debug "lastParam: ${lastParam}, lastChar: ${lastChar}" | ||
| # For zsh, when completing a flag with an = (e.g., %[1]s -n=<TAB>) | ||
| # completions must be prefixed with the flag | ||
| setopt local_options BASH_REMATCH | ||
| if [[ "${lastParam}" =~ '-.*=' ]]; then | ||
| # We are dealing with a flag with an = | ||
| flagPrefix=${BASH_REMATCH} | ||
| fi | ||
| # Prepare the command to obtain completions | ||
| requestComp="${words[1]} %[2]s ${words[2,-1]}" | ||
| if [ "${lastChar}" = "" ]; then | ||
| # If the last parameter is complete (there is a space following it) | ||
| # We add an extra empty parameter so we can indicate this to the go completion code. | ||
| __%[1]s_debug "Adding extra empty parameter" | ||
| requestComp="${requestComp} \"\"" | ||
| fi | ||
| __%[1]s_debug "About to call: eval ${requestComp}" | ||
| # Use eval to handle any environment variables and such | ||
| out=$(eval ${requestComp} 2>/dev/null) | ||
| __%[1]s_debug "completion output: ${out}" | ||
| # Extract the directive integer following a : from the last line | ||
| if [ "${out[-2]}" = : ]; then | ||
| directive=${out[-1]} | ||
| # Remove the directive (that means the last 3 chars as we include the : and the newline) | ||
| out=${out[1,-4]} | ||
| else | ||
| # There is no directive specified. Leave $out as is. | ||
| __%[1]s_debug "No directive found. Setting do default" | ||
| directive=0 | ||
| fi | ||
| __%[1]s_debug "directive: ${directive}" | ||
| __%[1]s_debug "completions: ${out}" | ||
| __%[1]s_debug "flagPrefix: ${flagPrefix}" | ||
| if [ $((directive & %[3]d)) -ne 0 ]; then | ||
| __%[1]s_debug "Completion received error. Ignoring completions." | ||
| return | ||
| fi | ||
| compCount=0 | ||
| while IFS='\n' read -r comp; do | ||
| if [ -n "$comp" ]; then | ||
| # If requested, completions are returned with a description. | ||
| # The description is preceded by a TAB character. | ||
| # For zsh's _describe, we need to use a : instead of a TAB. | ||
| # We first need to escape any : as part of the completion itself. | ||
| comp=${comp//:/\\:} | ||
| local tab=$(printf '\t') | ||
| comp=${comp//$tab/:} | ||
| ((compCount++)) | ||
| if [ -n "$flagPrefix" ]; then | ||
| __%[1]s_debug "Adding completion: ${flagPrefix}${comp}" | ||
| completions+="${flagPrefix}${comp}" | ||
| else | ||
| __%[1]s_debug "Adding completion: ${comp}" | ||
| completions+=${comp} | ||
| fi | ||
| lastComp=$comp | ||
| fi | ||
| done < <(printf "%%s\n" "${out[@]}") | ||
| if [ ${compCount} -eq 0 ]; then | ||
| if [ $((directive & %[5]d)) -ne 0 ]; then | ||
| __%[1]s_debug "deactivating file completion" | ||
| else | ||
| # Perform file completion | ||
| __%[1]s_debug "activating file completion" | ||
| _arguments '*:filename:_files' | ||
| fi | ||
| elif [ $((directive & %[4]d)) -ne 0 ] && [ ${compCount} -eq 1 ]; then | ||
| __%[1]s_debug "Activating nospace." | ||
| # We can use compadd here as there is no description when | ||
| # there is only one completion. | ||
| compadd -S '' "${lastComp}" | ||
| else | ||
| _describe "completions" completions | ||
| fi | ||
| } | ||
| compdef _%[1]s %[1]s | ||
| `, name, compCmd, ShellCompDirectiveError, ShellCompDirectiveNoSpace, ShellCompDirectiveNoFileComp)) | ||
| } | ||
|
|
||
| // GenZshCompletionV2 generates the zsh completion V2 file and writes to the passed writer. | ||
| func (c *Command) GenZshCompletionV2(w io.Writer, includeDesc bool) error { | ||
| buf := new(bytes.Buffer) | ||
| genZshCompV2(buf, c.Name(), includeDesc) | ||
| _, err := buf.WriteTo(w) | ||
| return err | ||
| } | ||
|
|
||
| // GenZshCompletionFileV2 generates the zsh completion V2 file. | ||
| func (c *Command) GenZshCompletionFileV2(filename string, includeDesc bool) error { | ||
| outFile, err := os.Create(filename) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer outFile.Close() | ||
|
|
||
| return c.GenZshCompletionV2(outFile, includeDesc) | ||
| } |