feat(command): show global options in command help

If there are persistent flags, they should also be displayed in the command.

Signed-off-by: Kevin Cui <[email protected]>

command.go

@@ -868,6 +868,18 @@ func (cmd *Command) appendFlag(fl Flag) {
 	}
 }
 
+func (cmd *Command) VisiblePersistentFlags() []Flag {
+	var flags []Flag
+	for _, fl := range cmd.Root().Flags {
+		pfl, ok := fl.(PersistentFlag)
+		if !ok || !pfl.IsPersistent() {
+			continue
+		}
+		flags = append(flags, fl)
+	}
+	return visibleFlags(flags)
+}
+
 func (cmd *Command) appendCommand(aCmd *Command) {
 	if !hasCommand(cmd.Commands, aCmd) {
 		aCmd.parent = cmd

help.go

@@ -410,6 +410,10 @@ func printHelpCustom(out io.Writer, templ string, data interface{}, customFuncs
 		handleTemplateError(err)
 	}
 
+	if _, err := t.New("visiblePersistentFlagTemplate").Parse(visiblePersistentFlagTemplate); err != nil {
+		handleTemplateError(err)
+	}
+
 	if _, err := t.New("visibleGlobalFlagCategoryTemplate").Parse(strings.Replace(visibleFlagCategoryTemplate, "OPTIONS", "GLOBAL OPTIONS", -1)); err != nil {
 		handleTemplateError(err)
 	}

help_test.go

@@ -687,6 +687,51 @@ UsageText`,
 		"expected output to include usage text")
 }
 
+func TestShowSubcommandHelp_GlobalOptions(t *testing.T) {
+	cmd := &Command{
+		Flags: []Flag{
+			&StringFlag{
+				Name:       "foo",
+				Persistent: true,
+			},
+		},
+		Commands: []*Command{
+			{
+				Name: "frobbly",
+				Flags: []Flag{
+					&StringFlag{
+						Name: "bar",
+					},
+				},
+				Action: func(context.Context, *Command) error {
+					return nil
+				},
+			},
+		},
+	}
+
+	output := &bytes.Buffer{}
+	cmd.Writer = output
+
+	_ = cmd.Run(buildTestContext(t), []string{"foo", "frobbly", "--help"})
+
+	expected := `NAME:
+   foo frobbly
+
+USAGE:
+   foo frobbly [command [command options]] 
+
+OPTIONS:
+   --bar value  
+   --help, -h   show help
+
+GLOBAL OPTIONS:
+   --foo value  
+`
+
+	assert.Contains(t, output.String(), expected, "expected output to include global options")
+}
+
 func TestShowSubcommandHelp_SubcommandUsageText(t *testing.T) {
 	cmd := &Command{
 		Commands: []*Command{
@@ -1652,13 +1697,13 @@ COMMANDS:
 
 GLOBAL OPTIONS:
    --help, -h    show help
-   --m2 value    
-   --strd value  
+   --m2 value
+   --strd value
 
    cat1
 
    --intd value, --altd1 value, --altd2 value  (default: 0)
-   --m1 value                                  
+   --m1 value
 
 `, output.String())
 }

template.go

@@ -28,6 +28,9 @@ var visibleFlagCategoryTemplate = `{{range .VisibleFlagCategories}}
 var visibleFlagTemplate = `{{range $i, $e := .VisibleFlags}}
    {{wrap $e.String 6}}{{end}}`
 
+var visiblePersistentFlagTemplate = `{{range $i, $e := .VisiblePersistentFlags}}
+   {{wrap $e.String 6}}{{end}}`
+
 var versionTemplate = `{{if .Version}}{{if not .HideVersion}}
 
 VERSION:
@@ -80,7 +83,9 @@ DESCRIPTION:
 
 OPTIONS:{{template "visibleFlagCategoryTemplate" .}}{{else if .VisibleFlags}}
 
-OPTIONS:{{template "visibleFlagTemplate" .}}{{end}}
+OPTIONS:{{template "visibleFlagTemplate" .}}{{end}}{{if .VisiblePersistentFlags}}
+
+GLOBAL OPTIONS:{{template "visiblePersistentFlagTemplate" .}}{{end}}
 `
 
 // SubcommandHelpTemplate is the text template for the subcommand help topic.