Skip to content

fix: honor BoolWithInverseFlag DefaultText #2403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dearchap merged 1 commit into from
Aug 15, 2026
+12 −1
Merged

fix: honor BoolWithInverseFlag DefaultText #2403

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion flag_bool_with_inverse.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ func (bif *BoolWithInverseFlag) Count() int {

// GetDefaultText returns the default text for this flag
func (bif *BoolWithInverseFlag) GetDefaultText() string {
if bif.Required {
if bif.DefaultText != "" {
return bif.DefaultText
}
return boolValue{}.ToString(bif.Value)
Expand Down
6 changes: 6 additions & 0 deletions flag_bool_with_inverse_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,12 @@ func TestBoolWithInverseNames(t *testing.T) {
require.Equal(t, "bool", d.TypeName())
}

func TestBoolWithInverseDefaultText(t *testing.T) {
require.Equal(t, "false", (&BoolWithInverseFlag{}).GetDefaultText())
require.Equal(t, "true", (&BoolWithInverseFlag{Value: true}).GetDefaultText())
require.Equal(t, "auto", (&BoolWithInverseFlag{DefaultText: "auto"}).GetDefaultText())
}

func TestBoolWithInverseString(t *testing.T) {
tcs := []struct {
testName string
Expand Down
5 changes: 5 additions & 0 deletions flag_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -482,6 +482,11 @@ func TestFlagStringifying(t *testing.T) {
fl: &BoolWithInverseFlag{Name: "vividly"},
expected: "--vividly, --no-vividly\t(default: false)",
},
{
name: "bool-inv-flag-with-default-text",
fl: &BoolWithInverseFlag{Name: "vividly", DefaultText: "auto"},
expected: "--vividly, --no-vividly\t(default: auto)",
},
{
name: "duration-flag",
fl: &DurationFlag{Name: "scream-for"},
Expand Down