Merge pull request #2214 from dearchap/def_text

Fix: Make DefaultText behaviour consistent

Author: dearchap

docs.go

@@ -107,9 +107,12 @@ func stringifyFlag(f Flag) string {
 
 	// don't print default text for required flags
 	if rf, ok := f.(RequiredFlag); !ok || !rf.IsRequired() {
-		isVisible := df.IsDefaultVisible()
-		if s := df.GetDefaultText(); isVisible && s != "" {
-			defaultValueString = fmt.Sprintf(formatDefault("%s"), s)
+		if df.IsDefaultVisible() {
+			if s := df.GetDefaultText(); s != "" {
+				defaultValueString = fmt.Sprintf(formatDefault("%s"), s)
+			} else if df.TakesValue() && df.GetValue() != "" {
+				defaultValueString = fmt.Sprintf(formatDefault("%s"), df.GetValue())
+			}
 		}
 	}
 

flag_impl.go

@@ -70,10 +70,8 @@ type FlagBase[T any, C any, VC ValueCreator[T, C]] struct {
 // GetValue returns the flags value as string representation and an empty
 // string if the flag takes no value at all.
 func (f *FlagBase[T, C, V]) GetValue() string {
-	if !f.TakesValue() {
-		return ""
-	}
-	return fmt.Sprintf("%v", f.Value)
+	var v V
+	return v.ToString(f.Value)
 }
 
 // TypeName returns the type of the flag.
@@ -253,11 +251,7 @@ func (f *FlagBase[T, C, V]) TakesValue() bool {
 
 // GetDefaultText returns the default text for this flag
 func (f *FlagBase[T, C, V]) GetDefaultText() string {
-	if f.DefaultText != "" {
-		return f.DefaultText
-	}
-	var v V
-	return v.ToString(f.Value)
+	return f.DefaultText
 }
 
 // RunAction executes flag action if set

flag_test.go

@@ -44,8 +44,8 @@ var boolFlagTests = []struct {
 	name     string
 	expected string
 }{
-	{"help", "--help\t(default: false)"},
-	{"h", "-h\t(default: false)"},
+	{"help", "--help\t"},
+	{"h", "-h\t"},
 }
 
 func TestBoolFlagHelpOutput(t *testing.T) {
@@ -470,7 +470,7 @@ func TestFlagStringifying(t *testing.T) {
 		{
 			name:     "bool-flag",
 			fl:       &BoolFlag{Name: "vividly"},
-			expected: "--vividly\t(default: false)",
+			expected: "--vividly\t",
 		},
 		{
 			name:     "bool-flag-with-default-text",
@@ -2771,7 +2771,7 @@ func TestFlagDefaultValue(t *testing.T) {
 			name:    "bool",
 			flag:    &BoolFlag{Name: "flag", Value: true},
 			toParse: []string{"--flag=false"},
-			expect:  `--flag	(default: true)`,
+			expect:  `--flag	`,
 		},
 		{
 			name:    "uint",
@@ -2866,7 +2866,7 @@ func TestFlagDefaultValueWithEnv(t *testing.T) {
 			name:    "bool",
 			flag:    &BoolFlag{Name: "flag", Value: true, Sources: EnvVars("uflag")},
 			toParse: []string{"--flag=false"},
-			expect:  `--flag	(default: true)` + withEnvHint([]string{"uflag"}, ""),
+			expect:  `--flag	` + withEnvHint([]string{"uflag"}, ""),
 			environ: map[string]string{
 				"uflag": "false",
 			},
@@ -3359,9 +3359,9 @@ func TestEnvHintWindows(t *testing.T) {
 }
 
 func TestDocGetValue(t *testing.T) {
-	assert.Equal(t, "", (&BoolFlag{Name: "foo", Value: true}).GetValue())
-	assert.Equal(t, "", (&BoolFlag{Name: "foo", Value: false}).GetValue())
-	assert.Equal(t, "bar", (&StringFlag{Name: "foo", Value: "bar"}).GetValue())
+	assert.Equal(t, "true", (&BoolFlag{Name: "foo", Value: true}).GetValue())
+	assert.Equal(t, "false", (&BoolFlag{Name: "foo", Value: false}).GetValue())
+	assert.Equal(t, "\"bar\"", (&StringFlag{Name: "foo", Value: "bar"}).GetValue())
 	assert.Equal(t, "", (&BoolWithInverseFlag{Name: "foo", Value: false}).GetValue())
 }
 

help_test.go

@@ -1479,8 +1479,7 @@ GLOBAL OPTIONS:
       really long help text
       line, let's see where it
       wraps. blah blah blah
-      and so on. (default:
-      false)
+      and so on.
 
 COPYRIGHT:
    Here's a sample copyright