app

type App ¶

type App struct {
	// contains filtered or unexported fields
}

func NewApp(prefix, appname string, opts ...Option) *App

func (a *App) Run()

type Command ¶

type Command struct {
	// contains filtered or unexported fields
}

func (c *Command) AddCommand(cmd *Command)

func (c *Command) AddCommands(cmds ...*Command)

type CompletableOptions ¶

type CompletableOptions interface {
	Complete() error
}

CompletableOptions 抽象可以完成/编译的options

type ConfigurableOptions ¶

type ConfigurableOptions interface {
	ApplyFlags() []error
}

ConfigurableOptions 抽象用于从配置文件读取参数的配置选项。

type FlagSet ¶

type FlagSet struct {
	// contains filtered or unexported fields
}

func (fs *FlagSet) Flags(name string) *pflag.FlagSet

type FlagsIntf ¶

type FlagsIntf interface {
	AddFlags(fs *pflag.FlagSet)
	Validate() []error
}

FlagsIntf 提供命令行接口，定义命令行的具体实现 该接口的实现由子配置结构体实现 例子：

type Options struct {
    MySQLOpts *MySQLOptions `json:"mysql" mapstructure:"mysql"`
}
type MySQLOptions struct {
	...
}
var _ Flags = &MySQLOptions{} // 实现了 FlagsIntf
... 这里省略实现函数

type FlagsOptions ¶

type FlagsOptions interface {
	// Flags 添加命令行
	Flags() (fs FlagSet)
	// Validate 验证
	Validate() []error
}

FlagOptions 命令行读取配置

type Option ¶

type Option func(*App)

func WithCommand(use, short, long string) Option

func WithDefaultValidArgs() Option

func WithDescription(desc string) Option

func WithFlags(fi FlagsOptions) Option

func WithNoConfig() Option

func WithRunFunc(run RunFunc) Option

func WithVersion(noVersion bool) Option

type OptionsIntf ¶

type OptionsIntf interface {
	FlagsOptions
	ConfigurableOptions
	CompletableOptions
	PrintableOptions
}

OptionsIntf 提供Options接口，定义Options的具体实现

type PrintableOptions ¶

type PrintableOptions interface {
	String() string
}

PrintableOptions 抽象可以打印的options

type RunCommandFunc ¶

type RunCommandFunc func(args []string) error

type RunFunc ¶

type RunFunc func(app string) error