Merge pull request #2480 from INo-xious/fix/suggest-hidden-flags

fix: don't suggest hidden flags or commands

Reviewed-by: Kai Ase Siren <coilysiren@gmail.com>
Reviewed-by: Eng Zer Jun <engzerjun@gmail.com>
Tested-by: Eng Zer Jun <engzerjun@gmail.com>

Author: Juneezee

help.go

@@ -339,7 +339,14 @@ func DefaultShowCommandHelp(ctx context.Context, cmd *Command, commandName strin
 		errMsg := fmt.Sprintf("No help topic for '%v'", commandName)
 
 		if cmd.Suggest {
-			if suggestion := SuggestCommand(cmd.Commands, commandName); suggestion != "" {
+			// Hidden commands must not be suggested, as in shell completion.
+			var commands []*Command
+			for _, subCmd := range cmd.Commands {
+				if !subCmd.Hidden {
+					commands = append(commands, subCmd)
+				}
+			}
+			if suggestion := SuggestCommand(commands, commandName); suggestion != "" {
 				errMsg += ". " + suggestion
 			}
 		}

help_test.go

@@ -2379,6 +2379,26 @@ func TestCommandHelpSuggest(t *testing.T) {
 	assert.ErrorContains(t, err, "No help topic for 'put'. putz")
 }
 
+func TestCommandHelpSuggestHiddenCommand(t *testing.T) {
+	cmd := &Command{
+		Suggest: true,
+		Commands: []*Command{
+			{
+				Name:   "putz",
+				Hidden: true,
+			},
+			{
+				Name: "pull",
+			},
+		},
+	}
+
+	cmd.setupDefaults([]string{"foo"})
+
+	err := ShowCommandHelp(context.Background(), cmd, "put")
+	assert.EqualError(t, err, "No help topic for 'put'. pull")
+}
+
 func TestWrapLine(t *testing.T) {
 	assert.Equal(t, "    ", wrapLine("    ", 0, 3, " "))
 }

suggestions.go

@@ -108,6 +108,10 @@ func suggestFlag(flags []Flag, provided string, hideHelp bool) string {
 
 	for _, flag := range flags {
 		flagNames := flag.Names()
+		// Hidden flags must not be suggested; help is still offered.
+		if vf, ok := flag.(VisibleFlag); ok && !vf.IsVisible() {
+			flagNames = nil
+		}
 		if !hideHelp && HelpFlag != nil {
 			flagNames = append(flagNames, HelpFlag.Names()...)
 		}

suggestions_test.go

@@ -1,6 +1,8 @@
 package cli
 
 import (
+	"bytes"
+	"context"
 	"errors"
 	"fmt"
 	"testing"
@@ -69,6 +71,43 @@ func TestSuggestFlagHideHelp(t *testing.T) {
 	assert.Equal(t, "--fl", res)
 }
 
+func TestSuggestFlagHiddenFlag(t *testing.T) {
+	// Given
+	flags := []Flag{
+		&BoolFlag{Name: "internal-debug", Hidden: true},
+		&BoolFlag{Name: "verbose"},
+	}
+
+	// When
+	res := suggestFlag(flags, "internal-debu", true)
+
+	// Then
+	assert.Equal(t, "--verbose", res)
+}
+
+func TestSuggestFlagHiddenFlagFromRun(t *testing.T) {
+	// Given
+	var out bytes.Buffer
+	cmd := &Command{
+		Name:      "app",
+		Suggest:   true,
+		Writer:    &out,
+		ErrWriter: &out,
+		Flags: []Flag{
+			&BoolFlag{Name: "internal-debug", Hidden: true},
+			&BoolFlag{Name: "verbose"},
+		},
+		Action: func(context.Context, *Command) error { return nil },
+	}
+
+	// When
+	err := cmd.Run(buildTestContext(t), []string{"app", "--internal-debu"})
+
+	// Then
+	assert.Error(t, err)
+	assert.NotContains(t, out.String(), "internal-debug")
+}
+
 func TestSuggestFlagFromError(t *testing.T) {
 	// Given
 	app := buildExtendedTestCommand()