Implement shell completion#1650
Merged
onsi merged 1 commit intoonsi:masterfrom Apr 6, 2026
Merged
Conversation
This adds subcommand "completion" to the CLI which:
- generates completion script: ginkgo completion bash
- installs completion script: ginkgo completion --install bash
- generates commands completion: ginkgo completion --complete bash --
- generates flags completion: ginkgo completion --complete bash -- run --
- without suggests script fails back to default and completes file paths
For "bash" use hack similar to used in cobra, but implement it in go:
- single suggests are issued as is without description
- multiple suggests are issued in form "{suggest}{align}({description})"
I.e. description is a part of suggest but shell will use only common prefix.
For "zsh" issue completion response in form "{suggest}:{description}".
For "fish" issue completion response in form "{suggest}\t{description}".
Signed-off-by: Konstantin Khlebnikov <[email protected]>
Owner
|
cool, thanks! |
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
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 subcommand "completion" to the CLI which:
For "bash" use hack similar to used in cobra, but implement it in go:
For "zsh" issue completion response in form "{suggest}:{description}".
For "fish" issue completion response in form "{suggest}\t{description}".