Skip to content
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.

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

FIx: Allow ext flags to be opt-out by default rather than opt-in #1561

Merged
merged 1 commit into from Nov 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 12 additions & 7 deletions app.go
Expand Up @@ -113,6 +113,9 @@ type App struct {
UseShortOptionHandling bool
// Enable suggestions for commands and flags
Suggest bool
// Allows global flags set by libraries which use flag.XXXVar(...) directly
// to be parsed through this library
AllowExtFlags bool

didSetup bool

Expand Down Expand Up @@ -199,13 +202,15 @@ func (a *App) Setup() {
a.ErrWriter = os.Stderr
}

// add global flags added by other packages
flag.VisitAll(func(f *flag.Flag) {
// skip test flags
if !strings.HasPrefix(f.Name, ignoreFlagPrefix) {
a.Flags = append(a.Flags, &extFlag{f})
}
})
if a.AllowExtFlags {
// add global flags added by other packages
flag.VisitAll(func(f *flag.Flag) {
// skip test flags
if !strings.HasPrefix(f.Name, ignoreFlagPrefix) {
a.Flags = append(a.Flags, &extFlag{f})
}
})
}

var newCommands []*Command

Expand Down
23 changes: 23 additions & 0 deletions app_test.go
Expand Up @@ -654,6 +654,7 @@ func TestApp_FlagsFromExtPackage(t *testing.T) {
}()

a := &App{
AllowExtFlags: true,
Flags: []Flag{
&StringFlag{
Name: "carly",
Expand All @@ -677,6 +678,28 @@ func TestApp_FlagsFromExtPackage(t *testing.T) {
if someint != 10 {
t.Errorf("Expected 10 got %d for someint", someint)
}

a = &App{
Flags: []Flag{
&StringFlag{
Name: "carly",
Aliases: []string{"c"},
Required: false,
},
&BoolFlag{
Name: "jimbob",
Aliases: []string{"j"},
Required: false,
Value: true,
},
},
}

// this should return an error since epflag shouldnt be registered
err = a.Run([]string{"foo", "-c", "cly", "--epflag", "10"})
if err == nil {
t.Error("Expected error")
}
}

func TestApp_Setup_defaultsReader(t *testing.T) {
Expand Down
3 changes: 3 additions & 0 deletions godoc-current.txt
Expand Up @@ -324,6 +324,9 @@ type App struct {
UseShortOptionHandling bool
// Enable suggestions for commands and flags
Suggest bool
// Allows global flags set by libraries which use flag.XXXVar(...) directly
// to be parsed through this library
AllowExtFlags bool

// Has unexported fields.
}
Expand Down
3 changes: 3 additions & 0 deletions testdata/godoc-v2.x.txt
Expand Up @@ -324,6 +324,9 @@ type App struct {
UseShortOptionHandling bool
// Enable suggestions for commands and flags
Suggest bool
// Allows global flags set by libraries which use flag.XXXVar(...) directly
// to be parsed through this library
AllowExtFlags bool

// Has unexported fields.
}
Expand Down