feat: add --completions flag for shell completion generation #896
Conversation
This file contains hidden or 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
# Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
feat: add --completions flag for shell completion generation
Description
This PR adds a
--completions <SHELL>flag to theouchCLI. This allows users to generate shell completion scripts for supported shells (Bash, Elvish, Fish, PowerShell, Zsh) directly from the binary.This is useful for package maintainers and users who want to manually set up completions without relying on the build script artifacts.
Changes
clap_completeto runtime dependencies.completionsoption toCliArgsand madecmdsubcommand optional (to allow runningouch --completions ...without a subcommand).cmdis present if--completionsis not used.Option<Subcommand>.README.mdandCHANGELOG.md.Verification
ouch --completions bashto see the generated script.cargo test).