fix: skip all hidden flags in shell completion, not just bool flags#2388
Open
vidigoat wants to merge 1 commit into
Open
fix: skip all hidden flags in shell completion, not just bool flags#2388vidigoat wants to merge 1 commit into
vidigoat wants to merge 1 commit into
Conversation
printFlagSuggestions only skipped hidden *BoolFlag values because it type-asserted to the concrete *BoolFlag type. Any other hidden flag (*StringFlag, *IntFlag, *DurationFlag, etc.) still leaked into shell completion output. Use the existing VisibleFlag interface (IsVisible) the same way visibleFlags and the flag-category code already do, so every hidden flag is skipped regardless of its concrete type.
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.
What type of PR is this?
What this PR does / why we need it:
printFlagSuggestions(used by the default shell-completion handler) is supposed to skip hidden flags, but it only skips hidden*BoolFlagvalues:The type assertion is to the concrete
*BoolFlagtype, so a hidden flag of any other type (*StringFlag,*IntFlag,*DurationFlag, ...) fails the assertion and is emitted into the completion output anyway. That exposes flags the author explicitly markedHidden: truewhenever a user hits<TAB>.Repro (hidden
*StringFlag):app sub -<TAB>prints--secretalongside--visible, even thoughsecretis hidden. A hidden*BoolFlagin the same list is correctly omitted.Changes:
help.go: replace the*BoolFlag-specific check with the existingVisibleFlaginterface (IsVisible), which every flag type implements viaFlagBase. This is the same mechanismvisibleFlagsand the flag-category code already use, so all hidden flags are now skipped regardless of concrete type.Which issue(s) this PR fixes:
NONE
Testing
Added
typical-flag-suggestion-hidden-non-booltoTestDefaultCompleteWithFlags, mirroring the existingtypical-flag-suggestion-hidden-boolcase but with a hidden*StringFlag. It fails onmain(completion emits the hidden flag) and passes with this change.go test ./...,go vet ./..., andgofmtare clean.Release Notes