cli

Documentation

Index

• func SetupConsole(ctx context.Context, factory ConsoleFactory) error
• type AsyncClient
• type Client
• type ClientFactory
• type CommandHelpInfo
• type CommandHelper
• type Console
  • func GetConsole(ctx context.Context) (Console, error)
• type ConsoleFactory
• type Context
• type Filter
• type FilterChain
• type FilterChainBuilder
  • func (inst *FilterChainBuilder) Add(priority int, filter Filter)
  • func (inst *FilterChainBuilder) Create(reverse bool) FilterChain
  • func (inst *FilterChainBuilder) Len() int
  • func (inst *FilterChainBuilder) Less(a, b int) bool
  • func (inst *FilterChainBuilder) Swap(a, b int)
• type Handler
• type Service
• type Task
• type TaskContext
  • func (inst *TaskContext) Clone() *TaskContext
• type TaskListBuilder
  • func (inst *TaskListBuilder) AddLine(line string, index int, args []string) error
  • func (inst *TaskListBuilder) Create() []*TaskUnit
  • func (inst *TaskListBuilder) ParseScript(script string) error
• type TaskUnit

Functions

func SetupConsole

func SetupConsole(ctx context.Context, factory ConsoleFactory) error

SetupConsole 从上下文取控制台接口

Types

type AsyncClient

type AsyncClient interface {
	GetContext() context.Context
	GetFactory() ClientFactory

	Execute(cmd string) task.Promise
	ExecuteTask(task *Task) task.Promise
	ExecuteScript(script string) task.Promise
	ExecuteWithArguments(cmd string, args []string) task.Promise
}

AsyncClient 是用于执行命令的异步 API

type Client

type Client interface {
	GetContext() context.Context
	GetFactory() ClientFactory

	Execute(cmd string) error
	ExecuteTask(task *Task) error
	ExecuteWithArguments(cmd string, args []string) error

	// execute multi-line commands
	ExecuteScript(script string) error
}

Client 是用于执行命令的同步 API

type ClientFactory

type ClientFactory interface {
	CreateClient(ctx context.Context) Client
	CreateAsyncClient(ctx context.Context) AsyncClient
}

ClientFactory 是命令客户端的工厂

type CommandHelpInfo

type CommandHelpInfo struct {
	Name        string
	Title       string
	Description string
	Content     string
}

CommandHelpInfo 是命令的帮助信息

type CommandHelper

type CommandHelper interface {
	GetHelpInfo() *CommandHelpInfo
}

CommandHelper 是命令的帮助信息提供者, 通常与Handler 实现于同一个结构

type Console

type Console interface {
	GetWD() string
	SetWD(wd string)

	GetWorkingPath() fs.Path
	SetWorkingPath(wd fs.Path)

	Error() io.Writer
	Output() io.Writer
	Input() io.Reader

	SetError(w io.Writer)
	SetOutput(w io.Writer)
	SetInput(r io.Reader)
}

Console 接口表示一个跟上下文绑定的控制台

func GetConsole

func GetConsole(ctx context.Context) (Console, error)

GetConsole 从上下文取控制台接口

type ConsoleFactory

type ConsoleFactory interface {
	Create() Console
}

ConsoleFactory 是创建 Console 的工厂

type Context

type Context struct {
	markup.Component `id:"cli-context"`

	Service       Service       `inject:"#cli-service"`
	ClientFactory ClientFactory `inject:"#cli-client-factory"`
	Filters       []Filter      `inject:".cli-filter"`
	Handlers      []Handler     `inject:".cli-handler"`
}

type Filter

type Filter interface {
	Init(service Service) error
	Handle(ctx *TaskContext, next FilterChain) error
}

Filter 用来过滤请求

type FilterChain

type FilterChain interface {
	Handle(ctx *TaskContext) error
}

FilterChain 代表过滤器链条

type FilterChainBuilder

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

func (*FilterChainBuilder) Add

func (inst *FilterChainBuilder) Add(priority int, filter Filter)

func (*FilterChainBuilder) Create

func (inst *FilterChainBuilder) Create(reverse bool) FilterChain

func (*FilterChainBuilder) Len

func (inst *FilterChainBuilder) Len() int

func (*FilterChainBuilder) Less

func (inst *FilterChainBuilder) Less(a, b int) bool

func (*FilterChainBuilder) Swap

func (inst *FilterChainBuilder) Swap(a, b int)

type Handler

type Handler interface {
	Init(service Service) error
	Handle(ctx *TaskContext) error
}

Handler 是某条具体命令的处理器

type Service

type Service interface {
	RegisterHandler(name string, h Handler) error

	FindHandler(name string) (Handler, error)

	GetHandlerNames() []string

	// AddFilter 添加一个过滤器到服务中。
	// priority 是过滤器的优先顺序，数值越大，优先级越高，处理顺序越靠前。
	AddFilter(priority int, filter Filter) error

	GetFilterChain() FilterChain

	GetClient(ctx context.Context) Client

	GetClientFactory() ClientFactory
}

Service 是用来处理命令的服务

type Task

type Task struct {
	Context  context.Context
	TaskList []*TaskUnit
	Script   string
}

Task 表示将要执行的任务

type TaskContext

type TaskContext struct {
	Context     context.Context
	CurrentTask *TaskUnit
	Handler     Handler
	Service     Service
	TaskList    []*TaskUnit
}

TaskContext 表示正在执行的任务

func (*TaskContext) Clone

func (inst *TaskContext) Clone() *TaskContext

Clone 生成 TaskContext 的副本（浅拷贝）

type TaskListBuilder

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

func (*TaskListBuilder) AddLine

func (inst *TaskListBuilder) AddLine(line string, index int, args []string) error

func (*TaskListBuilder) Create

func (inst *TaskListBuilder) Create() []*TaskUnit

func (*TaskListBuilder) ParseScript

func (inst *TaskListBuilder) ParseScript(script string) error

type TaskUnit

type TaskUnit struct {
	LineNumber  int
	CommandName string
	CommandLine string
	Arguments   []string
}

TaskUnit 表示一条简单的命令