glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2024-11-25 07:07:15 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add support for user specified args validation func (#663)

Browse source 
Add an attribute (which is a function) to Command which is called before any Run steps. If an error is returned
the command execution terminates.
This commit is contained in:
Sion Williams 2018-04-05 19:12:12 +01:00
parent 4dab30cb33
commit 9191622a46
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
command.go
View file

@ -84,6 +84,7 @@ type Command struct {
Version string Version string
// The *Run functions are executed in the following order: // The *Run functions are executed in the following order:
// * ValidateArgsFn()
// * PersistentPreRun() // * PersistentPreRun()
// * PreRun() // * PreRun()
// * Run() // * Run()
@ -91,6 +92,8 @@ type Command struct {
// * PersistentPostRun() // * PersistentPostRun()
// All functions get the same args, the arguments after the command name. // All functions get the same args, the arguments after the command name.
// //
// ValidateArgsFn: Used to validate the input arguments from the user.
ValidateArgsFn func(cmd *Command, args []string) error
// PersistentPreRun: children of this command will inherit and execute. // PersistentPreRun: children of this command will inherit and execute.
PersistentPreRun func(cmd *Command, args []string) PersistentPreRun func(cmd *Command, args []string)
// PersistentPreRunE: PersistentPreRun but returns an error. // PersistentPreRunE: PersistentPreRun but returns an error.
@ -736,6 +739,12 @@ func (c *Command) execute(a []string) (err error) {
return err return err
} }
if c.ValidateArgsFn != nil {
if err := c.ValidateArgsFn(c, argWoFlags); err != nil {
return err
}
}
for p := c; p != nil; p = p.Parent() { for p := c; p != nil; p = p.Parent() {
if p.PersistentPreRunE != nil { if p.PersistentPreRunE != nil {
if err := p.PersistentPreRunE(c, argWoFlags); err != nil { if err := p.PersistentPreRunE(c, argWoFlags); err != nil {