Documentation
¶
Index ¶
- Variables
- func CheckExamples(cmd *cobra.Command) []error
- func CheckFlags(cmd *cobra.Command) []error
- func CheckGlobalVarFlags() []error
- func CheckLongDesc(cmd *cobra.Command) []error
- func RunCmdChecks(cmd *cobra.Command, cmdChecks []CmdCheck, skipCmd []string) []error
- func RunGlobalChecks(globalChecks []GlobalCheck) []error
- type CmdCheck
- type GlobalCheck
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // AllCmdChecks is the list of CmdCheck type functions AllCmdChecks = []CmdCheck{ CheckLongDesc, CheckExamples, CheckFlags, } // AllGlobalChecks is the list of GlobalCheck type functions AllGlobalChecks = []GlobalCheck{ CheckGlobalVarFlags, } )
Functions ¶
func CheckExamples ¶
CheckExamples checks if the command examples are valid
func CheckFlags ¶ added in v1.7.0
CheckFlags checks if the command-line flags are valid
func CheckGlobalVarFlags ¶ added in v1.7.0
func CheckGlobalVarFlags() []error
CheckGlobalVarFlags checks if the global flags are valid
func CheckLongDesc ¶
CheckLongDesc checks if the long description is valid
func RunCmdChecks ¶ added in v1.7.0
RunCmdChecks runs all the CmdCheck functions passed, skipping skippable commands and looks for error
func RunGlobalChecks ¶ added in v1.7.0
func RunGlobalChecks(globalChecks []GlobalCheck) []error
RunGlobalChecks runs all the GlobalCheck functions passed and checks for error
Types ¶
type GlobalCheck ¶ added in v1.7.0
type GlobalCheck func() []error
GlobalCheck is the common type of functions to check global flags
Source Files
Click to show internal directories.
Click to hide internal directories.