Merge branch 'main' into fix-command-help

dearchap · web-flow · commit e7c80cea88b2 · 2026-03-21T10:06:16.000-04:00
diff --git a/command.go b/command.go
@@ -90,7 +90,7 @@ type Command struct {
 	// default behavior.
 	ExitErrHandler ExitErrHandlerFunc `json:"-"`
 	// Other custom info
-	Metadata map[string]interface{} `json:"metadata"`
+	Metadata map[string]any `json:"metadata"`
 	// Carries a function which returns app specific info.
 	ExtraInfo func() map[string]string `json:"-"`
 	// CustomRootCommandHelpTemplate the text template for app help topic.
@@ -559,7 +559,7 @@ func (cmd *Command) Count(name string) int {
 }
 
 // Value returns the value of the flag corresponding to `name`
-func (cmd *Command) Value(name string) interface{} {
+func (cmd *Command) Value(name string) any {
 	if fs := cmd.lookupFlag(name); fs != nil {
 		tracef("value found for name %[1]q (cmd=%[2]q)", name, cmd.Name)
 		return fs.Get()
diff --git a/command_test.go b/command_test.go
@@ -1973,7 +1973,7 @@ func TestCommandHelpPrinter(t *testing.T) {
 	}()
 
 	wasCalled := false
-	HelpPrinter = func(io.Writer, string, interface{}) {
+	HelpPrinter = func(io.Writer, string, any) {
 		wasCalled = true
 	}
 
@@ -5420,7 +5420,7 @@ func TestCommand_ExclusiveFlagsWithAfter(t *testing.T) {
 func TestCommand_ParallelRun(t *testing.T) {
 	t.Parallel()
 
-	for i := 0; i < 10; i++ {
+	for i := range 10 {
 		t.Run(fmt.Sprintf("run_%d", i), func(t *testing.T) {
 			t.Parallel()
 
diff --git a/completion_test.go b/completion_test.go
@@ -69,15 +69,15 @@ func TestCompletionSubcommand(t *testing.T) {
 		args        []string
 		contains    string
 		msg         string
-		msgArgs     []interface{}
+		msgArgs     []any
 		notContains bool
 	}{
 		{
 			name:     "subcommand general completion",
 			args:     []string{"foo", "bar", completionFlag},
 			contains: "xyz",
 			msg:      "Expected output to contain shell name %[1]q",
-			msgArgs: []interface{}{
+			msgArgs: []any{
 				"xyz",
 			},
 		},
@@ -86,7 +86,7 @@ func TestCompletionSubcommand(t *testing.T) {
 			args:     []string{"foo", "bar", "-", completionFlag},
 			contains: "l1",
 			msg:      "Expected output to contain shell name %[1]q",
-			msgArgs: []interface{}{
+			msgArgs: []any{
 				"l1",
 			},
 		},
@@ -95,7 +95,7 @@ func TestCompletionSubcommand(t *testing.T) {
 			args:     []string{"foo", "bar", "--", completionFlag},
 			contains: "l1",
 			msg:      "Expected output to contain shell name %[1]q",
-			msgArgs: []interface{}{
+			msgArgs: []any{
 				"l1",
 			},
 			notContains: true,
@@ -105,7 +105,7 @@ func TestCompletionSubcommand(t *testing.T) {
 			args:     []string{"foo", "bar", "xyz", completionFlag},
 			contains: "-g",
 			msg:      "Expected output to contain flag %[1]q",
-			msgArgs: []interface{}{
+			msgArgs: []any{
 				"-g",
 			},
 			notContains: true,
@@ -115,7 +115,7 @@ func TestCompletionSubcommand(t *testing.T) {
 			args:     []string{"foo", "bar", "xyz", "-", completionFlag},
 			contains: "-g",
 			msg:      "Expected output to contain flag %[1]q",
-			msgArgs: []interface{}{
+			msgArgs: []any{
 				"-g",
 			},
 		},
@@ -124,7 +124,7 @@ func TestCompletionSubcommand(t *testing.T) {
 			args:     []string{"foo", "bar", "xyz", "--", completionFlag},
 			contains: "-g",
 			msg:      "Expected output to contain flag %[1]q",
-			msgArgs: []interface{}{
+			msgArgs: []any{
 				"-g",
 			},
 			notContains: true,
@@ -134,7 +134,7 @@ func TestCompletionSubcommand(t *testing.T) {
 			args:     []string{"foo", "bar", "xyz", "--", "sargs", completionFlag},
 			contains: "-g",
 			msg:      "Expected output to contain flag %[1]q",
-			msgArgs: []interface{}{
+			msgArgs: []any{
 				"-g",
 			},
 			notContains: true,
diff --git a/docs.go b/docs.go
@@ -35,21 +35,21 @@ func unquoteUsage(usage string) (string, string) {
 }
 
 func prefixedNames(names []string, placeholder string) string {
-	var prefixed string
+	var prefixed strings.Builder
 	for i, name := range names {
 		if name == "" {
 			continue
 		}
 
-		prefixed += prefixFor(name) + name
+		prefixed.WriteString(prefixFor(name) + name)
 		if placeholder != "" {
-			prefixed += " " + placeholder
+			prefixed.WriteString(" " + placeholder)
 		}
 		if i < len(names)-1 {
-			prefixed += ", "
+			prefixed.WriteString(", ")
 		}
 	}
-	return prefixed
+	return prefixed.String()
 }
 
 func envFormat(envVars []string, prefix, sep, suffix string) string {
diff --git a/flag.go b/flag.go
@@ -3,7 +3,7 @@ package cli
 import (
 	"context"
 	"fmt"
-	"regexp"
+	"slices"
 	"strings"
 	"time"
 )
@@ -16,11 +16,7 @@ const (
 	disableSliceFlagSeparator       = false
 )
 
-var (
-	slPfx = fmt.Sprintf("sl:::%d:::", time.Now().UTC().UnixNano())
-
-	commaWhitespace = regexp.MustCompile("[, ]+.*")
-)
+var slPfx = fmt.Sprintf("sl:::%d:::", time.Now().UTC().UnixNano())
 
 // GenerateShellCompletionFlag enables shell completion
 var GenerateShellCompletionFlag Flag = &BoolFlag{
@@ -201,20 +197,18 @@ func FlagNames(name string, aliases []string) []string {
 		// Strip off anything after the first found comma or space, which
 		// *hopefully* makes it a tiny bit more obvious that unexpected behavior is
 		// caused by using the v1 form of stringly typed "Name".
-		ret = append(ret, commaWhitespace.ReplaceAllString(part, ""))
+		if i := strings.IndexAny(part, ", "); i >= 0 {
+			ret = append(ret, part[:i])
+		} else {
+			ret = append(ret, part)
+		}
 	}
 
 	return ret
 }
 
 func hasFlag(flags []Flag, fl Flag) bool {
-	for _, existing := range flags {
-		if fl == existing {
-			return true
-		}
-	}
-
-	return false
+	return slices.Contains(flags, fl)
 }
 
 func flagSplitMultiValues(val string, sliceSeparator string, disableSliceSeparator bool) []string {
diff --git a/flag_bool.go b/flag_bool.go
@@ -69,7 +69,7 @@ func (b *boolValue) Set(s string) error {
 	return err
 }
 
-func (b *boolValue) Get() interface{} { return *b.destination }
+func (b *boolValue) Get() any { return *b.destination }
 
 func (b *boolValue) String() string {
 	return strconv.FormatBool(*b.destination)
diff --git a/flag_map_impl.go b/flag_map_impl.go
@@ -115,7 +115,7 @@ func (i *MapBase[T, C, VC]) Value() map[string]T {
 }
 
 // Get returns the mapping of values set by this flag
-func (i *MapBase[T, C, VC]) Get() interface{} {
+func (i *MapBase[T, C, VC]) Get() any {
 	return *i.dict
 }
 
diff --git a/flag_slice_base.go b/flag_slice_base.go
@@ -105,7 +105,7 @@ func (i *SliceBase[T, C, VC]) Value() []T {
 }
 
 // Get returns the slice of values set by this flag
-func (i *SliceBase[T, C, VC]) Get() interface{} {
+func (i *SliceBase[T, C, VC]) Get() any {
 	return *i.slice
 }
 
diff --git a/flag_test.go b/flag_test.go
@@ -36,7 +36,7 @@ func (p *Parser) String() string {
 	return fmt.Sprintf("%s,%s", p[0], p[1])
 }
 
-func (p *Parser) Get() interface{} {
+func (p *Parser) Get() any {
 	return p
 }
 
diff --git a/godoc-current.txt b/godoc-current.txt
@@ -499,7 +499,7 @@ type Command struct {
 	// default behavior.
 	ExitErrHandler ExitErrHandlerFunc `json:"-"`
 	// Other custom info
-	Metadata map[string]interface{} `json:"metadata"`
+	Metadata map[string]any `json:"metadata"`
 	// Carries a function which returns app specific info.
 	ExtraInfo func() map[string]string `json:"-"`
 	// CustomRootCommandHelpTemplate the text template for app help topic.
@@ -777,7 +777,7 @@ func (cmd *Command) UintSlice(name string) []uint
     UintSlice looks up the value of a local UintSliceFlag, returns nil if not
     found
 
-func (cmd *Command) Value(name string) interface{}
+func (cmd *Command) Value(name string) any
     Value returns the value of the flag corresponding to `name`
 
 func (cmd *Command) VisibleCategories() []CommandCategory
@@ -1225,7 +1225,7 @@ func NewMapBase[T any, C any, VC ValueCreator[T, C]](defaults map[string]T) *Map
 
 func (i MapBase[T, C, VC]) Create(val map[string]T, p *map[string]T, c C) Value
 
-func (i *MapBase[T, C, VC]) Get() interface{}
+func (i *MapBase[T, C, VC]) Get() any
     Get returns the mapping of values set by this flag
 
 func (i *MapBase[T, C, VC]) Serialize() string
@@ -1312,7 +1312,7 @@ func NewSliceBase[T any, C any, VC ValueCreator[T, C]](defaults ...T) *SliceBase
 
 func (i SliceBase[T, C, VC]) Create(val []T, p *[]T, c C) Value
 
-func (i *SliceBase[T, C, VC]) Get() interface{}
+func (i *SliceBase[T, C, VC]) Get() any
     Get returns the slice of values set by this flag
 
 func (i *SliceBase[T, C, VC]) Serialize() string
diff --git a/help.go b/help.go
@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"io"
 	"os"
+	"slices"
 	"strings"
 	"text/tabwriter"
 	"text/template"
@@ -196,10 +197,8 @@ func cliArgContains(flagName string, args []string) bool {
 			count = 2
 		}
 		flag := fmt.Sprintf("%s%s", strings.Repeat("-", count), name)
-		for _, a := range args {
-			if a == flag {
-				return true
-			}
+		if slices.Contains(args, flag) {
+			return true
 		}
 	}
 	return false
@@ -488,13 +487,11 @@ func checkShellCompleteFlag(c *Command, arguments []string) (bool, []string) {
 		return false, arguments
 	}
 
-	for _, arg := range arguments {
-		// If arguments include "--", shell completion is disabled
-		// because after "--" only positional arguments are accepted.
-		// https://unix.stackexchange.com/a/11382
-		if arg == "--" {
-			return false, arguments[:pos]
-		}
+	// If arguments include "--", shell completion is disabled
+	// because after "--" only positional arguments are accepted.
+	// https://unix.stackexchange.com/a/11382
+	if slices.Contains(arguments, "--") {
+		return false, arguments[:pos]
 	}
 
 	return true, arguments[:pos]
diff --git a/help_test.go b/help_test.go
diff --git a/mkdocs-requirements.txt b/mkdocs-requirements.txt
diff --git a/suggestions.go b/suggestions.go
diff --git a/testdata/godoc-v3.x.txt b/testdata/godoc-v3.x.txt

Original file line number	Diff line number	Diff line change
`@@ -35,21 +35,21 @@ func unquoteUsage(usage string) (string, string) {`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`func prefixedNames(names []string, placeholder string) string {`
`38`		`- var prefixed string`
	`38`	`+ var prefixed strings.Builder`
`39`	`39`	`for i, name := range names {`
`40`	`40`	`if name == "" {`
`41`	`41`	`continue`
`42`	`42`	`}`
`43`	`43`
`44`		`- prefixed += prefixFor(name) + name`
	`44`	`+ prefixed.WriteString(prefixFor(name) + name)`
`45`	`45`	`if placeholder != "" {`
`46`		`- prefixed += " " + placeholder`
	`46`	`+ prefixed.WriteString(" " + placeholder)`
`47`	`47`	`}`
`48`	`48`	`if i < len(names)-1 {`
`49`		`- prefixed += ", "`
	`49`	`+ prefixed.WriteString(", ")`
`50`	`50`	`}`
`51`	`51`	`}`
`52`		`- return prefixed`
	`52`	`+ return prefixed.String()`
`53`	`53`	`}`
`54`	`54`
`55`	`55`	`func envFormat(envVars []string, prefix, sep, suffix string) string {`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ func (b *boolValue) Set(s string) error {`
`69`	`69`	`return err`
`70`	`70`	`}`
`71`	`71`
`72`		`-func (b boolValue) Get() interface{} { return b.destination }`
	`72`	`+func (b boolValue) Get() any { return b.destination }`
`73`	`73`
`74`	`74`	`func (b *boolValue) String() string {`
`75`	`75`	`return strconv.FormatBool(*b.destination)`
Original file line number	Diff line number	Diff line change
`@@ -115,7 +115,7 @@ func (i *MapBase[T, C, VC]) Value() map[string]T {`
`115`	`115`	`}`
`116`	`116`
`117`	`117`	`// Get returns the mapping of values set by this flag`
`118`		`-func (i *MapBase[T, C, VC]) Get() interface{} {`
	`118`	`+func (i *MapBase[T, C, VC]) Get() any {`
`119`	`119`	`return *i.dict`
`120`	`120`	`}`
`121`	`121`
Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,7 @@ func (i *SliceBase[T, C, VC]) Value() []T {`
`105`	`105`	`}`
`106`	`106`
`107`	`107`	`// Get returns the slice of values set by this flag`
`108`		`-func (i *SliceBase[T, C, VC]) Get() interface{} {`
	`108`	`+func (i *SliceBase[T, C, VC]) Get() any {`
`109`	`109`	`return *i.slice`
`110`	`110`	`}`
`111`	`111`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ func (p *Parser) String() string {`
`36`	`36`	`return fmt.Sprintf("%s,%s", p[0], p[1])`
`37`	`37`	`}`
`38`	`38`
`39`		`-func (p *Parser) Get() interface{} {`
	`39`	`+func (p *Parser) Get() any {`
`40`	`40`	`return p`
`41`	`41`	`}`
`42`	`42`