feat(command): support zsh fpath completion #703
Merged
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
andrewthauer
force-pushed
the
zsh-fpath-completion
branch
from
3ab9d42
to
299c8aa
Compare
andrewthauer
changed the title
c4spar
approved these changes
May 15, 2024
c4spar
force-pushed
the
zsh-fpath-completion
branch
from
9752b97
to
27a561a
Compare
|
It seems like github thinks there is a conflict, although that is not the case. can you squash all the commits into one please? then I can merge it locally. |
fmt add braces disable shellcheck rule update snapshots
andrewthauer
force-pushed
the
zsh-fpath-completion
branch
from
27a561a
to
ac1fb05
Compare
|
Done! |
|
Awesome, thx! 👍 |
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.
closes #702.
These changes are based on patterns seen in other tools that generate zsh completions. If you run
deno completions zshyou should be able to compare.#compdef <cmd>is on the first line(( $+functions[<cmd>] ))check on the root command. Doing so will create errors about function nesting. If you look, the_denocompletions it omits this on the root_denofunction.funcstackand runs the_<cmd> $@or falls back to thecompgen command. This was copied from the deno completions. I believe this is to allow the completions to work when sourcing manually or used on thefpath. I've confirmed this works locally for both explicit sourcing and fpath usage.Steps to test:
1 .Run
deno compile -A --output examples/cliffy examples/commands/demo.ts2. Run
examples/cliffy completions zsh > /path/to/zsh/site-functions/_cliffy3. Make sure you have
fpath=(/path/to/zsh/site-functions $fpath)set andcompinitcalled in your zsh setup4. Reload shell
5.
examples/cliffy+<tab>will now auto complete. No sourcing necessary._NOTE: Depending on the zsh setup there might be an already defined
fpathwhich can be used. For exampleoh-my-zshuses~/.zfuncby default. Linux systems, etc. might be in/usr/local/share/zsh/site-functions, etc.Tests would be nice for this, but I didn't see any existing unit tests. I'm also not entirely sure howI would write an integration test with zsh proper either to cover this.