fix: respect Hidden flag for help command in usage output#2371
Open
ricardbejarano wants to merge 1 commit intospf13:mainfrom
Open
fix: respect Hidden flag for help command in usage output#2371ricardbejarano wants to merge 1 commit intospf13:mainfrom
ricardbejarano wants to merge 1 commit intospf13:mainfrom
Conversation
The help command was always shown in command listings, ignoring its Hidden field. This made it impossible to hide the help command from usage output using the standard Hidden property. Update all places where the help command is given special treatment (usage template, printOptionCmdUsages, AllChildCommandsHaveGroup, and shell completion) to check Hidden before including it in output. Fixes spf13#2269 Signed-off-by: Tommy <tommy@bejarano.io>
|
Tommy seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
ccoVeille
approved these changes
Mar 20, 2026
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.
Summary
Fixes #2269
The
helpcommand was hardcoded to always appear in usage listings, completely ignoring itsHiddenfield. This meant that settingcmd.Hidden = trueon the help command had no effect, making the property meaningless for it.What changed
Updated all locations where the help command receives special treatment to check
!subcmd.Hiddenbefore including it in output:defaultUsageTemplate: template conditions updated from(eq .Name "help")to(and (eq .Name "help") (not .Hidden))printOptionCmdUsages: three loop conditions updatedAllChildCommandsHaveGroup: condition updated to respectHiddenHiddenHow to hide the help command
Or via
SetHelpCommand:Testing
Added
TestHiddenHelpCommandIsHiddenwhich verifies the help command appears in usage by default and disappears whenHiddenis set to true.All existing tests pass.