Merge pull request #1986 from urfave/v2-use-usage-template-in-subcommand-help

dearchap · web-flow · commit 50bdebfd1f0f · 2024-10-14T07:42:44.000-04:00
Use usage template in subcommand help
diff --git a/app_test.go b/app_test.go
@@ -2047,7 +2047,7 @@ func TestApp_Run_CommandSubcommandHelpName(t *testing.T) {
 		t.Errorf("expected %q in output: %q", expected, output)
 	}
 
-	expected = "base foo command [command options] [arguments...]"
+	expected = "base foo [command options] [arguments...]"
 	if !strings.Contains(output, expected) {
 		t.Errorf("expected %q in output: %q", expected, output)
 	}
diff --git a/godoc-current.txt b/godoc-current.txt
@@ -136,7 +136,10 @@ var SubcommandHelpTemplate = `NAME:
    {{template "helpNameTemplate" .}}
 
 USAGE:
-   {{if .UsageText}}{{wrap .UsageText 3}}{{else}}{{.HelpName}} {{if .VisibleFlags}}command [command options]{{end}}{{if .ArgsUsage}} {{.ArgsUsage}}{{else}}{{if .Args}} [arguments...]{{end}}{{end}}{{end}}{{if .Description}}
+   {{template "usageTemplate" .}}{{if .Category}}
+
+CATEGORY:
+   {{.Category}}{{end}}{{if .Description}}
 
 DESCRIPTION:
    {{template "descriptionTemplate" .}}{{end}}{{if .VisibleCommands}}
diff --git a/help.go b/help.go
@@ -54,7 +54,7 @@ var helpCommand = &Command{
 			cCtx = cCtx.parentContext
 		}
 
-		// Case 4. $ app hello foo
+		// Case 4. $ app help foo
 		// foo is the command for which help needs to be shown
 		if argsPresent {
 			return ShowCommandHelp(cCtx, firstArg)
diff --git a/template.go b/template.go
@@ -83,7 +83,10 @@ var SubcommandHelpTemplate = `NAME:
    {{template "helpNameTemplate" .}}
 
 USAGE:
-   {{if .UsageText}}{{wrap .UsageText 3}}{{else}}{{.HelpName}} {{if .VisibleFlags}}command [command options]{{end}}{{if .ArgsUsage}} {{.ArgsUsage}}{{else}}{{if .Args}} [arguments...]{{end}}{{end}}{{end}}{{if .Description}}
+   {{template "usageTemplate" .}}{{if .Category}}
+
+CATEGORY:
+   {{.Category}}{{end}}{{if .Description}}
 
 DESCRIPTION:
    {{template "descriptionTemplate" .}}{{end}}{{if .VisibleCommands}}
diff --git a/testdata/godoc-v2.x.txt b/testdata/godoc-v2.x.txt
@@ -35,7 +35,7 @@ var AppHelpTemplate = `NAME:
    {{template "helpNameTemplate" .}}
 
 USAGE:
-   {{if .UsageText}}{{wrap .UsageText 3}}{{else}}{{.HelpName}} {{if .VisibleFlags}}[global options]{{end}}{{if .Commands}} command [command options]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}{{if .Args}}[arguments...]{{end}}{{end}}{{end}}{{if .Version}}{{if not .HideVersion}}
+   {{if .UsageText}}{{wrap .UsageText 3}}{{else}}{{.HelpName}} {{if .VisibleFlags}}[global options]{{end}}{{if .Commands}} command [command options]{{end}}{{if .ArgsUsage}} {{.ArgsUsage}}{{else}}{{if .Args}} [arguments...]{{end}}{{end}}{{end}}{{if .Version}}{{if not .HideVersion}}
 
 VERSION:
    {{.Version}}{{end}}{{end}}{{if .Description}}
@@ -136,7 +136,10 @@ var SubcommandHelpTemplate = `NAME:
    {{template "helpNameTemplate" .}}
 
 USAGE:
-   {{if .UsageText}}{{wrap .UsageText 3}}{{else}}{{.HelpName}} {{if .VisibleFlags}}command [command options]{{end}} {{if .ArgsUsage}}{{.ArgsUsage}}{{else}}{{if .Args}}[arguments...]{{end}}{{end}}{{end}}{{if .Description}}
+   {{template "usageTemplate" .}}{{if .Category}}
+
+CATEGORY:
+   {{.Category}}{{end}}{{if .Description}}
 
 DESCRIPTION:
    {{template "descriptionTemplate" .}}{{end}}{{if .VisibleCommands}}

Original file line number	Diff line number	Diff line change
`@@ -2047,7 +2047,7 @@ func TestApp_Run_CommandSubcommandHelpName(t *testing.T) {`
`2047`	`2047`	`t.Errorf("expected %q in output: %q", expected, output)`
`2048`	`2048`	`}`
`2049`	`2049`
`2050`		`- expected = "base foo command [command options] [arguments...]"`
	`2050`	`+ expected = "base foo [command options] [arguments...]"`
`2051`	`2051`	`if !strings.Contains(output, expected) {`
`2052`	`2052`	`t.Errorf("expected %q in output: %q", expected, output)`
`2053`	`2053`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ var helpCommand = &Command{`
`54`	`54`	`cCtx = cCtx.parentContext`
`55`	`55`	`}`
`56`	`56`
`57`		`- // Case 4. $ app hello foo`
	`57`	`+ // Case 4. $ app help foo`
`58`	`58`	`// foo is the command for which help needs to be shown`
`59`	`59`	`if argsPresent {`
`60`	`60`	`return ShowCommandHelp(cCtx, firstArg)`