Fix CLI autocompletion on ZSH when installed with Homebrew #443
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
Prior to this, when installing Timoni using Homebrew on a Mac with ZSH, CLI autocompletion would not work. After this change, CLI autocompletion works after installation or reinstallation via Homebrew. The problem is that the completion function that Homebrew wrote to `/opt/homebrew/share/zsh/site-functions/` did not start with an underscore, `_`. By convention, completion function names (and the files containing them) should start with an underscore followed by the name of the command they provide completions for. When ZSH's completion system is initialized (usually through the compinit function), it automatically looks for files in the fpath directories that start with an underscore.
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.
Summary
Prior to this, when installing Timoni using Homebrew on a Mac with ZSH,
CLI autocompletion would not work.
After this change, CLI autocompletion works after installation or
reinstallation via Homebrew.
The problem is that the completion function that Homebrew wrote to
/opt/homebrew/share/zsh/site-functions/did not start with anunderscore,
_.By convention, completion function names (and the files containing them)
should start with an underscore followed by the name of the command they
provide completions for. When ZSH's completion system is initialized
(usually through the compinit function), it automatically looks for
files in the fpath directories that start with an underscore.
Before this change
Autocompletion on MacOS with ZSH did not work:
After this change
Autocompletion on MacOS with ZSH works. To test this, I just renamed
/opt/homebrew/share/zsh/site-functions/timonito/opt/homebrew/share/zsh/site-functions/_timonithen opened a new shell.