glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2025-01-30 23:46:45 +00:00
Code Issues Projects Releases Packages Wiki Activity

make string "help" a constant more

Browse source
This commit is contained in:
aarzilli 2024-12-26 09:38:21 +01:00 committed by Marc Khouzam
parent beec32994a
commit 6585f26cec
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
command.go
View file

@ -33,7 +33,8 @@ const (
FlagSetByCobraAnnotation = "cobra_annotation_flag_set_by_cobra" FlagSetByCobraAnnotation = "cobra_annotation_flag_set_by_cobra"
CommandDisplayNameAnnotation = "cobra_annotation_command_display_name" CommandDisplayNameAnnotation = "cobra_annotation_command_display_name"
helpFlagName = "help" helpFlagName = "help"
helpCommandName = "help"
) )
// FParseErrWhitelist configures Flag parse errors to be ignored // FParseErrWhitelist configures Flag parse errors to be ignored
@ -872,7 +873,7 @@ func (c *Command) execute(a []string) (err error) {
// If help is called, regardless of other flags, return we want help. // If help is called, regardless of other flags, return we want help.
// Also say we need help if the command isn't runnable. // Also say we need help if the command isn't runnable.
helpVal, err := c.Flags().GetBool("help") helpVal, err := c.Flags().GetBool(helpFlagName)
if err != nil { if err != nil {
// should be impossible to get here as we always declare a help // should be impossible to get here as we always declare a help
// flag in InitDefaultHelpFlag() // flag in InitDefaultHelpFlag()
@ -1942,7 +1943,7 @@ func defaultUsageFunc(w io.Writer, in interface{}) error {
if len(c.Groups()) == 0 { if len(c.Groups()) == 0 {
fmt.Fprintf(w, "\n\nAvailable Commands:") fmt.Fprintf(w, "\n\nAvailable Commands:")
for _, subcmd := range cmds { for _, subcmd := range cmds {
if subcmd.IsAvailableCommand() || subcmd.Name() == "help" { if subcmd.IsAvailableCommand() || subcmd.Name() == helpCommandName {
fmt.Fprintf(w, "\n %s %s", rpad(subcmd.Name(), subcmd.NamePadding()), subcmd.Short) fmt.Fprintf(w, "\n %s %s", rpad(subcmd.Name(), subcmd.NamePadding()), subcmd.Short)
} }
} }
@ -1950,7 +1951,7 @@ func defaultUsageFunc(w io.Writer, in interface{}) error {
for _, group := range c.Groups() { for _, group := range c.Groups() {
fmt.Fprintf(w, "\n\n%s", group.Title) fmt.Fprintf(w, "\n\n%s", group.Title)
for _, subcmd := range cmds { for _, subcmd := range cmds {
if subcmd.GroupID == group.ID && (subcmd.IsAvailableCommand() || subcmd.Name() == "help") { if subcmd.GroupID == group.ID && (subcmd.IsAvailableCommand() || subcmd.Name() == helpCommandName) {
fmt.Fprintf(w, "\n %s %s", rpad(subcmd.Name(), subcmd.NamePadding()), subcmd.Short) fmt.Fprintf(w, "\n %s %s", rpad(subcmd.Name(), subcmd.NamePadding()), subcmd.Short)
} }
} }
@ -1958,7 +1959,7 @@ func defaultUsageFunc(w io.Writer, in interface{}) error {
if !c.AllChildCommandsHaveGroup() { if !c.AllChildCommandsHaveGroup() {
fmt.Fprintf(w, "\n\nAdditional Commands:") fmt.Fprintf(w, "\n\nAdditional Commands:")
for _, subcmd := range cmds { for _, subcmd := range cmds {
if subcmd.GroupID == "" && (subcmd.IsAvailableCommand() || subcmd.Name() == "help") { if subcmd.GroupID == "" && (subcmd.IsAvailableCommand() || subcmd.Name() == helpCommandName) {
fmt.Fprintf(w, "\n %s %s", rpad(subcmd.Name(), subcmd.NamePadding()), subcmd.Short) fmt.Fprintf(w, "\n %s %s", rpad(subcmd.Name(), subcmd.NamePadding()), subcmd.Short)
} }
} }