Merge pull request #1825 from dearchap/issue_1689

Fix:(issue_1689) Have consistent behavior for default text in man and…
urfave · Nov 30, 2023 · 0e5f95d · 0e5f95d
2 parents 488e77c + 92aa673
commit 0e5f95d
Show file tree

Hide file tree

Showing 13 changed files with 106 additions and 34 deletions.
diff --git a/cmd/urfave-cli-genflags/generated.gotmpl b/cmd/urfave-cli-genflags/generated.gotmpl
@@ -23,6 +23,7 @@ type {{.TypeName}} struct {
 	EnvVars []string
 
 	defaultValue {{if .ValuePointer}}*{{end}}{{.GoType}}
+	defaultValueSet bool
 {{ range .StructFields}}
 	{{.Name}} {{if .Pointer}}*{{end}}{{.Type}}
 {{end -}}

diff --git a/flag_bool.go b/flag_bool.go
@@ -84,7 +84,10 @@ func (f *BoolFlag) GetDefaultText() string {
 	if f.DefaultText != "" {
 		return f.DefaultText
 	}
-	return fmt.Sprintf("%v", f.defaultValue)
+	if f.defaultValueSet {
+		return fmt.Sprintf("%v", f.defaultValue)
+	}
+	return fmt.Sprintf("%v", f.Value)
 }
 
 // GetEnvVars returns the env vars for this flag
@@ -105,6 +108,7 @@ func (f *BoolFlag) RunAction(c *Context) error {
 func (f *BoolFlag) Apply(set *flag.FlagSet) error {
 	// set default value so that environment wont be able to overwrite it
 	f.defaultValue = f.Value
+	f.defaultValueSet = true
 
 	if val, source, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found {
 		if val != "" {

diff --git a/flag_duration.go b/flag_duration.go
@@ -32,7 +32,10 @@ func (f *DurationFlag) GetDefaultText() string {
 	if f.DefaultText != "" {
 		return f.DefaultText
 	}
-	return f.defaultValue.String()
+	if f.defaultValueSet {
+		return f.defaultValue.String()
+	}
+	return f.Value.String()
 }
 
 // GetEnvVars returns the env vars for this flag
@@ -44,6 +47,7 @@ func (f *DurationFlag) GetEnvVars() []string {
 func (f *DurationFlag) Apply(set *flag.FlagSet) error {
 	// set default value so that environment wont be able to overwrite it
 	f.defaultValue = f.Value
+	f.defaultValueSet = true
 
 	if val, source, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found {
 		if val != "" {

diff --git a/flag_float64.go b/flag_float64.go
@@ -32,7 +32,10 @@ func (f *Float64Flag) GetDefaultText() string {
 	if f.DefaultText != "" {
 		return f.DefaultText
 	}
-	return f.GetValue()
+	if f.defaultValueSet {
+		return fmt.Sprintf("%v", f.defaultValue)
+	}
+	return fmt.Sprintf("%v", f.Value)
 }
 
 // GetEnvVars returns the env vars for this flag
@@ -42,6 +45,9 @@ func (f *Float64Flag) GetEnvVars() []string {
 
 // Apply populates the flag given the flag set and environment
 func (f *Float64Flag) Apply(set *flag.FlagSet) error {
+	f.defaultValue = f.Value
+	f.defaultValueSet = true
+
 	if val, source, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found {
 		if val != "" {
 			valFloat, err := strconv.ParseFloat(val, 64)

diff --git a/flag_generic.go b/flag_generic.go
@@ -53,9 +53,15 @@ func (f *GenericFlag) GetDefaultText() string {
 	if f.DefaultText != "" {
 		return f.DefaultText
 	}
-	if f.defaultValue != nil {
-		return f.defaultValue.String()
+	val := f.Value
+	if f.defaultValueSet {
+		val = f.defaultValue
 	}
+
+	if val != nil {
+		return val.String()
+	}
+
 	return ""
 }
 
@@ -70,6 +76,7 @@ func (f *GenericFlag) Apply(set *flag.FlagSet) error {
 	// set default value so that environment wont be able to overwrite it
 	if f.Value != nil {
 		f.defaultValue = &stringGeneric{value: f.Value.String()}
+		f.defaultValueSet = true
 	}
 
 	if val, source, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found {

diff --git a/flag_int.go b/flag_int.go
@@ -32,7 +32,10 @@ func (f *IntFlag) GetDefaultText() string {
 	if f.DefaultText != "" {
 		return f.DefaultText
 	}
-	return fmt.Sprintf("%d", f.defaultValue)
+	if f.defaultValueSet {
+		return fmt.Sprintf("%d", f.defaultValue)
+	}
+	return fmt.Sprintf("%d", f.Value)
 }
 
 // GetEnvVars returns the env vars for this flag
@@ -44,6 +47,7 @@ func (f *IntFlag) GetEnvVars() []string {
 func (f *IntFlag) Apply(set *flag.FlagSet) error {
 	// set default value so that environment wont be able to overwrite it
 	f.defaultValue = f.Value
+	f.defaultValueSet = true
 
 	if val, source, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found {
 		if val != "" {

diff --git a/flag_int64.go b/flag_int64.go
@@ -32,7 +32,10 @@ func (f *Int64Flag) GetDefaultText() string {
 	if f.DefaultText != "" {
 		return f.DefaultText
 	}
-	return fmt.Sprintf("%d", f.defaultValue)
+	if f.defaultValueSet {
+		return fmt.Sprintf("%d", f.defaultValue)
+	}
+	return fmt.Sprintf("%d", f.Value)
 }
 
 // GetEnvVars returns the env vars for this flag
@@ -44,6 +47,7 @@ func (f *Int64Flag) GetEnvVars() []string {
 func (f *Int64Flag) Apply(set *flag.FlagSet) error {
 	// set default value so that environment wont be able to overwrite it
 	f.defaultValue = f.Value
+	f.defaultValueSet = true
 
 	if val, source, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found {
 		if val != "" {

diff --git a/flag_path.go b/flag_path.go
@@ -33,10 +33,14 @@ func (f *PathFlag) GetDefaultText() string {
 	if f.DefaultText != "" {
 		return f.DefaultText
 	}
-	if f.defaultValue == "" {
-		return f.defaultValue
+	val := f.Value
+	if f.defaultValueSet {
+		val = f.defaultValue
 	}
-	return fmt.Sprintf("%q", f.defaultValue)
+	if val == "" {
+		return val
+	}
+	return fmt.Sprintf("%q", val)
 }
 
 // GetEnvVars returns the env vars for this flag
@@ -48,6 +52,7 @@ func (f *PathFlag) GetEnvVars() []string {
 func (f *PathFlag) Apply(set *flag.FlagSet) error {
 	// set default value so that environment wont be able to overwrite it
 	f.defaultValue = f.Value
+	f.defaultValueSet = true
 
 	if val, _, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found {
 		f.Value = val

diff --git a/flag_string.go b/flag_string.go
@@ -31,10 +31,15 @@ func (f *StringFlag) GetDefaultText() string {
 	if f.DefaultText != "" {
 		return f.DefaultText
 	}
-	if f.defaultValue == "" {
-		return f.defaultValue
+	val := f.Value
+	if f.defaultValueSet {
+		val = f.defaultValue
 	}
-	return fmt.Sprintf("%q", f.defaultValue)
+
+	if val == "" {
+		return val
+	}
+	return fmt.Sprintf("%q", val)
 }
 
 // GetEnvVars returns the env vars for this flag
@@ -46,6 +51,7 @@ func (f *StringFlag) GetEnvVars() []string {
 func (f *StringFlag) Apply(set *flag.FlagSet) error {
 	// set default value so that environment wont be able to overwrite it
 	f.defaultValue = f.Value
+	f.defaultValueSet = true
 
 	if val, _, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found {
 		f.Value = val

diff --git a/flag_timestamp.go b/flag_timestamp.go
@@ -120,8 +120,13 @@ func (f *TimestampFlag) GetDefaultText() string {
 	if f.DefaultText != "" {
 		return f.DefaultText
 	}
-	if f.defaultValue != nil && f.defaultValue.timestamp != nil {
-		return f.defaultValue.timestamp.String()
+	val := f.Value
+	if f.defaultValueSet {
+		val = f.defaultValue
+	}
+
+	if val != nil && val.timestamp != nil {
+		return val.timestamp.String()
 	}
 
 	return ""
@@ -144,6 +149,7 @@ func (f *TimestampFlag) Apply(set *flag.FlagSet) error {
 	f.Value.SetLocation(f.Timezone)
 
 	f.defaultValue = f.Value.clone()
+	f.defaultValueSet = true
 
 	if val, source, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found {
 		if err := f.Value.Set(val); err != nil {

diff --git a/flag_uint.go b/flag_uint.go
@@ -25,6 +25,7 @@ func (f *UintFlag) GetCategory() string {
 func (f *UintFlag) Apply(set *flag.FlagSet) error {
 	// set default value so that environment wont be able to overwrite it
 	f.defaultValue = f.Value
+	f.defaultValueSet = true
 
 	if val, source, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found {
 		if val != "" {
@@ -69,7 +70,10 @@ func (f *UintFlag) GetDefaultText() string {
 	if f.DefaultText != "" {
 		return f.DefaultText
 	}
-	return fmt.Sprintf("%d", f.defaultValue)
+	if f.defaultValueSet {
+		return fmt.Sprintf("%d", f.defaultValue)
+	}
+	return fmt.Sprintf("%d", f.Value)
 }
 
 // GetEnvVars returns the env vars for this flag

diff --git a/flag_uint64.go b/flag_uint64.go
@@ -25,6 +25,7 @@ func (f *Uint64Flag) GetCategory() string {
 func (f *Uint64Flag) Apply(set *flag.FlagSet) error {
 	// set default value so that environment wont be able to overwrite it
 	f.defaultValue = f.Value
+	f.defaultValueSet = true
 
 	if val, source, found := flagFromEnvOrFile(f.EnvVars, f.FilePath); found {
 		if val != "" {
@@ -69,7 +70,10 @@ func (f *Uint64Flag) GetDefaultText() string {
 	if f.DefaultText != "" {
 		return f.DefaultText
 	}
-	return fmt.Sprintf("%d", f.defaultValue)
+	if f.defaultValueSet {
+		return fmt.Sprintf("%d", f.defaultValue)
+	}
+	return fmt.Sprintf("%d", f.Value)
 }
 
 // GetEnvVars returns the env vars for this flag