Add hashmap type show. And fix some print

If flag is StringMapFlag ,it will print `--property string=string [--property string=string]…` Signed-off-by: jokemanfire <[email protected]>
urfave · Jan 15, 2025 · 0baf377 · 0baf377
1 parent 3043a47
commit 0baf377
Show file tree

Hide file tree

Showing 6 changed files with 112 additions and 96 deletions.
diff --git a/flag.go b/flag.go
@@ -142,6 +142,8 @@ type DocGenerationFlag interface {
 	// IsDefaultVisible returns whether the default value should be shown in
 	// help text
 	IsDefaultVisible() bool
+	// TypeName to detect if a flag is a string, bool, etc.
+	TypeName() string
 }
 
 // DocGenerationMultiValueFlag extends DocGenerationFlag for slice/map based flags.
@@ -180,11 +182,6 @@ type LocalFlag interface {
 	IsLocal() bool
 }
 
-// FlagType is an interface to detect if a flag is a string, bool, etc.
-type FlagType interface {
-	GetFlagType() string
-}
-
 func newFlagSet(name string, flags []Flag) (*flag.FlagSet, error) {
 	set := flag.NewFlagSet(name, flag.ContinueOnError)
 
@@ -312,8 +309,8 @@ func stringifyFlag(f Flag) string {
 	// if needsPlaceholder is true, placeholder is empty
 	if needsPlaceholder && placeholder == "" {
 		// try to get type from flag
-		if v1, ok := f.(FlagType); ok && v1.GetFlagType() != "" {
-			placeholder = v1.GetFlagType()
+		if tname := df.TypeName(); tname != "" {
+			placeholder = tname
 		} else {
 			placeholder = defaultPlaceholder
 		}

diff --git a/flag_impl.go b/flag_impl.go
@@ -5,6 +5,7 @@ import (
 	"flag"
 	"fmt"
 	"reflect"
+	"strings"
 )
 
 // Value represents a value as used by cli.
@@ -98,18 +99,40 @@ func (f *FlagBase[T, C, V]) GetValue() string {
 	return fmt.Sprintf("%v", f.Value)
 }
 
-// GetFlagType returns the type of the flag.
-func (f *FlagBase[T, C, V]) GetFlagType() string {
+// TypeName returns the type of the flag.
+func (f *FlagBase[T, C, V]) TypeName() string {
 	ty := reflect.TypeOf(f.Value)
 	if ty == nil {
 		return ""
 	}
+	// convert the typename to generic type
+	convertToGenericType := func(name string) string {
+		prefixMap := map[string]string{
+			"float": "float",
+			"int":   "int",
+			"uint":  "uint",
+		}
+		for prefix, genericType := range prefixMap {
+			if strings.HasPrefix(name, prefix) {
+				return genericType
+			}
+		}
+		return strings.ToLower(name)
+	}
+
+	switch ty.Kind() {
 	// if it is a Slice, then return the slice's inner type. Will nested slices be used in the future?
-	if ty.Kind() == reflect.Slice {
+	case reflect.Slice:
 		elemType := ty.Elem()
-		return elemType.Name()
+		return convertToGenericType(elemType.Name())
+	// if it is a Map, then return the map's key and value types.
+	case reflect.Map:
+		keyType := ty.Key()
+		valueType := ty.Elem()
+		return fmt.Sprintf("%s=%s", convertToGenericType(keyType.Name()), convertToGenericType(valueType.Name()))
+	default:
+		return convertToGenericType(ty.Name())
 	}
-	return ty.Name()
 }
 
 // Apply populates the flag given the flag set and environment