Add hashmap type show.

If flag is StringMapFlag ,it will print
`--property string=string [--property string=string]…`

Signed-off-by: jokemanfire <[email protected]>

flag.go

@@ -182,7 +182,7 @@ type LocalFlag interface {
 
 // FlagType is an interface to detect if a flag is a string, bool, etc.
 type FlagType interface {
-	GetFlagType() string
+	TypeName() string
 }
 
 func newFlagSet(name string, flags []Flag) (*flag.FlagSet, error) {
@@ -312,8 +312,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 ft, ok := f.(FlagType); ok && ft.TypeName() != "" {
+			placeholder = ft.TypeName()
 		} else {
 			placeholder = defaultPlaceholder
 		}

flag_impl.go

@@ -98,18 +98,25 @@ 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 ""
 	}
+	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()
+	// 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", keyType.Name(), valueType.Name())
+	default:
+		return ty.Name()
 	}
-	return ty.Name()
 }
 
 // Apply populates the flag given the flag set and environment

flag_test.go

@@ -2706,7 +2706,7 @@ func TestFlagDefaultValue(t *testing.T) {
 			name:    "stringMap",
 			flag:    &StringMapFlag{Name: "flag", Value: map[string]string{"default1": "default2"}},
 			toParse: []string{"--flag", "parsed="},
-			expect:  `--flag value [ --flag value ]	(default: default1="default2")`,
+			expect:  `--flag string=string [ --flag string=string ]	(default: default1="default2")`,
 		},
 	}
 	for _, v := range cases {
@@ -2845,7 +2845,7 @@ func TestFlagDefaultValueWithEnv(t *testing.T) {
 			name:    "stringMap",
 			flag:    &StringMapFlag{Name: "flag", Value: map[string]string{"default1": "default2"}, Sources: EnvVars("ssflag")},
 			toParse: []string{"--flag", "parsed="},
-			expect:  `--flag value [ --flag value ]	(default: default1="default2")` + withEnvHint([]string{"ssflag"}, ""),
+			expect:  `--flag string=string [ --flag string=string ]	(default: default1="default2")` + withEnvHint([]string{"ssflag"}, ""),
 			environ: map[string]string{
 				"ssflag": "some-other-env_value=",
 			},
@@ -3007,11 +3007,11 @@ var stringMapFlagTests = []struct {
 	value    map[string]string
 	expected string
 }{
-	{"foo", nil, nil, "--foo value [ --foo value ]\t"},
-	{"f", nil, nil, "-f value [ -f value ]\t"},
-	{"f", nil, map[string]string{"Lipstick": ""}, "-f value [ -f value ]\t(default: Lipstick=)"},
-	{"test", nil, map[string]string{"Something": ""}, "--test value [ --test value ]\t(default: Something=)"},
-	{"dee", []string{"d"}, map[string]string{"Inka": "Dinka", "dooo": ""}, "--dee value, -d value [ --dee value, -d value ]\t(default: Inka=\"Dinka\", dooo=)"},
+	{"foo", nil, nil, "--foo string=string [ --foo string=string ]\t"},
+	{"f", nil, nil, "-f string=string [ -f string=string ]\t"},
+	{"f", nil, map[string]string{"Lipstick": ""}, "-f string=string [ -f string=string ]\t(default: Lipstick=)"},
+	{"test", nil, map[string]string{"Something": ""}, "--test string=string [ --test string=string ]\t(default: Something=)"},
+	{"dee", []string{"d"}, map[string]string{"Inka": "Dinka", "dooo": ""}, "--dee string=string, -d string=string [ --dee string=string, -d string=string ]\t(default: Inka=\"Dinka\", dooo=)"},
 }
 
 func TestStringMapFlagHelpOutput(t *testing.T) {

godoc-current.txt

@@ -705,9 +705,6 @@ func (f *FlagBase[T, C, V]) GetDefaultText() string
 func (f *FlagBase[T, C, V]) GetEnvVars() []string
     GetEnvVars returns the env vars for this flag
 
-func (f *FlagBase[T, C, V]) GetFlagType() string
-    GetFlagType returns the type of the flag.
-
 func (f *FlagBase[T, C, V]) GetUsage() string
     GetUsage returns the usage string for the flag
 
@@ -748,6 +745,9 @@ func (f *FlagBase[T, C, V]) String() string
 func (f *FlagBase[T, C, V]) TakesValue() bool
     TakesValue returns true if the flag takes a value, otherwise false
 
+func (f *FlagBase[T, C, V]) TypeName() string
+    TypeName returns the type of the flag.
+
 type FlagCategories interface {
 	// AddFlags adds a flag to a category, creating a new category if necessary.
 	AddFlag(category string, fl Flag)
@@ -789,7 +789,7 @@ var FlagStringer FlagStringFunc = stringifyFlag
     display a flag.
 
 type FlagType interface {
-	GetFlagType() string
+	TypeName() string
 }
     FlagType is an interface to detect if a flag is a string, bool, etc.
 

testdata/godoc-v3.x.txt

@@ -705,8 +705,8 @@ func (f *FlagBase[T, C, V]) GetDefaultText() string
 func (f *FlagBase[T, C, V]) GetEnvVars() []string
     GetEnvVars returns the env vars for this flag
 
-func (f *FlagBase[T, C, V]) GetFlagType() string
-    GetFlagType returns the type of the flag.
+func (f *FlagBase[T, C, V]) TypeName() string
+    TypeName returns the type of the flag.
 
 func (f *FlagBase[T, C, V]) GetUsage() string
     GetUsage returns the usage string for the flag
@@ -789,7 +789,7 @@ var FlagStringer FlagStringFunc = stringifyFlag
     display a flag.
 
 type FlagType interface {
-	GetFlagType() string
+	TypeName() string
 }
     FlagType is an interface to detect if a flag is a string, bool, etc.