Documentation
¶
Index ¶
- Variables
- type Builder
- type Flag
- type FlagWriter
- type Flags
- func (flags *Flags) Help(md bool, topAnchor string) string
- func (flags *Flags) HelpAsReader(md bool, topAnchor string) io.Reader
- func (Flags *Flags) HelpFlagVisitor(md bool, topAnchor string, fn func(fw FlagWriter)) io.Reader
- func (flags *Flags) Parse(args []string) (interface{}, error)
- func (flags *Flags) ParseFunctionArgs(args []*FunctionArg) (interface{}, error)
- func (flags *Flags) Validate() error
- type FunctionArg
- type FunctionMeta
- type MainOptions
- type Redirect
Constants ¶
This section is empty.
Variables ¶
Functions ¶
This section is empty.
Types ¶
type Builder ¶
type Builder interface {
io.Reader
Name(n, shortDesc string, aliases ...string)
Usage(s string)
Description(s string)
Flag(flag []*Flag, t reflect.Type)
FlagVisitor(fn func(fw FlagWriter))
Example(s, topAnchor string)
String() string
}
func NewConsoleBuilder ¶
func NewConsoleBuilder() Builder
func NewMarkdownBuilder ¶
func NewMarkdownBuilder() Builder
type Flag ¶
type FlagWriter ¶
type Flags ¶
type Flags struct {
FuncName string
Aliases []string
Flags []*Flag
Result reflect.Type
Example string
Usage string
ShortDesc string
Description string
}
func (*Flags) HelpFlagVisitor ¶
func (*Flags) ParseFunctionArgs ¶
func (flags *Flags) ParseFunctionArgs(args []*FunctionArg) (interface{}, error)
ParseFlagFunction return a pointer to a struct result if no error occurred. Unlike Parse which accept slice of string, `ParseFlagFunction` accept a slice of interface value (any value), in order to avoid parsing back and forth between string and numeric value. When args values is all strings then `ParseFlagFunction` is behave exactly as `Parse` method
type FunctionArg ¶
type FunctionMeta ¶
type FunctionMeta struct {
Name string
Redirect string
Files []string
Args []*FunctionArg
}
type MainOptions ¶
type MainOptions struct {
Cookfile string
Targets []string
Args map[string]interface{}
FuncMeta *FunctionMeta
IsHelp bool
}
func ParseMainArgument ¶
func ParseMainArgument(args []string) (*MainOptions, error)
Click to show internal directories.
Click to hide internal directories.