Documentation ¶
Index ¶
- func InitFlags(flags *pflag.FlagSet)
- func PrintFlags(flags *pflag.FlagSet)
- func PrintSections(w io.Writer, fss NamedFlagSets, cols int)
- func TerminalSize(w io.Writer) (int, int, error)
- func WarnWordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName
- func WordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName
- type App
- type CliOptions
- type Command
- type CompletableOptions
- type NamedFlagSets
- type Option
- type PrintableOptions
- type RunCommandFunc
- type RunFunc
- type SubCliOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PrintSections ¶
func PrintSections(w io.Writer, fss NamedFlagSets, cols int)
PrintSections 按 cols 作为最大值打印给定名称的 FlagSets 如果 cols 为 0,则不换行打印.
func WarnWordSepNormalizeFunc ¶
func WarnWordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName
WarnWordSepNormalizeFunc 替换 "_" 分隔符并打印警告.
func WordSepNormalizeFunc ¶
func WordSepNormalizeFunc(f *pflag.FlagSet, name string) pflag.NormalizedName
WordSepNormalizeFunc 规范化标志中的 "_" 和 "-" 分隔符.
Types ¶
type App ¶
type App struct {
// contains filtered or unexported fields
}
App 是命令行应用程序的主体结构,建议使用 app.NewApp() 函数创建应用.
type CliOptions ¶
type CliOptions interface { Flags() (fss NamedFlagSets) // 通过命令行参数解析出的 FlagSets Validate() []error // 用于校验参数是否合法 }
CliOptions 定义了从命令行读取参数的配置选项接口.
type Command ¶
type Command struct {
// contains filtered or unexported fields
}
Command 是命令行应用程序中子命令的主体结构.
type CompletableOptions ¶
type CompletableOptions interface {
Complete() error
}
CompletableOptions 定义了完整选项需要实现的接口.
type NamedFlagSets ¶
type NamedFlagSets struct { // Order 是 FlagSet 名称的有序列表 Order []string // FlagSets 按名称存储了对应的 FlagSet FlagSets map[string]*pflag.FlagSet }
NamedFlagSets 按照调用 FlagSet 的顺序来存储.
type Option ¶
type Option func(*App)
Option 定义用于初始化 App 结构的可选参数.
func WithDefaultValidArgs ¶
func WithDefaultValidArgs() Option
func WithDescription ¶
func WithNoConfig ¶
func WithNoConfig() Option
func WithNoVersion ¶
func WithNoVersion() Option
func WithOptions ¶
func WithOptions(opts CliOptions) Option
func WithRunFunc ¶
func WithSilence ¶
func WithSilence() Option
func WithValidArgs ¶
func WithValidArgs(args cobra.PositionalArgs) Option
type PrintableOptions ¶
type PrintableOptions interface {
String() string
}
PrintableOptions 定义了可被打印的选项需要实现的接口.
type SubCliOptions ¶
type SubCliOptions interface { AddFlags(fs *pflag.FlagSet) // 向指定 FlagSet 中添加标志 Validate() []error // 用于校验参数是否合法 }
SubCliOptions 定义了每个子命令行选项需要实现的接口,为 CliOptions 提供支持.
Click to show internal directories.
Click to hide internal directories.