From e19a34c3c2703cf85cf82ca5d77c938a03215f65 Mon Sep 17 00:00:00 2001 From: Ilia Choly Date: Mon, 8 Aug 2022 13:29:01 -0400 Subject: [PATCH] Rename App.UnknownFlagHandler to App.InvalidFlagAccessHandler --- app.go | 4 ++-- context.go | 10 +++++----- context_test.go | 8 ++++---- funcs.go | 4 ++-- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/app.go b/app.go index f30595c..3785b83 100644 --- a/app.go +++ b/app.go @@ -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 diff --git a/context.go b/context.go index a14a341..0f3552e 100644 --- a/context.go +++ b/context.go @@ -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) } } diff --git a/context_test.go b/context_test.go index 1ffe040..71a9d31 100644 --- a/context_test.go +++ b/context_test.go @@ -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 }, } diff --git a/funcs.go b/funcs.go index 1342bd2..e77b0d0 100644 --- a/funcs.go +++ b/funcs.go @@ -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.