Support Zsh completion autoload #31
Conversation
With this, you can just dump the script in your Zsh fpath and it will be loaded as needed by the completion system Fixes pnpm/pnpm#8232
|
@segevfiner I replaced "Fixes" in your comment with "Related" because merging this PR alone is not sufficient. pnpm must be update with the latest version of tabtab in a separate commit. |
| #compdef {pkgname} | ||
| ###-begin-{pkgname}-completion-### |
There was a problem hiding this comment.
The ###-begin-{pkgname}-completion-### and ###-end-{pkgname}-completion-### are there to determine the range of generate code should it be inserted to .zshrc. I have some questions:
- Must
compdefstrictly be at the top? - Would it affect the
pnpm completion zsh >> ~/.zshrcuse-case? - Would it affect the
pnpm completion zsh > pnpm-completion.zsh+source pnpm-completion.zshuse-case?
There was a problem hiding this comment.
compdefmust be the first line in the file, for it to be recognized by the completion autoload system, see https://zsh.sourceforge.io/Doc/Release/Completion-System.html#Autoloaded-files for reference.- Depends on what the condition on
zsh_eval_contextevaluates to when zsh sources.zshrc, if it doesn't work, we can try a different condition, such as[[ $funcstack[1] = _{pkgname}_completion ]]that some other such completion files use. - That should still work.
| @@ -13,6 +14,14 @@ if type compdef &>/dev/null; then | |||
| _describe 'values' reply | |||
| fi | |||
| } | |||
| compdef _{pkgname}_completion {pkgname} | |||
There was a problem hiding this comment.
So I did a bit of research and found that #compdef {pkgname} replaces this. The use-cases I listed above would be affected.
Although, it seems that #compdef {pkgname} is strictly necessary for lazily loading completion file.
Therefore, I request that:
- If lazy loading is strictly incompatible with the use-cases I listed above, please create new entry for
zsh-lazywith new template file. The relevant files areconstants.jsandinstaller.js. - If there is a way to be compatible with all use-cases in a single file, please make the necessary modifications for them.
There was a problem hiding this comment.
That's what the if is for, for supporting both in the same file. When the file is sourceed it will call compdef (With the #compdef line being just a comment), while when called by the completion system it will run the completion function.
I haven't tested appending to .zshrc though, which might require adjusting the condition.
There was a problem hiding this comment.
I haven't tested appending to
.zshrcthough, which might require adjusting the condition.
Please do. And tell me the result.
There was a problem hiding this comment.
Seems to work fine in .zshrc as well. In .zshrc $zsh_eval_context is file, which will make the snippet call compdef as needed.
With this, you can just dump the script in your Zsh fpath and it will be loaded as needed by the completion system
Related pnpm/pnpm#8232
cc @KSXGitHub