mirror of
https://github.com/spf13/cobra
synced 2024-11-24 14:47:12 +00:00
help displays command names instead of usage in Available Commands
This commit is contained in:
parent
07a9dc0024
commit
a16cb24999
2 changed files with 24 additions and 1 deletions
|
@ -467,8 +467,16 @@ func TestRootHelp(t *testing.T) {
|
||||||
t.Errorf("--help shouldn't trigger an error, Got: \n %s", x.Output)
|
t.Errorf("--help shouldn't trigger an error, Got: \n %s", x.Output)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if strings.Contains(x.Output, cmdEcho.Use) {
|
||||||
|
t.Errorf("--help shouldn't display subcommand's usage, Got: \n %s", x.Output)
|
||||||
|
}
|
||||||
|
|
||||||
x = fullSetupTest("echo --help")
|
x = fullSetupTest("echo --help")
|
||||||
|
|
||||||
|
if strings.Contains(x.Output, cmdTimes.Use) {
|
||||||
|
t.Errorf("--help shouldn't display subsubcommand's usage, Got: \n %s", x.Output)
|
||||||
|
}
|
||||||
|
|
||||||
checkResultContains(t, x, "Available Commands:")
|
checkResultContains(t, x, "Available Commands:")
|
||||||
checkResultContains(t, x, "for more information about a command")
|
checkResultContains(t, x, "for more information about a command")
|
||||||
|
|
||||||
|
|
17
command.go
17
command.go
|
@ -54,6 +54,7 @@ type Command struct {
|
||||||
// max lengths of commands' string lengths for use in padding
|
// max lengths of commands' string lengths for use in padding
|
||||||
commandsMaxUseLen int
|
commandsMaxUseLen int
|
||||||
commandsMaxCommandPathLen int
|
commandsMaxCommandPathLen int
|
||||||
|
commandsMaxNameLen int
|
||||||
|
|
||||||
flagErrorBuf *bytes.Buffer
|
flagErrorBuf *bytes.Buffer
|
||||||
cmdErrorBuf *bytes.Buffer
|
cmdErrorBuf *bytes.Buffer
|
||||||
|
@ -181,6 +182,16 @@ func (c *Command) CommandPathPadding() int {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
var minNamePadding int = 11
|
||||||
|
|
||||||
|
func (c *Command) NamePadding() int {
|
||||||
|
if c.parent == nil || minNamePadding > c.parent.commandsMaxNameLen {
|
||||||
|
return minNamePadding
|
||||||
|
} else {
|
||||||
|
return c.parent.commandsMaxNameLen
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func (c *Command) UsageTemplate() string {
|
func (c *Command) UsageTemplate() string {
|
||||||
if c.usageTemplate != "" {
|
if c.usageTemplate != "" {
|
||||||
return c.usageTemplate
|
return c.usageTemplate
|
||||||
|
@ -198,7 +209,7 @@ Aliases:
|
||||||
{{.NameAndAliases}}{{end}}
|
{{.NameAndAliases}}{{end}}
|
||||||
{{ if .HasSubCommands}}
|
{{ if .HasSubCommands}}
|
||||||
Available Commands: {{range .Commands}}{{if .Runnable}}
|
Available Commands: {{range .Commands}}{{if .Runnable}}
|
||||||
{{rpad .Use .UsagePadding }} {{.Short}}{{end}}{{end}}
|
{{rpad .Name .NamePadding }} {{.Short}}{{end}}{{end}}
|
||||||
{{end}}
|
{{end}}
|
||||||
{{ if .HasLocalFlags}}Flags:
|
{{ if .HasLocalFlags}}Flags:
|
||||||
{{.LocalFlags.FlagUsages}}{{end}}
|
{{.LocalFlags.FlagUsages}}{{end}}
|
||||||
|
@ -529,6 +540,10 @@ func (c *Command) AddCommand(cmds ...*Command) {
|
||||||
if commandPathLen > c.commandsMaxCommandPathLen {
|
if commandPathLen > c.commandsMaxCommandPathLen {
|
||||||
c.commandsMaxCommandPathLen = commandPathLen
|
c.commandsMaxCommandPathLen = commandPathLen
|
||||||
}
|
}
|
||||||
|
nameLen := len(x.Name())
|
||||||
|
if nameLen > c.commandsMaxNameLen {
|
||||||
|
c.commandsMaxNameLen = nameLen
|
||||||
|
}
|
||||||
c.commands = append(c.commands, x)
|
c.commands = append(c.commands, x)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue