enhancement(cli): Shell autocompletion for vector cli #24414
+38
−3
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
This adds support for generating autocompletion for different shells for the vector cli. Superseds [vectordotdev#9823](vectordotdev#9823)
|
All contributors have signed the CLA ✍️ ✅ |
Author
|
I have read the CLA Document and I hereby sign the CLA |
Author
|
recheck |
Contributor
thomasqueirozb
left a comment
thomasqueirozb
left a comment
There was a problem hiding this comment.
Thanks for your contribution! This will be a nice addition
| GenerateSchema(generate_schema::Opts), | ||
|
|
||
| /// Generate shell completion, then exit. | ||
| #[command(hide = true)] |
Contributor
There was a problem hiding this comment.
Is there a particular reason to hide this?
Author
There was a problem hiding this comment.
Usually you dont make shell completions at runtime, but rather at comp/ install time. Thus, the user will not need this information. That is why completions are often generated via cargo xtasks.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 support for generating autocompletion for different shells for the vector cli.
Superseds #9823
Summary
We are a subcommand to generate autocompletion for the vector cli.
Vector configuration
How did you test this PR?
I have tested the completion for zsh extensivly as well as generated the completion for the other shells available.
Change Type
Is this a breaking change?
Does this PR include user facing changes?
Possibly this should be used in packaging of vector
no-changeloglabel to this PR.References
Related: #9823
Notes
@vectordotdev/vectorto reach out to us regarding this PR.pre-pushhook, please see this template.make fmtmake check-clippy(if there are failures it's possible some of them can be fixed withmake clippy-fix)make testgit merge origin masterandgit push.Cargo.lock), pleaserun
make build-licensesto regenerate the license inventory and commit the changes (if any). More details here.