Skip to content

Commit ec05a8d

Browse files
committed
Ensure flag "Name" field values are un-stringly-fied
to (hopefully) help with bug triage & pinpointing usage issues since ripping out stringly typed "Name".
1 parent 685865d commit ec05a8d

1 file changed

Lines changed: 27 additions & 17 deletions

File tree

‎flag.go‎

Lines changed: 27 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import (
66
"fmt"
77
"os"
88
"reflect"
9+
"regexp"
910
"runtime"
1011
"strconv"
1112
"strings"
@@ -14,7 +15,11 @@ import (
1415

1516
const defaultPlaceholder = "value"
1617

17-
var slPfx = fmt.Sprintf("sl:::%d:::", time.Now().UTC().UnixNano())
18+
var (
19+
slPfx = fmt.Sprintf("sl:::%d:::", time.Now().UTC().UnixNano())
20+
21+
commaWhitespace = regexp.MustCompile("[, ]+.*")
22+
)
1823

1924
// BashCompletionFlag enables bash-completion for all commands and subcommands
2025
var BashCompletionFlag = BoolFlag{
@@ -95,7 +100,6 @@ func (f GenericFlag) Apply(set *flag.FlagSet) {
95100
val := f.Value
96101
if f.EnvVars != nil {
97102
for _, envVar := range f.EnvVars {
98-
envVar = strings.TrimSpace(envVar)
99103
if envVal := os.Getenv(envVar); envVal != "" {
100104
val.Set(envVal)
101105
break
@@ -110,7 +114,7 @@ func (f GenericFlag) Apply(set *flag.FlagSet) {
110114

111115
// Names returns the names of a flag.
112116
func (f GenericFlag) Names() []string {
113-
return append([]string{f.Name}, f.Aliases...)
117+
return flagNames(f)
114118
}
115119

116120
// StringSlice wraps a []string to satisfy flag.Value
@@ -178,7 +182,6 @@ func (f StringSliceFlag) String() string {
178182
func (f StringSliceFlag) Apply(set *flag.FlagSet) {
179183
if f.EnvVars != nil {
180184
for _, envVar := range f.EnvVars {
181-
envVar = strings.TrimSpace(envVar)
182185
if envVal := os.Getenv(envVar); envVal != "" {
183186
newVal := NewStringSlice()
184187
for _, s := range strings.Split(envVal, ",") {
@@ -202,7 +205,7 @@ func (f StringSliceFlag) Apply(set *flag.FlagSet) {
202205

203206
// Names returns the name of a flag.
204207
func (f StringSliceFlag) Names() []string {
205-
return append([]string{f.Name}, f.Aliases...)
208+
return flagNames(f)
206209
}
207210

208211
// IntSlice wraps an []int to satisfy flag.Value
@@ -285,7 +288,6 @@ func (f IntSliceFlag) String() string {
285288
func (f IntSliceFlag) Apply(set *flag.FlagSet) {
286289
if f.EnvVars != nil {
287290
for _, envVar := range f.EnvVars {
288-
envVar = strings.TrimSpace(envVar)
289291
if envVal := os.Getenv(envVar); envVal != "" {
290292
newVal := NewIntSlice()
291293
for _, s := range strings.Split(envVal, ",") {
@@ -312,7 +314,7 @@ func (f IntSliceFlag) Apply(set *flag.FlagSet) {
312314

313315
// Names returns the name of the flag.
314316
func (f IntSliceFlag) Names() []string {
315-
return append([]string{f.Name}, f.Aliases...)
317+
return flagNames(f)
316318
}
317319

318320
// BoolFlag is a switch that defaults to false
@@ -335,7 +337,6 @@ func (f BoolFlag) String() string {
335337
func (f BoolFlag) Apply(set *flag.FlagSet) {
336338
if f.EnvVars != nil {
337339
for _, envVar := range f.EnvVars {
338-
envVar = strings.TrimSpace(envVar)
339340
if envVal := os.Getenv(envVar); envVal != "" {
340341
envValBool, err := strconv.ParseBool(envVal)
341342
if err == nil {
@@ -357,7 +358,7 @@ func (f BoolFlag) Apply(set *flag.FlagSet) {
357358

358359
// Names returns the name of the flag.
359360
func (f BoolFlag) Names() []string {
360-
return append([]string{f.Name}, f.Aliases...)
361+
return flagNames(f)
361362
}
362363

363364
// StringFlag represents a flag that takes as string value
@@ -380,7 +381,6 @@ func (f StringFlag) String() string {
380381
func (f StringFlag) Apply(set *flag.FlagSet) {
381382
if f.EnvVars != nil {
382383
for _, envVar := range f.EnvVars {
383-
envVar = strings.TrimSpace(envVar)
384384
if envVal := os.Getenv(envVar); envVal != "" {
385385
f.Value = envVal
386386
break
@@ -399,7 +399,7 @@ func (f StringFlag) Apply(set *flag.FlagSet) {
399399

400400
// Names returns the name of the flag.
401401
func (f StringFlag) Names() []string {
402-
return append([]string{f.Name}, f.Aliases...)
402+
return flagNames(f)
403403
}
404404

405405
// IntFlag is a flag that takes an integer
@@ -423,7 +423,6 @@ func (f IntFlag) String() string {
423423
func (f IntFlag) Apply(set *flag.FlagSet) {
424424
if f.EnvVars != nil {
425425
for _, envVar := range f.EnvVars {
426-
envVar = strings.TrimSpace(envVar)
427426
if envVal := os.Getenv(envVar); envVal != "" {
428427
envValInt, err := strconv.ParseInt(envVal, 0, 64)
429428
if err == nil {
@@ -445,7 +444,7 @@ func (f IntFlag) Apply(set *flag.FlagSet) {
445444

446445
// Names returns the name of the flag.
447446
func (f IntFlag) Names() []string {
448-
return append([]string{f.Name}, f.Aliases...)
447+
return flagNames(f)
449448
}
450449

451450
// DurationFlag is a flag that takes a duration specified in Go's duration
@@ -469,7 +468,6 @@ func (f DurationFlag) String() string {
469468
func (f DurationFlag) Apply(set *flag.FlagSet) {
470469
if f.EnvVars != nil {
471470
for _, envVar := range f.EnvVars {
472-
envVar = strings.TrimSpace(envVar)
473471
if envVal := os.Getenv(envVar); envVal != "" {
474472
envValDuration, err := time.ParseDuration(envVal)
475473
if err == nil {
@@ -491,7 +489,7 @@ func (f DurationFlag) Apply(set *flag.FlagSet) {
491489

492490
// Names returns the name of the flag.
493491
func (f DurationFlag) Names() []string {
494-
return append([]string{f.Name}, f.Aliases...)
492+
return flagNames(f)
495493
}
496494

497495
// Float64Flag is a flag that takes an float value
@@ -515,7 +513,6 @@ func (f Float64Flag) String() string {
515513
func (f Float64Flag) Apply(set *flag.FlagSet) {
516514
if f.EnvVars != nil {
517515
for _, envVar := range f.EnvVars {
518-
envVar = strings.TrimSpace(envVar)
519516
if envVal := os.Getenv(envVar); envVal != "" {
520517
envValFloat, err := strconv.ParseFloat(envVal, 10)
521518
if err == nil {
@@ -536,7 +533,7 @@ func (f Float64Flag) Apply(set *flag.FlagSet) {
536533

537534
// Names returns the name of the flag.
538535
func (f Float64Flag) Names() []string {
539-
return append([]string{f.Name}, f.Aliases...)
536+
return flagNames(f)
540537
}
541538

542539
func visibleFlags(fl []Flag) []Flag {
@@ -610,6 +607,19 @@ func withEnvHint(envVars []string, str string) string {
610607
return str + envText
611608
}
612609

610+
func flagNames(f Flag) []string {
611+
ret := []string{}
612+
613+
name := flagStringField(f, "Name")
614+
aliases := flagStringSliceField(f, "Aliases")
615+
616+
for _, part := range append([]string{name}, aliases...) {
617+
ret = append(ret, commaWhitespace.ReplaceAllString(part, ""))
618+
}
619+
620+
return ret
621+
}
622+
613623
func flagStringSliceField(f Flag, name string) []string {
614624
fv := flagValue(f)
615625
field := fv.FieldByName(name)

0 commit comments

Comments
 (0)