gocli

type AlignField struct {
	Content    string
	AlignWidth int
	Padding    PaddingType
	// contains filtered or unexported fields
}

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

type Args = []string

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

type Command interface {
	Key() string
	Usage() string
	Run(ctx Context, args []string, flagmap FlagMap) Message
	Flags() []Flag
}

type CommandInputs struct {
	Args  Args
	Flags FlagMap
}

type CommandVisitor = func(key string, command map[string]Command) (next bool)

type Console interface {
	//文件logger,如过没有设置,则使用指定文件记录日志
	Log() (Log, bool)
	Std() StandConsole
	//只在终端输出
	StandConsole
}

type Context interface {
	Value(key any) any
	Interupt() bool
	WorkDir() string
	RegisteredPlugins() PluginVersionMap
	StdConsole() StandConsole
	Logger() (logger Log, enable bool)
	ValueOperator
}

type ContextKey = string

type ExecFunc = func(ctx Context, args []string, flagmap FlagMap) Message

type FParser[T any] interface {
	Parse(args Args) (T, bool)
}

type Flag interface {
	Name() string
	Alias() (string, bool)
	Usage() string
}

type FlagExpected struct {
	Flag      Flag
	Required  bool
	Validator FlagValidator
	ErrMsg    Message
	DefVal    any
}

type FlagInputs = CommandInputs

type FlagMap interface {
	GetString(key string) (v string, found bool)
	GetStrings(key string) (v Args, found bool)
	GetBool(key string) (v bool, found bool)
	GetInt(key string) (v int, found bool)
	Set(key string, values ...string)
	HasFlag(flag Flag) (Args, bool)
	Empty() bool
	// contains filtered or unexported methods
}

type FlagParser[T any] func(args Args) (T, bool)

type FlagValidator = Validator[*FlagInputs]

type GeneralPlugin struct {
	ID       string
	Desc     string
	Ver      string
	Init     LifeHook
	PreRun   LifeHook
	Commands []Command
	Help     HelperFunc
}

type HelperFunc = func() string

type InputValidRule = func(ctx Context, args []string, flags FlagMap) (bool, Message)

type InputValidator = Validator[*CommandInputs]

type LifeHook = func(ctx Context) error

type LoadedPlugin struct {
	File     string
	Digest   string
	Verified bool
	Plugin
}

type Log interface {
	NewLogger(file string) Log
	StandConsole
}

type LogLevel = int

type Logger struct {
	Max     int64
	RStrage int
	// contains filtered or unexported fields
}

type Message interface {
	// code < 0 程序应该中断
	Code() int
	Kind() int
	Msg() string
	Err() (error, bool)
}

type PaddingType = int

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

type ParamValiator = ParamValidator[string]

type ParamValidRule = func(ctx Context, val string) (bool, Message)

type ParamValidator[T any] interface {
	// 返回值小于0,实用所有参数
	Index() int
	Validator[T]
}

type Plugin interface {
	Name() string
	Usage() string
	Version() string
	Setup(ctx Context) error
	//boot run 前检查
	BeforeRun(ctx Context) error
	Registry() []Command
	//all custom plugin's commands help info
	Helper() HelperFunc
}

type PluginBean struct {
	Name       string
	Version    string
	ExportType string
	Usage      string
}

type PluginBundle interface {
	Version() string
	Name() string
	Md5() string
	File() string
	Dependencies() []PluginBundle
}

type PluginContext interface {
	Context
	// contains filtered or unexported methods
}

type PluginVersionMap = map[string]PluginBundle

type PluginVisitor = func(key string, plugins map[string]*RegisteredPlugin) (next bool)

type Prefix = func() string

type RegisteredCommand struct {
	From        unsafe.Pointer
	SubCommands SubCommand

	Command
	// contains filtered or unexported fields
}

type RegisteredCommandVisitor = RootCommandVisitor

type RegisteredPlugin struct {
	Plugin
	// contains filtered or unexported fields
}

type Registry interface {
	RootCommand(key string) (RegisteredCommand, bool)
	// root command key max len
	RootKeyMaxLen() (int, bool)
	//支持 root command ,和subcommand
	Command(args []string) (RegisteredCommand, bool)
	CommandKeyMaxLen() (int, bool)
	Plugin(name string) (RegisteredPlugin, bool)
	FindPlugin(plugin Plugin) (RegisteredPlugin, bool)
	RegisterCommand(p Plugin, cmds ...Command) (ok bool, err error)
	RegisterPlugins(plugins ...Plugin)
	RangeRootCommand(RootCommandVisitor)
	RangePlugin(PluginVisitor)
	Finish(panicunfinished bool) (loaded int, failed int)
	Logger(log Log)
}

type RegistryCommands []*RegisteredCommand

type RootCommandVisitor = func(key string, roots map[string]*RegisteredCommand) (next bool)

type RotateStrage = int

type ShortAction = int

type ShortCommand struct {
	Command string
	Action  ShortAction
	*ShortKey
}

type ShortCutCommands = []ShortCommand

type ShortCutKey = int

type ShortKey struct {
	Key   ShortCutKey
	Title string
}

type StandConsole interface {
	Err(emsg string, args ...any)
	WError(err error)
	Warn(msg string, args ...any)
	Info(msg string, args ...any)
	Succ(msg string, args ...any)
	Debug(msg string, args ...any)
	Msg(msg Message)
	Level(level LogLevel)
	Prefix(prefix string, args ...any) Console
	AppendPrefix(prefix string, args ...any) Console
	PrependPrefix(prefix string, args ...any) Console
}

type SubCommand = map[string]*RegisteredCommand

type UiOptions struct {
	MaxHistoryItem int
	ShortCut       ShortCutCommands
}

type Validator[T any] interface {
	Valid(ctx Context, value T) (bool, Message)
}

type ValueOperator interface {
	SetValueIfAbsent(key any, value any) (exist bool)
	SetValue(key any, value any)
	Remove(key any) (removed any, loaded bool)
}

type Window interface {
	Run(prompt string, ctx Context) Message
}