Skip to content

Fix:(issue_2135) Correct formatting of default subcommand USAGE text #2139

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

Merged
dearchap merged 2 commits into from
May 20, 2025
Merged

Fix:(issue_2135) Correct formatting of default subcommand USAGE text #2139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8865e20
Fix:(issue_2135) Correct formatting of default subcommand USAGE text
zzspoon May 19, 2025
d3ee303
update tests for issue_2135 pr_2139
zzspoon May 19, 2025
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
2 changes: 1 addition & 1 deletion command_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2174,7 +2174,7 @@ func TestCommand_Run_SubcommandFullPath(t *testing.T) {

outString := out.String()
require.Contains(t, outString, "foo bar - does bar things")
require.Contains(t, outString, "foo bar [command [command options]] [arguments...]")
require.Contains(t, outString, "foo bar [options] [arguments...]")
}

func TestCommand_Run_Help(t *testing.T) {
Expand Down
2 changes: 1 addition & 1 deletion examples_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ func ExampleCommand_Run_subcommandNoAction() {
// greet describeit - use it to see a description
//
// USAGE:
// greet describeit [command [command options]] [arguments...]
// greet describeit [options] [arguments...]
//
// DESCRIPTION:
// This is how we describe describeit the function
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 @@ -713,7 +713,7 @@ func TestShowSubcommandHelp_GlobalOptions(t *testing.T) {
foo frobbly

USAGE:
foo frobbly [command [command options]]
foo frobbly [options]

OPTIONS:
--bar string
Expand Down
2 changes: 1 addition & 1 deletion template.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package cli
var (
helpNameTemplate = `{{$v := offset .FullName 6}}{{wrap .FullName 3}}{{if .Usage}} - {{wrap .Usage $v}}{{end}}`
argsTemplate = `{{if .Arguments}}{{range .Arguments}}{{.Usage}}{{end}}{{end}}`
usageTemplate = `{{if .UsageText}}{{wrap .UsageText 3}}{{else}}{{.FullName}}{{if .VisibleFlags}} [command [command options]]{{end}}{{if .ArgsUsage}} {{.ArgsUsage}}{{else}}{{if .Arguments}} {{template "argsTemplate" .}}{{end}}{{end}}{{end}}`
usageTemplate = `{{if .UsageText}}{{wrap .UsageText 3}}{{else}}{{.FullName}}{{if .VisibleFlags}} [options]{{end}}{{if .VisibleCommands}} [command [command options]]{{end}}{{if .ArgsUsage}} {{.ArgsUsage}}{{else}}{{if .Arguments}} {{template "argsTemplate" .}}{{end}}{{end}}{{end}}`
descriptionTemplate = `{{wrap .Description 3}}`
authorsTemplate = `{{with $length := len .Authors}}{{if ne 1 $length}}S{{end}}{{end}}:
{{range $index, $author := .Authors}}{{if $index}}
Expand Down