Update help output format

Author: Faris Huskovic

command_test.go

@@ -15,7 +15,7 @@ type (
 	// Mock for root/parent command.
 	mockParentCmd struct{}
 	// Mock subcommand with aliases and a nested sucommand of its own.
-	mockSubCmd struct{
+	mockSubCmd struct {
 		buf *bytes.Buffer
 	}
 	// Mock subcommand with aliases and no nested subcommands.
@@ -103,8 +103,8 @@ Commands:
 		fl := pflag.NewFlagSet(name, pflag.ExitOnError)
 		// If the help output doesn't contain the subcommand and
 		// isn't formatted the way we expect the test will fail.
-		renderHelp(name, cmd, fl, buf)
-		got := string(buf.Bytes())
+		renderHelp(buf, name, cmd, fl)
+		got := buf.String()
 		assert.Equal(t, t.Name(), expected, got)
 	})
 }
@@ -128,8 +128,8 @@ Description: A simple mock subcommand with aliases and no nested subcommands.
 `
 
 	for _, test := range []struct {
-		cmd            Command
 		name, expected string
+		cmd            Command
 	}{
 		{
 			name:     "subcmd w/nested subcmd.",
@@ -148,8 +148,8 @@ Description: A simple mock subcommand with aliases and no nested subcommands.
 			fl := pflag.NewFlagSet(name, pflag.ExitOnError)
 			// If the help output is not written to the buffer
 			// in the format we expect then the test will fail.
-			renderHelp(name, test.cmd, fl, buf)
-			got := string(buf.Bytes())
+			renderHelp(buf, name, test.cmd, fl)
+			got := buf.String()
 			assert.Equal(t, t.Name(), test.expected, got)
 		})
 	}

help.go

@@ -45,7 +45,7 @@ func renderFlagHelp(fullName string, fl *pflag.FlagSet, w io.Writer) {
 }
 
 // renderHelp generates a command's help page.
-func renderHelp(fullName string, cmd Command, fl *pflag.FlagSet, w io.Writer) {
+func renderHelp(w io.Writer, fullName string, cmd Command, fl *pflag.FlagSet) {
 	var b strings.Builder
 	spec := cmd.Spec()
 	fmt.Fprintf(&b, "Usage: %v %v\n\n", fullName, spec.Usage)
@@ -54,9 +54,8 @@ func renderHelp(fullName string, cmd Command, fl *pflag.FlagSet, w io.Writer) {
 	if spec.HasAliases() {
 		fmt.Fprintf(&b, "Aliases: %s\n\n", strings.Join(spec.Aliases, ", "))
 	}
-	// Render usage and description.
-	usageAndDesc := fmt.Sprintf("%sDescription: %s\n", b.String(), spec.Desc)
-	fmt.Fprint(w, usageAndDesc)
+	// Print usage and description.
+	fmt.Fprintf(w, "%sDescription: %s\n", b.String(), spec.Desc)
 
 	tw := tabwriter.NewWriter(w, 0, 4, 2, ' ', tabwriter.StripEscape)
 	defer tw.Flush()

run.go

@@ -94,7 +94,7 @@ func Run(cmd Command, args []string, parent string) {
 	// Reassign the usage now that we've parsed the args
 	// so that we can render it manually.
 	fl.Usage = func() {
-		renderHelp(name, cmd, fl, os.Stderr)
+		renderHelp(os.Stderr, name, cmd, fl)
 	}
 	if err != nil {
 		fl.Usage()