✨ feat(CLI): Add completion for the plugins flag#5596
Open
vitorfloriano wants to merge 1 commit intokubernetes-sigs:masterfrom
Open
✨ feat(CLI): Add completion for the plugins flag#5596vitorfloriano wants to merge 1 commit intokubernetes-sigs:masterfrom
vitorfloriano wants to merge 1 commit intokubernetes-sigs:masterfrom
Conversation
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: vitorfloriano The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
1943e1a to
c6c1805
Compare
The --plugins flag now shows completion for shows all the available plugins (external ones too!).
c6c1805 to
d9b9d71
Compare
| > [!TIP] | ||
| > To take advantage of tab completion, pass one plugin key at a time to multiple instances of the plugins flag: | ||
| > ``` | ||
| > kubebuilder init --plugins pluginA --plugins pluginB --plugins pluginC |
Member
There was a problem hiding this comment.
The completion should work as it works the plugins
So, it should work well with --plugins=pluginA,pluginB,pluginB
Could we ensure that?
Also, do we really need this note here?
If yes, could we add the default style note instead [!TIP]?
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 PR adds dynamic flag completion for the
--pluginsflag.The
--pluginsflag now shows completion for all the available plugins (external ones too, including out-of-tree! 🎉), while hiding deprecated ones.This will improve plugin discoverability and usage, especially for the autoupdate plugin.
Relates to #5446 and #5291
Note
Completion does not work for comma-chained values, so users will either use another instance of
--pluginsto get completion or type everything (or copy-paste) the keys after a comma:Works (multiple instances of the flag):
Does not work (trailing comma):
This is a known limitation in Cobra. There are workarounds but they look a bit of a kludge.