Skip to content

Commit dfe3bbd

Browse files
CLOUDP-230973: Print 'string' as type for 'stringToString' (#51)
1 parent 68bd86f commit dfe3bbd

File tree

2 files changed

+17
-1
lines changed

2 files changed

+17
-1
lines changed

cobra2snooty_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ func TestGenDocs(t *testing.T) {
142142
checkStringOmits(t, output, deprecatedCmd.Short)
143143

144144
// Verify that the text "This value defaults to" is not printed when the default value is provided to StringToStringP
145-
checkStringContains(t, output, "* - -x, --stringtostring\n - stringToString\n - false\n - help message for flag stringtostring\n *")
145+
checkStringContains(t, output, "* - -x, --stringtostring\n - string\n - false\n - help message for flag stringtostring\n *")
146146
}
147147

148148
func TestGenDocsNoHiddenParents(t *testing.T) {

flags.go

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,12 @@ const (
3131
nilValue = "<nil>"
3232
)
3333

34+
var (
35+
varnameMap = map[string]string{
36+
"stringToString": "string",
37+
}
38+
)
39+
3440
func FlagUsages(f *pflag.FlagSet) string {
3541
buf := new(bytes.Buffer)
3642

@@ -41,6 +47,7 @@ func FlagUsages(f *pflag.FlagSet) string {
4147

4248
line := ""
4349
varname, usage := pflag.UnquoteUsage(flag)
50+
varname = mapVarname(varname)
4451
const defaultIndentation = 6
4552
usage = strings.ReplaceAll(usage, "\n", "\n"+strings.Repeat(" ", defaultIndentation))
4653

@@ -132,3 +139,12 @@ func defaultIsZeroValue(f *pflag.Flag) bool {
132139
return false
133140
}
134141
}
142+
143+
func mapVarname(varname string) string {
144+
mapped, found := varnameMap[varname]
145+
if !found {
146+
return varname
147+
}
148+
149+
return mapped
150+
}

0 commit comments

Comments
 (0)