glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2025-05-05 12:57:22 +00:00
Code Issues Projects Releases Packages Wiki Activity

Check if a command is 'hidden' before adding length to usage

Browse source
This commit is contained in:
Víctor Martínez Bevià 2022-04-29 10:55:10 +02:00
parent 4f0facbcee
commit 6e6f85e119
2 changed files with 47 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
command.go
View file

@ -1162,6 +1162,7 @@ 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
if !cmds[i].Hidden {
// update max lengths // update max lengths
usageLen := len(x.Use) usageLen := len(x.Use)
if usageLen > c.commandsMaxUseLen { if usageLen > c.commandsMaxUseLen {
@ -1175,6 +1176,7 @@ func (c *Command) AddCommand(cmds ...*Command) {
if nameLen > c.commandsMaxNameLen { if nameLen > c.commandsMaxNameLen {
c.commandsMaxNameLen = nameLen c.commandsMaxNameLen = nameLen
} }
}
// If global normalization function exists, update all children // If global normalization function exists, update all children
if c.globNormFunc != nil { if c.globNormFunc != nil {
x.SetGlobalNormalizationFunc(c.globNormFunc) x.SetGlobalNormalizationFunc(c.globNormFunc)
@ -1203,6 +1205,7 @@ main:
c.commandsMaxCommandPathLen = 0 c.commandsMaxCommandPathLen = 0
c.commandsMaxNameLen = 0 c.commandsMaxNameLen = 0
for _, command := range c.commands { for _, command := range c.commands {
if !command.Hidden {
usageLen := len(command.Use) usageLen := len(command.Use)
if usageLen > c.commandsMaxUseLen { if usageLen > c.commandsMaxUseLen {
c.commandsMaxUseLen = usageLen c.commandsMaxUseLen = usageLen
@ -1216,6 +1219,7 @@ main:
c.commandsMaxNameLen = nameLen c.commandsMaxNameLen = nameLen
} }
} }
}
} }
// Print is a convenience method to Print to the defined output, fallback to Stderr if not set. // Print is a convenience method to Print to the defined output, fallback to Stderr if not set.

20
command_test.go
View file

@ -2161,3 +2161,23 @@ func TestSetContextPersistentPreRun(t *testing.T) {
t.Error(err) t.Error(err)
} }
} }
func TestCommandsLengthWithoutHiddenCommands(t *testing.T) {
rootCmd := &Command{Use: "root", TraverseChildren: true}
rootCmd.Flags().String("foo", "", "foo things")
// add a normal command
childCmd := &Command{Use: "child"}
childCmd.Flags().String("str", "", "")
rootCmd.AddCommand(childCmd)
//add a hidden command
child2Cmd := &Command{Use: "reallyLongCommand"}
child2Cmd.Flags().String("str", "", "")
child2Cmd.Hidden = true
rootCmd.AddCommand(child2Cmd)
//hidden commands should not be taken into account for usage length
expectedmaxLen := 5
fmt.Println(rootCmd.commandsMaxUseLen)
if rootCmd.commandsMaxUseLen != expectedmaxLen {
t.Errorf("Expected value: \n %v\nGot:\n %v\n", expectedmaxLen, rootCmd.commandsMaxUseLen)
}
}