Automatic shell completion generation using xtask. #1080
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
Add automatic generation of shell completion scripts for various shells (the ones supported by `clap_complete`). The scripts can be generated using the `generate-shell-completion` xtask, which outputs the shell script to stdout.
General improvements to both the shell completion generation as well as the xtask package itself. Update the README to match the new additions.
|
Quickly remade this PR as I based it on the work I did for the man page generation since this also required the xtasks. I don't know Git well enough to know what demons merging that previous one would have unleashed, so I quickly redid it based on the main branch which now has the xtask stuff included. |
|
Merged, thanks! |
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.
This adds the option to automatically generate shell completion scripts for a variety of shells (currently bash, zsh, fish, elvish and powershell) using
cargo xtask generate-shell-completion. It uses the crateclap_completeto automatically create these completions based on theclap::Commandstruct. It could be handy for package maintainers to add these scripts to their package.