Rename App.UnknownFlagHandler to App.InvalidFlagAccessHandler

This commit is contained in:
Ilia Choly 2022-08-08 13:29:01 -04:00 committed by Dan Buch
parent 6331815fae
commit e19a34c3c2
Signed by: meatballhat
GPG Key ID: A12F782281063434
4 changed files with 13 additions and 13 deletions

4
app.go
View File

@ -78,8 +78,8 @@ type App struct {
CommandNotFound CommandNotFoundFunc
// Execute this function if a usage error occurs
OnUsageError OnUsageErrorFunc
// Execute this function when an unknown flag is accessed from the context
UnknownFlagHandler UnknownFlagFunc
// Execute this function when an invalid flag is accessed from the context
InvalidFlagAccessHandler InvalidFlagAccessFunc
// Compilation date
Compiled time.Time
// List of all authors who contributed

View File

@ -47,7 +47,7 @@ func (cCtx *Context) NumFlags() int {
// Set sets a context flag to a value.
func (cCtx *Context) Set(name, value string) error {
if cCtx.flagSet.Lookup(name) == nil {
cCtx.onUnknownFlag(name)
cCtx.onInvalidFlag(name)
}
return cCtx.flagSet.Set(name, value)
}
@ -161,7 +161,7 @@ func (cCtx *Context) lookupFlagSet(name string) *flag.FlagSet {
return c.flagSet
}
}
cCtx.onUnknownFlag(name)
cCtx.onInvalidFlag(name)
return nil
}
@ -193,9 +193,9 @@ func (cCtx *Context) checkRequiredFlags(flags []Flag) requiredFlagsErr {
return nil
}
func (cCtx *Context) onUnknownFlag(name string) {
if cCtx.App != nil && cCtx.App.UnknownFlagHandler != nil {
cCtx.App.UnknownFlagHandler(cCtx, name)
func (cCtx *Context) onInvalidFlag(name string) {
if cCtx.App != nil && cCtx.App.InvalidFlagAccessHandler != nil {
cCtx.App.InvalidFlagAccessHandler(cCtx, name)
}
}

View File

@ -150,11 +150,11 @@ func TestContext_Value(t *testing.T) {
expect(t, c.Value("unknown-flag"), nil)
}
func TestContext_Value_UnknownFlagHandler(t *testing.T) {
func TestContext_Value_InvalidFlagAccessHandler(t *testing.T) {
set := flag.NewFlagSet("test", 0)
var flagName string
app := &App{
UnknownFlagHandler: func(_ *Context, name string) {
InvalidFlagAccessHandler: func(_ *Context, name string) {
flagName = name
},
}
@ -271,11 +271,11 @@ func TestContext_Set(t *testing.T) {
expect(t, c.IsSet("int"), true)
}
func TestContext_Set_StrictLookup(t *testing.T) {
func TestContext_Set_InvalidFlagAccessHandler(t *testing.T) {
set := flag.NewFlagSet("test", 0)
var flagName string
app := &App{
UnknownFlagHandler: func(_ *Context, name string) {
InvalidFlagAccessHandler: func(_ *Context, name string) {
flagName = name
},
}

View File

@ -23,8 +23,8 @@ type CommandNotFoundFunc func(*Context, string)
// is displayed and the execution is interrupted.
type OnUsageErrorFunc func(cCtx *Context, err error, isSubcommand bool) error
// UnknownFlagFunc is executed when an unknown flag is accessed from the context.
type UnknownFlagFunc func(*Context, string)
// InvalidFlagAccessFunc is executed when an invalid flag is accessed from the context.
type InvalidFlagAccessFunc func(*Context, string)
// ExitErrHandlerFunc is executed if provided in order to handle exitError values
// returned by Actions and Before/After functions.