x/urfave-cli
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

improve help by including parent command for subcommands

Browse Source
This commit is contained in:
Tristan Zajonc 2015-08-04 21:13:28 -07:00
parent ef65245544
commit ecb0b5ac0a
2 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
command.go
View File

@ -39,6 +39,9 @@ type Command struct {
// Boolean to hide built-in help command // Boolean to hide built-in help command
HideHelp bool HideHelp bool
// Name of parent command for help, defaults to app.Name and parent
// command.Name.
ParentName string
commandNamePath []string commandNamePath []string
} }
@ -196,6 +199,7 @@ func (c Command) startApp(ctx *Context) error {
var newCmds []Command var newCmds []Command
for _, cc := range app.Commands { for _, cc := range app.Commands {
cc.ParentName = app.Name
cc.commandNamePath = []string{c.Name, cc.Name} cc.commandNamePath = []string{c.Name, cc.Name}
newCmds = append(newCmds, cc) newCmds = append(newCmds, cc)
} }

4
help.go
View File

@ -38,10 +38,10 @@ COPYRIGHT:
// cli.go uses text/template to render templates. You can // cli.go uses text/template to render templates. You can
// render custom help text by setting this variable. // render custom help text by setting this variable.
var CommandHelpTemplate = `NAME: var CommandHelpTemplate = `NAME:
{{.FullName}} - {{.Usage}} {{.ParentName}} {{.Name}} - {{.Usage}}
USAGE: USAGE:
command {{.FullName}}{{if .Flags}} [command options]{{end}} {{.ArgsUsage}}{{if .Description}} {{.ParentName}} {{.Name}}{{if .Flags}} [command options]{{end}} {{.ArgsUsage}}{{if .Description}}
DESCRIPTION: DESCRIPTION:
{{.Description}}{{end}}{{if .Flags}} {{.Description}}{{end}}{{if .Flags}}