Another approach for zsh completion #1218
Closed
Conversation
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
z0rc
requested review from
saschagrunert and
coilysiren
and removed request for
a team
coilysiren
requested changes
Jan 27, 2021
|
@z0rc Can you pull in the default branch to fix the failing test please 🙏🏼 |
Completion file shouldn't be sourced. It should provide only completion code (source of _command) for command. It's task for package manager or user to put under $fpath.
|
@lynncyrin done. This is work in progress, still requires consensus about proposal and documentation updates if proposal accepted. Marked as draft and awaiting your input. |
There is no need to define custom shell var, when Zsh can be detected by checking SHELL env var.
|
Also refactored how zsh shell is detected. |
coilysiren
requested review from
a team
and removed request for
saschagrunert and
coilysiren
|
This issue or PR has been automatically marked as stale because it has not had recent activity. Please add a comment bumping this if you're still interested in it's resolution! Thanks for your help, please let us know if you need anything else. |
|
Closing this as it has become stale. |
meatballhat
added a commit
that referenced
this pull request
May 22, 2022
Another approach for zsh completion (#1218)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
What this PR does / why we need it:
I want to open discussion how this project provides completion for zsh. Current situation isn't right and promotes cargo-cult approach to enable zsh completions.
Completion file shouldn't be sourced. It should provide only completion code (source of
_commandfunction) forcommand. Ideally this file should be just template/example, where developer should replace$PROGwith name of binary and distribute it with_commandname somewhere under project's contrib folder (alongside with man pages, vim syntax etc). As go build system isn't able to properly install this kind of stuff, it's up to package manager (homebrew, dpkg etc) to pick up this_commandfile and put it under correct$fpathwhere zsh can autoload it.Currently this PR changes only zsh completion example. The documentation needs to be updated too. I can look into if there is agreement with current proposal.
Special notes for your reviewer:
There is fundamental problem with this project calling "completions" as "auto-completions", which are different terms. See https://www.gnu.org/software/bash/manual/html_node/Programmable-Completion.html and http://zsh.sourceforge.net/Doc/Release/Completion-System.html for correct terminology. You might want to fix this in future.