Merge pull request #8 from awilliams/master

Right aligns "Use" and "Additional help topics"
This commit is contained in:
Steve Francia 2014-01-17 05:19:31 -08:00
commit 1e1ff9e35e
2 changed files with 42 additions and 3 deletions

View File

@ -17,6 +17,7 @@
package cobra package cobra
import ( import (
"fmt"
"io" "io"
"reflect" "reflect"
"strconv" "strconv"
@ -66,11 +67,17 @@ func Eq(a interface{}, b interface{}) bool {
return false return false
} }
func rpad(s string, padding int) string {
template := fmt.Sprintf("%%-%ds", padding)
return fmt.Sprintf(template, s)
}
// tmpl executes the given template text on data, writing the result to w. // tmpl executes the given template text on data, writing the result to w.
func tmpl(w io.Writer, text string, data interface{}) error { func tmpl(w io.Writer, text string, data interface{}) error {
t := template.New("top") t := template.New("top")
t.Funcs(template.FuncMap{ t.Funcs(template.FuncMap{
"trim": strings.TrimSpace, "trim": strings.TrimSpace,
"rpad": rpad,
"gt": Gt, "gt": Gt,
"eq": Eq, "eq": Eq,
}) })

View File

@ -49,6 +49,9 @@ type Command struct {
commands []*Command commands []*Command
// Parent Command for this command // Parent Command for this command
parent *Command parent *Command
// max lengths of commands' string lengths for use in padding
commandsMaxUseLen int
commandsMaxCommandPathLen int
flagErrorBuf *bytes.Buffer flagErrorBuf *bytes.Buffer
@ -153,6 +156,26 @@ func (c *Command) HelpFunc() func(*Command, []string) {
} }
} }
var minUsagePadding int = 25
func (c *Command) UsagePadding() int {
if c.parent == nil || minUsagePadding > c.parent.commandsMaxUseLen {
return minUsagePadding
} else {
return c.parent.commandsMaxUseLen
}
}
var minCommandPathPadding int = 11
func (c *Command) CommandPathPadding() int {
if c.parent == nil || minCommandPathPadding > c.parent.commandsMaxCommandPathLen {
return minCommandPathPadding
} else {
return c.parent.commandsMaxCommandPathLen
}
}
func (c *Command) UsageTemplate() string { func (c *Command) UsageTemplate() string {
if c.usageTemplate != "" { if c.usageTemplate != "" {
return c.usageTemplate return c.usageTemplate
@ -167,12 +190,12 @@ Usage: {{if .Runnable}}
{{ .CommandPath}} [command]{{end}} {{ .CommandPath}} [command]{{end}}
{{ if .HasSubCommands}} {{ if .HasSubCommands}}
Available Commands: {{range .Commands}}{{if .Runnable}} Available Commands: {{range .Commands}}{{if .Runnable}}
{{.Use | printf "%-15s"}} :: {{.Short}}{{end}}{{end}} {{rpad .Use .UsagePadding }} :: {{.Short}}{{end}}{{end}}
{{end}} {{end}}
{{ if .HasFlags}} Available Flags: {{ if .HasFlags}} Available Flags:
{{.Flags.FlagUsages}}{{end}}{{if .HasParent}}{{if and (gt .Commands 0) (gt .Parent.Commands 1) }} {{.Flags.FlagUsages}}{{end}}{{if .HasParent}}{{if and (gt .Commands 0) (gt .Parent.Commands 1) }}
Additional help topics: {{if gt .Commands 0 }}{{range .Commands}}{{if not .Runnable}} {{.CommandPath | printf "%-11s"}} :: {{.Short}}{{end}}{{end}}{{end}}{{if gt .Parent.Commands 1 }}{{range .Parent.Commands}}{{if .Runnable}}{{if not (eq .Name $cmd.Name) }}{{end}} Additional help topics: {{if gt .Commands 0 }}{{range .Commands}}{{if not .Runnable}} {{rpad .CommandPath .CommandPathPadding}} :: {{.Short}}{{end}}{{end}}{{end}}{{if gt .Parent.Commands 1 }}{{range .Parent.Commands}}{{if .Runnable}}{{if not (eq .Name $cmd.Name) }}{{end}}
{{.CommandPath | printf "%-11s"}} :: {{.Short}}{{end}}{{end}}{{end}}{{end}} {{rpad .CommandPath .CommandPathPadding}} :: {{.Short}}{{end}}{{end}}{{end}}{{end}}
{{end}} {{end}}
Use "{{.Root.Name}} help [command]" for more information about that command. Use "{{.Root.Name}} help [command]" for more information about that command.
` `
@ -362,6 +385,15 @@ func (c *Command) AddCommand(cmds ...*Command) {
panic("Command can't be a child of itself") panic("Command can't be a child of itself")
} }
cmds[i].parent = c cmds[i].parent = c
// update max lengths
usageLen := len(x.Use)
if usageLen > c.commandsMaxUseLen {
c.commandsMaxUseLen = usageLen
}
commandPathLen := len(x.CommandPath())
if commandPathLen > c.commandsMaxCommandPathLen {
c.commandsMaxCommandPathLen = commandPathLen
}
c.commands = append(c.commands, x) c.commands = append(c.commands, x)
} }
} }