Shell completion requires double TAB on first usage about cli HOT 5 OPEN

I did some digging and noticed commit e66017d

This bug does not occur with commits before e66017d

#compdef emu

local -a opts
local cur
cur=${words[-1]}
if [[ "$cur" == "-"* ]]; then
  opts=("${(@f)$(${words[@]:0:#words[@]-1} ${cur} --generate-bash-completion)}")
else
  opts=("${(@f)$(${words[@]:0:#words[@]-1} --generate-bash-completion)}")
fi

if [[ "${opts[1]}" != "" ]]; then
  _describe 'values' opts
else
  _files
fi

#compdef emu

_cli_zsh_autocomplete() {
  local -a opts
  local cur
  cur=${words[-1]}
  if [[ "$cur" == "-"* ]]; then
    opts=("${(@f)$(${words[@]:0:#words[@]-1} ${cur} --generate-bash-completion)}")
  else
    opts=("${(@f)$(${words[@]:0:#words[@]-1} --generate-bash-completion)}")
  fi

  if [[ "${opts[1]}" != "" ]]; then
    _describe 'values' opts
  else
    _files
  fi
}

compdef _cli_zsh_autocomplete emu

from cli.

@bartekpacia I'm not a zsh expert. Is there a way you can fix it ?

from cli.

Yes, I have fixed it (see this comment for a version of completion script that works fine).

My suggestion is to eliminate the $PROG variable from completion scripts. Instead, the docs should tell users to copy and modify their completion scripts.

For example, I have a program called emu. Therefore I have to change $PROG to emu, resulting in:

#compdef emu

local -a opts
local cur
cur=${words[-1]}
if [[ "$cur" == "-"* ]]; then
  opts=("${(@f)$(${words[@]:0:#words[@]-1} ${cur} --generate-bash-completion)}")
else
  opts=("${(@f)$(${words[@]:0:#words[@]-1} --generate-bash-completion)}")
fi

if [[ "${opts[1]}" != "" ]]; then
  _describe 'values' opts
else
  _files
fi

What do you think? I would be happy to update the docs accordingly.

Note that these completion scripts are for v2. For v3, --generate-bash-completion must be replaced with --generate-shell-completion.

from cli.

Yeah go ahead.

from cli.

The even better version of the script above. The advantage is that it can be sourceed, which makes testing easier (no need to copy to /opt/homebrew/share/zsh/site-functions):

. ./autocomplete/zsh_autocomplete

#compdef emu
compdef _emu emu

_emu() {
	local -a opts
	local cur
	cur=${words[-1]}
	if [[ "$cur" == "-"* ]]; then
		opts=("${(@f)$(${words[@]:0:#words[@]-1} ${cur} --generate-shell-completion)}")
	else
		opts=("${(@f)$(${words[@]:0:#words[@]-1} --generate-shell-completion)}")
	fi

	if [[ "${opts[1]}" != "" ]]; then
		_describe 'values' opts
	else
		_files
	fi
}

# don't run the completion function when being source-ed or eval-ed
if [ "$funcstack[1]" = "_emu" ]; then
	_emu
fi

from cli.