From 2e73a96a489dd767c9713fd6bab7a95c234bdb41 Mon Sep 17 00:00:00 2001 From: awilliams Date: Fri, 17 Jan 2014 13:36:57 +0100 Subject: [PATCH] Right aligns "Use" and "Additional help topics" even if they are longer than the min padding --- cobra.go | 7 +++++++ command.go | 38 +++++++++++++++++++++++++++++++++++--- 2 files changed, 42 insertions(+), 3 deletions(-) diff --git a/cobra.go b/cobra.go index 4f0ca70b..b6533263 100644 --- a/cobra.go +++ b/cobra.go @@ -17,6 +17,7 @@ package cobra import ( + "fmt" "io" "reflect" "strconv" @@ -66,11 +67,17 @@ func Eq(a interface{}, b interface{}) bool { 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. func tmpl(w io.Writer, text string, data interface{}) error { t := template.New("top") t.Funcs(template.FuncMap{ "trim": strings.TrimSpace, + "rpad": rpad, "gt": Gt, "eq": Eq, }) diff --git a/command.go b/command.go index 6841004e..6b6811df 100644 --- a/command.go +++ b/command.go @@ -49,6 +49,9 @@ type Command struct { commands []*Command // Parent Command for this command parent *Command + // max lengths of commands' string lengths for use in padding + commandsMaxUseLen int + commandsMaxCommandPathLen int 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 { if c.usageTemplate != "" { return c.usageTemplate @@ -167,12 +190,12 @@ Usage: {{if .Runnable}} {{ .CommandPath}} [command]{{end}} {{ if .HasSubCommands}} Available Commands: {{range .Commands}}{{if .Runnable}} - {{.Use | printf "%-15s"}} :: {{.Short}}{{end}}{{end}} + {{rpad .Use .UsagePadding }} :: {{.Short}}{{end}}{{end}} {{end}} {{ if .HasFlags}} Available Flags: {{.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}} - {{.CommandPath | printf "%-11s"}} :: {{.Short}}{{end}}{{end}}{{end}}{{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}} + {{rpad .CommandPath .CommandPathPadding}} :: {{.Short}}{{end}}{{end}}{{end}}{{end}} {{end}} 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") } 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) } }