mirror of
https://github.com/spf13/cobra
synced 2024-11-04 12:57:14 +00:00
command: Allow overriding of flag parse function
To allow setting a user-defined flag parser, we add a new SetFlagParseFunc to Command. This function, when set, will be called instead of pflag.Parse.
This commit is contained in:
parent
eb3b6397b1
commit
af165be453
1 changed files with 25 additions and 1 deletions
26
command.go
26
command.go
|
@ -145,6 +145,9 @@ type Command struct {
|
|||
usageFunc func(*Command) error
|
||||
// usageTemplate is usage template defined by user.
|
||||
usageTemplate string
|
||||
// flagParseFunc is func defined by user and it's called when the command is
|
||||
// parsing the flags.
|
||||
flagParseFunc func(*Command, []string) error
|
||||
// flagErrorFunc is func defined by user and it's called when the parsing of
|
||||
// flags returns an error.
|
||||
flagErrorFunc func(*Command, error) error
|
||||
|
@ -271,6 +274,11 @@ func (c *Command) SetUsageTemplate(s string) {
|
|||
c.usageTemplate = s
|
||||
}
|
||||
|
||||
// SetFlagParseFunc sets a function to parse flags.
|
||||
func (c *Command) SetFlagParseFunc(f func(*Command, []string) error) {
|
||||
c.flagParseFunc = f
|
||||
}
|
||||
|
||||
// SetFlagErrorFunc sets a function to generate an error when flag parsing
|
||||
// fails.
|
||||
func (c *Command) SetFlagErrorFunc(f func(*Command, error) error) {
|
||||
|
@ -432,6 +440,22 @@ func (c *Command) UsageString() string {
|
|||
return bb.String()
|
||||
}
|
||||
|
||||
// FlagParseFunc returns either the function set by SetFlagParseFunc for this
|
||||
// command or a parent, or it returns a function which calls the original
|
||||
// flag parse function.
|
||||
func (c *Command) FlagParseFunc() (f func(*Command, []string) error) {
|
||||
if c.flagParseFunc != nil {
|
||||
return c.flagParseFunc
|
||||
}
|
||||
|
||||
if c.HasParent() {
|
||||
return c.parent.FlagParseFunc()
|
||||
}
|
||||
return func(c *Command, args []string) error {
|
||||
return c.Flags().Parse(args)
|
||||
}
|
||||
}
|
||||
|
||||
// FlagErrorFunc returns either the function set by SetFlagErrorFunc for this
|
||||
// command or a parent, or it returns a function which returns the original
|
||||
// error.
|
||||
|
@ -1626,7 +1650,7 @@ func (c *Command) ParseFlags(args []string) error {
|
|||
// do it here after merging all flags and just before parse
|
||||
c.Flags().ParseErrorsWhitelist = flag.ParseErrorsWhitelist(c.FParseErrWhitelist)
|
||||
|
||||
err := c.Flags().Parse(args)
|
||||
err := c.FlagParseFunc()(c, args)
|
||||
// Print warnings if they occurred (e.g. deprecated flag messages).
|
||||
if c.flagErrorBuf.Len()-beforeErrorBufLen > 0 && err == nil {
|
||||
c.Print(c.flagErrorBuf.String())
|
||||
|
|
Loading…
Reference in a new issue