ffcli: add DESCRIPTION with Shorthelp to DefaultUsageFunc (#111)

* ffcli: DefaultUsageFunc: add DESCRIPTION with ShortHelp * ffcli: fix tests
peterbourgon · Jun 16, 2023 · 858a455 · 858a455
1 parent a98a914
commit 858a455
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/ffcli/command.go b/ffcli/command.go
@@ -200,6 +200,12 @@ func (e NoExecError) Error() string {
 func DefaultUsageFunc(c *Command) string {
 	var b strings.Builder
 
+	if c.ShortHelp != "" {
+		fmt.Fprintf(&b, "DESCRIPTION\n")
+		fmt.Fprintf(&b, "  %s\n", c.ShortHelp)
+		fmt.Fprintf(&b, "\n")
+	}
+
 	fmt.Fprintf(&b, "USAGE\n")
 	if c.ShortUsage != "" {
 		fmt.Fprintf(&b, "  %s\n", c.ShortUsage)

diff --git a/ffcli/command_test.go b/ffcli/command_test.go
@@ -593,6 +593,9 @@ func assertStringSlice(t *testing.T, want, have []string) {
 }
 
 var defaultUsageFuncOutput = strings.TrimSpace(`
+DESCRIPTION
+  Some short help.
+
 USAGE
   TestHelpUsage [flags] <args>