Fix:(issue_1293) Wrap usage text for commands

[dearchap]

What type of PR is this?

(REQUIRED)

• bug

What this PR does / why we need it:

(REQUIRED)

Fix command usage wrap for multiline text

Which issue(s) this PR fixes:

(REQUIRED)

Special notes for your reviewer:

(fill-in or delete this section)

Testing

(fill-in or delete this section)

go test -run=TestShowAppHelp_CommandMultiLine_UsageText

Release Notes

(REQUIRED)

[WestleyK]

Thanks for looking into this, so heres the output with your changes here:

$ ./foo 
NAME:
   foo - sample usage

USAGE:
   foo [global options] command [command options] [arguments...]

COMMANDS:
   test  long help for test command
   foo   long help for foo command
        this command does nothing.
   run  this is a long help output for the run command, long usage
        output, long usage output, long usage output, long usage output
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h  show help (default: false)

Better, but the indenting is not consistent with the other commands, heres what I would expect it to look like:

$ ./foo 
NAME:
   foo - sample usage

USAGE:
   foo [global options] command [command options] [arguments...]

COMMANDS:
   test     long help for test command
   foo      long help for foo command
            this command does nothing.
   run      this is a long help output for the run command, long usage
            output, long usage output, long usage output, long usage output
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h  show help (default: false)

Heres what it looks like without any newlines (before your changes):

$ ./foo 
NAME:
   foo - sample usage

USAGE:
   foo [global options] command [command options] [arguments...]

COMMANDS:
   test     long help for test command
   foo      long help for foo command this command does nothing.
   run      this is a long help output for the run command, long usage output, long usage output, long usage output, long usage output
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h  show help (default: false)

[dearchap]

@WestleyK Give it a shot now.

[WestleyK]

Looks perfect! Thanks for taking care of this issue!

$ ./foo 
NAME:
   foo - sample usage

USAGE:
   foo [global options] command [command options] [arguments...]

COMMANDS:
   test     long help for test command
   foo      long help for foo command
            this command does nothing.
   run      this is a long help output for the run command, long usage
            output, long usage output, long usage output, long usage output
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h  show help (default: false)

Code used

package main

import (
	"fmt"
	"os"

	"github.com/urfave/cli/v2"
)

func main() {
	app := &cli.App{
		Usage: "sample usage",
		Commands: []*cli.Command{
			{
				Name:  "test",
				Usage: "long help for test command",
			},
			{
				Name:  "foo",
				Usage: "long help for foo command\nthis command does nothing.",
			},
			{
				Name:  "run",
				Usage: "this is a long help output for the run command, long usage\noutput, long usage output, long usage output, long usage output",
				Action: func(c *cli.Context) error {
					return fmt.Errorf("nothing")
				},
			},
		},
	}

	err := app.Run(os.Args)
	if err != nil {
		fmt.Fprintf(os.Stdout, "%s: %s\n", os.Args[0], err)
		os.Exit(1)
	}
}

go.mod

module foo

go 1.18

require github.com/urfave/cli/v2 v2.11.2

require (
	github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
	github.com/russross/blackfriday/v2 v2.1.0 // indirect
	github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect
)

replace github.com/urfave/cli/v2 => github.com/dearchap/cli/v2 v2.3.1-0.20220824131205-915fd7adcaa5

Should also update the documentation that Usage allows newlines.

[dearchap]

@WestleyK would you like to submit a PR for the documentation ?

[mostynb]

lgtm with one small documentation request