2015-07-28 18:02:18 +00:00
|
|
|
package cli
|
|
|
|
|
2016-07-22 08:19:29 +00:00
|
|
|
// ShellCompleteFunc is an action to execute when the shell completion flag is set
|
|
|
|
type ShellCompleteFunc func(*Context)
|
2015-07-28 18:02:18 +00:00
|
|
|
|
2016-05-09 14:12:59 +00:00
|
|
|
// BeforeFunc is an action to execute before any subcommands are run, but after
|
|
|
|
// the context is ready if a non-nil error is returned, no subcommands are run
|
2016-04-27 13:12:34 +00:00
|
|
|
type BeforeFunc func(*Context) error
|
2015-07-28 18:02:18 +00:00
|
|
|
|
2016-05-09 14:12:59 +00:00
|
|
|
// AfterFunc is an action to execute after any subcommands are run, but after the
|
|
|
|
// subcommand has finished it is run even if Action() panics
|
2016-04-27 13:12:34 +00:00
|
|
|
type AfterFunc func(*Context) error
|
2015-07-28 18:02:18 +00:00
|
|
|
|
2016-05-09 14:12:59 +00:00
|
|
|
// ActionFunc is the action to execute when no subcommands are specified
|
2016-04-27 13:12:34 +00:00
|
|
|
type ActionFunc func(*Context) error
|
2015-07-28 18:02:18 +00:00
|
|
|
|
2016-05-09 14:12:59 +00:00
|
|
|
// CommandNotFoundFunc is executed if the proper command cannot be found
|
2016-04-25 22:29:05 +00:00
|
|
|
type CommandNotFoundFunc func(*Context, string)
|
|
|
|
|
2016-05-09 14:12:59 +00:00
|
|
|
// OnUsageErrorFunc is executed if an usage error occurs. This is useful for displaying
|
2016-04-25 22:29:05 +00:00
|
|
|
// customized usage error messages. This function is able to replace the
|
|
|
|
// original error messages. If this function is not set, the "Incorrect usage"
|
|
|
|
// is displayed and the execution is interrupted.
|
|
|
|
type OnUsageErrorFunc func(context *Context, err error, isSubcommand bool) error
|
2016-05-02 17:05:21 +00:00
|
|
|
|
|
|
|
// FlagStringFunc is used by the help generation to display a flag, which is
|
|
|
|
// expected to be a single line.
|
|
|
|
type FlagStringFunc func(Flag) string
|