fix(help): show GLOBAL OPTIONS for leaf subcommands when HideHelpCommand is true by TimSoethout · Pull Request #2269 · urfave/cli

TimSoethout · 2026-02-26T13:41:44Z

What type of PR is this?

(REQUIRED)

bug

What this PR does / why we need it:

(REQUIRED)

This PR fixes a help-rendering edge case where enabling HideHelpCommand: true on a parent command caused leaf subcommand help to omit GLOBAL OPTIONS.

[help.go](https://automatic-succotash-xgp6xrq4r3p4qr.github.dev/)
    Updates [helpCommandAction](https://automatic-succotash-xgp6xrq4r3p4qr.github.dev/) leaf-command detection to use visible commands ([len(cmd.VisibleCommands()) == 0](https://automatic-succotash-xgp6xrq4r3p4qr.github.dev/)) instead of raw command count logic affected by the internal help command injection.
    Ensures leaf subcommands consistently render with [CommandHelpTemplate](https://automatic-succotash-xgp6xrq4r3p4qr.github.dev/), which includes GLOBAL OPTIONS.
[help_test.go](https://automatic-succotash-xgp6xrq4r3p4qr.github.dev/)
    Adds [TestShowSubcommandHelp_GlobalOptions_HideHelpCommand](https://automatic-succotash-xgp6xrq4r3p4qr.github.dev/), modeled after [TestShowSubcommandHelp_GlobalOptions](https://automatic-succotash-xgp6xrq4r3p4qr.github.dev/).
    Verifies subcommand help still shows inherited persistent/root flags when [HideHelpCommand](https://automatic-succotash-xgp6xrq4r3p4qr.github.dev/) is enabled.

Decision rationale:

This keeps existing template responsibilities intact and fixes the root cause (incorrect leaf-command detection), rather than duplicating template sections or altering unrelated help output paths.

Which issue(s) this PR fixes:

(REQUIRED)

Fixes #2268
Special notes for your reviewer:

(fill-in or delete this section)

Review focus: the [helpCommandAction](https://automatic-succotash-xgp6xrq4r3p4qr.github.dev/) branch that chooses command vs subcommand help template for case 3/5 flows.
The change is intentionally minimal and scoped to template selection logic plus regression coverage.

Testing

(fill-in or delete this section)

Added regression test:
    [TestShowSubcommandHelp_GlobalOptions_HideHelpCommand](https://automatic-succotash-xgp6xrq4r3p4qr.github.dev/)
Targeted verification:
    go test ./... -run 'TestShowSubcommandHelp_GlobalOptions(_HideHelpCommand)?$'
Full suite verification:
    go test [workspaces](http://_vscodecontentref_/11).

Release Notes

(REQUIRED)

Fix subcommand help output when HideHelpCommand is enabled so GLOBAL OPTIONS remain visible for leaf subcommands.

…elp command

…elp-command fix(help): show GLOBAL OPTIONS for leaf subcommands when HideHelpCommand is true

Copilot

Pull request overview

Fixes a help-rendering edge case in helpCommandAction where leaf subcommand help could omit GLOBAL OPTIONS when a parent command sets HideHelpCommand: true, by basing “leaf command” detection on visible subcommands rather than raw cmd.Commands length (which can be affected by internal help command injection).

Changes:

Update leaf-command detection in helpCommandAction to use len(cmd.VisibleCommands()) == 0.
Add a regression test to ensure leaf subcommand help still includes GLOBAL OPTIONS when HideHelpCommand is enabled.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
help.go	Fixes leaf detection for template selection by using visible subcommands, avoiding reliance on injected/hidden help commands.
help_test.go	Adds regression coverage for the `HideHelpCommand` case to ensure `GLOBAL OPTIONS` are rendered for leaf subcommands.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

…e fix Co-authored-by: TimSoethout <[email protected]>

[WIP] Apply changes based on feedback

Co-authored-by: TimSoethout <[email protected]>

* Initial plan * Restore docs/go.mod and docs/go.sum to original content Co-authored-by: TimSoethout <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: TimSoethout <[email protected]>

This PR contains the following updates: | Package | Type | Update | Change | OpenSSF | |---|---|---|---|---| | [github.com/urfave/cli/v3](https://github.com/urfave/cli) | require | minor | `v3.6.2` → `v3.7.0` | [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/urfave/cli/badge)](https://securityscorecards.dev/viewer/?uri=github.com/urfave/cli) | --- > ⚠️ **Warning** > > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>urfave/cli (github.com/urfave/cli/v3)</summary> ### [`v3.7.0`](https://github.com/urfave/cli/releases/tag/v3.7.0) [Compare Source](urfave/cli@v3.6.2...v3.7.0) #### What's Changed - Fix: use the correct type name in the tracef message by [@icholy](https://github.com/icholy) in [#2251](urfave/cli#2251) - chore(deps): bump mkdocs-git-revision-date-localized-plugin from 1.5.0 to 1.5.1 in the python-packages group by [@dependabot](https://github.com/dependabot)\[bot] in [#2252](urfave/cli#2252) - Fix:(issue\_2254) Fix incorrect handling of arg after short option token by [@dearchap](https://github.com/dearchap) in [#2255](urfave/cli#2255) - feat: ShellComplete for fish by [@marcusramberg](https://github.com/marcusramberg) in [#2256](urfave/cli#2256) - Fix: propagate MutuallyExclusiveFlags persistent flags to subcommands by [@siutsin](https://github.com/siutsin) in [#2266](urfave/cli#2266) - feat: support dynamic fish completion by [@Maks1mS](https://github.com/Maks1mS) in [#2270](urfave/cli#2270) - fix(help): show GLOBAL OPTIONS for leaf subcommands when HideHelpCommand is true by [@TimSoethout](https://github.com/TimSoethout) in [#2269](urfave/cli#2269) #### New Contributors - [@marcusramberg](https://github.com/marcusramberg) made their first contribution in [#2256](urfave/cli#2256) - [@siutsin](https://github.com/siutsin) made their first contribution in [#2266](urfave/cli#2266) - [@TimSoethout](https://github.com/TimSoethout) made their first contribution in [#2269](urfave/cli#2269) **Full Changelog**: <urfave/cli@v3.6.2...v3.7.0> </details> --- ### Configuration 📅 **Schedule**: Branch creation - At 12:00 AM through 04:59 AM and 10:00 PM through 11:59 PM, Monday through Friday ( * 0-4,22-23 * * 1-5 ), Only on Sunday and Saturday ( * * * * 0,6 ) (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://altlinux.space/stapler/stplr/pulls/340 Co-authored-by: Renovate Bot <[email protected]> Co-committed-by: Renovate Bot <[email protected]>

TimSoethout added 2 commits February 26, 2026 13:31

fix: simplify help command visibility logic and add test for hidden h…

5effa62

…elp command

Merge pull request #1 from TimSoethout/fix-2268-global-options-hide-h…

ffd243e

…elp-command fix(help): show GLOBAL OPTIONS for leaf subcommands when HideHelpCommand is true

Copilot AI review requested due to automatic review settings February 26, 2026 13:41

TimSoethout requested a review from a team as a code owner February 26, 2026 13:41

Copilot started reviewing on behalf of TimSoethout February 26, 2026 13:42

View session

TimSoethout mentioned this pull request Feb 26, 2026

HideHelpCommand: true on a parent command causes missing GLOBAL OPTIONS in subcommand #2268

Closed

3 tasks done

Copilot AI reviewed Feb 26, 2026

View reviewed changes

Copilot AI and others added 5 commits February 26, 2026 19:31

Initial plan

87c2623

fix(test): set HideHelpCommand on leaf subcommand to properly validat…

d6047e0

…e fix Co-authored-by: TimSoethout <[email protected]>

Merge pull request #2 from TimSoethout/copilot/apply-feedback-changes

7289ef9

[WIP] Apply changes based on feedback

Remove docs/go.mod and docs/go.sum (not relevant to PR)

d895eca

Co-authored-by: TimSoethout <[email protected]>

Restore docs/go.mod and docs/go.sum (#5)

f5d0884

* Initial plan * Restore docs/go.mod and docs/go.sum to original content Co-authored-by: TimSoethout <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: TimSoethout <[email protected]>

dearchap approved these changes Mar 1, 2026

View reviewed changes

dearchap merged commit 65ded98 into urfave:main Mar 1, 2026
9 checks passed

Navigation Menu

Repository navigation

fix(help): show GLOBAL OPTIONS for leaf subcommands when HideHelpCommand is true - #2269

fix(help): show GLOBAL OPTIONS for leaf subcommands when HideHelpCommand is true#2269
dearchap merged 7 commits into
urfave:mainfrom
TimSoethout:main

TimSoethout commented Feb 26, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

TimSoethout commented Feb 26, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants