fix(zsh): completion no longer requires double tab when using autoloaded

segevfiner · web-flow · commit 0dd8fe42ce98 · 2025-04-23T16:18:11.000-04:00
diff --git a/README.md b/README.md
@@ -38,7 +38,7 @@ Rules & Behavior
                              return a Promise                          [boolean]
 ```
 
-* bash-completion shortcuts for commands and options.
+* generate completion scripts for Bash and Zsh for your command
 * and [tons more](/docs/api.md).
 
 ## Installation
diff --git a/docs/api.md b/docs/api.md
@@ -354,8 +354,25 @@ discussion of the advanced features exposed in the Command API.
 Enable bash/zsh-completion shortcuts for commands and options.
 
 `cmd`: When present in `argv._`, will result in the `.bashrc` or `.zshrc` completion script
-being outputted. To enable bash/zsh completions, concat the generated script to your
-`.bashrc` or `.bash_profile` (or `.zshrc` for zsh).
+being outputted.
+
+To enable bash/zsh completions, you can either: 
+1. Concat the generated script to your
+   `.bashrc` or `.bash_profile` (or `.zshrc` for zsh).
+
+   e.g. `./command completion > ~/.bashrc`
+
+2. If you have `bash-completion` installed, write it to a file in
+   `$XDG_DATA_HOME/bash-completion` (or  `~/.local/share/bash-completion`),
+   with the same name as the command.
+
+   e.g. `./command completion > ${XDG_DATA_HOME:-$HOME/.local/share}/bash-completion/command`
+
+3. For Zsh, write it to a file in your `$fpath` named
+   `_{{app_name}}_yargs_completions` where `{{app_name}}` is your
+   command name.
+
+   e.g. `./command completion > /usr/local/share/zsh/site-functions/_command_yargs_completions`
 
 `description`: Provide a description in your usage instructions for the command
 that generates the completion scripts.
diff --git a/lib/completion-templates.ts b/lib/completion-templates.ts
@@ -49,6 +49,10 @@ _{{app_name}}_yargs_completions()
     _default
   fi
 }
-compdef _{{app_name}}_yargs_completions {{app_name}}
+if [[ "'\${zsh_eval_context[-1]}" == "loadautofunc" ]]; then
+  _{{app_name}}_yargs_completions "$@"
+else
+  compdef _{{app_name}}_yargs_completions {{app_name}}
+fi
 ###-end-{{app_name}}-completions-###
 `;
