Skip to content

Made command help more consistent #2287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
markshep-wbg wants to merge 4 commits into
base: main
Choose a base branch
from
+7 −12
Open

Made command help more consistent #2287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4031d4c
Call the standard ShowCommandHelp() function for subcommands too
markshep-wbg Mar 19, 2026
27816c3
Fixed DefaultShowCommandHelp() when all subcommands are hidden
markshep-wbg Mar 19, 2026
159faa0
Fixed test cases
markshep-wbg Mar 19, 2026
e7c80ce
Merge branch 'main' into fix-command-help
dearchap Mar 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion examples_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,13 +182,16 @@ func ExampleCommand_Run_commandHelp() {
// greet describeit - use it to see a description
//
// USAGE:
// greet describeit [arguments...]
// greet describeit [options] [arguments...]
//
// DESCRIPTION:
// This is how we describe describeit the function
//
// OPTIONS:
// --help, -h show help
//
// GLOBAL OPTIONS:
// --name string a name to say (default: "pat")
}

func ExampleCommand_Run_noAction() {
Expand Down
12 changes: 2 additions & 10 deletions help.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,16 +126,8 @@ func helpCommandAction(ctx context.Context, cmd *Command) error {

// Case 3, 5
if len(cmd.VisibleCommands()) == 0 {

tmpl := cmd.CustomHelpTemplate
if tmpl == "" {
tmpl = CommandHelpTemplate
}

tracef("running HelpPrinter with command %[1]q", cmd.Name)
HelpPrinter(cmd.Root().Writer, tmpl, cmd)

return nil
return ShowCommandHelp(ctx, cmd.parent, cmd.Name)
}

tracef("running ShowSubcommandHelp")
Expand Down Expand Up @@ -303,7 +295,7 @@ func DefaultShowCommandHelp(ctx context.Context, cmd *Command, commandName strin

tmpl := subCmd.CustomHelpTemplate
if tmpl == "" {
if len(subCmd.Commands) == 0 {
if len(subCmd.VisibleCommands()) == 0 {
tracef("using CommandHelpTemplate")
tmpl = CommandHelpTemplate
} else {
Expand Down
2 changes: 1 addition & 1 deletion help_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -571,7 +571,7 @@ func TestShowCommandHelp_HelpPrinterCustom(t *testing.T) {
fmt.Fprint(w, "yo")
},
arguments: []string{"my-app", "help", "my-command"},
wantTemplate: SubcommandHelpTemplate,
wantTemplate: CommandHelpTemplate,
wantOutput: "yo",
},
{
Expand Down