Skip to content

Commit

Permalink
Refactor '(default: …)' flag string into utility function
Browse files Browse the repository at this point in the history
The usage of the `(default: …)` strings are a bit error prone so we now
refactor them into a dedicated helper function.

Signed-off-by: Sascha Grunert <sgrunert@suse.com>
  • Loading branch information
saschagrunert committed Mar 2, 2020
1 parent 573004a commit 7742363
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions flag.go
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,10 @@ func flagValue(f Flag) reflect.Value {
return fv
}

func formatDefault(format string) string {
return " (default: " + format + ")"
}

func stringifyFlag(f Flag) string {
fv := flagValue(f)

Expand All @@ -269,20 +273,20 @@ func stringifyFlag(f Flag) string {
val := fv.FieldByName("Value")
if val.IsValid() {
needsPlaceholder = val.Kind() != reflect.Bool
defaultValueString = fmt.Sprintf(" (default: %v)", val.Interface())
defaultValueString = fmt.Sprintf(formatDefault("%v"), val.Interface())

if val.Kind() == reflect.String && val.String() != "" {
defaultValueString = fmt.Sprintf(" (default: %q)", val.String())
defaultValueString = fmt.Sprintf(formatDefault("%q"), val.String())
}
}

helpText := fv.FieldByName("DefaultText")
if helpText.IsValid() && helpText.String() != "" {
needsPlaceholder = val.Kind() != reflect.Bool
defaultValueString = fmt.Sprintf(" (default: %s)", helpText.String())
defaultValueString = fmt.Sprintf(formatDefault("%s"), helpText.String())
}

if defaultValueString == " (default: )" {
if defaultValueString == formatDefault("") {
defaultValueString = ""
}

Expand Down Expand Up @@ -351,7 +355,7 @@ func stringifySliceFlag(usage string, names, defaultVals []string) string {

defaultVal := ""
if len(defaultVals) > 0 {
defaultVal = fmt.Sprintf(" (default: %s)", strings.Join(defaultVals, ", "))
defaultVal = fmt.Sprintf(formatDefault("%s"), strings.Join(defaultVals, ", "))
}

usageWithDefault := strings.TrimSpace(fmt.Sprintf("%s%s", usage, defaultVal))
Expand Down

0 comments on commit 7742363

Please sign in to comment.