fix: add HasHiddenParent() to skip hidden command subtrees in Walk()#2376
Open
dearchap wants to merge 1 commit into
Open
fix: add HasHiddenParent() to skip hidden command subtrees in Walk()#2376dearchap wants to merge 1 commit into
dearchap wants to merge 1 commit into
Conversation
Users can now check cmd.HasHiddenParent() in a Walk callback to skip subcommands of hidden commands, solving the issue where children of hidden commands were still visited. Closes urfave#2372
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:
When using
Walk()to traverse the command tree, users who want to skip hidden commands currently checkcmd.Hidden. However, the subcommands of a hidden command are not themselves hidden and still appear in the walk output. There is no way to check whether a command belongs to a hidden subtree without manually walking parent pointers, which are unexported.This PR adds
HasHiddenParent() booltoCommand, which returnstrueif any ancestor hasHidden: true. Users can combine it withcmd.Hiddenin theirWalkcallback to skip entire hidden subtrees:Which issue(s) this PR fixes:
Fixes #2372
Testing
go test ./...passesgo vet ./...passesmake v3diffshows only the newHasHiddenParentmethodmake v3approverun to update API surface docsRelease Notes