jarvis

Documentation

Index

• type AppCtx
  • func New(name string) *AppCtx
  • func (app *AppCtx) AddCommand(use string, fn func(args ...string), cmdOpts ...func(*cobra.Command))
  • func (app *AppCtx) Conf(config interface{}) error
  • func (app *AppCtx) Run(jobs ...launcher.IJob)
  • func (app *AppCtx) RunContext(ctx context.Context, jobs ...launcher.IJob)
  • func (app *AppCtx) WithOptions(opts ...AppCtxOption) *AppCtx
• type AppCtxOption
  • func WithHelpMode() AppCtxOption
  • func WithName(name string) AppCtxOption
  • func WithRoot(root string) AppCtxOption
• type ProjectInfo
  • func (info *ProjectInfo) CreateProject()

Types

type AppCtx

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

AppCtx 配置文件管理器

func New

func New(name string) *AppCtx

New 创建一个配置文件管理器

func (*AppCtx) AddCommand

func (app *AppCtx) AddCommand(use string, fn func(args ...string), cmdOpts ...func(*cobra.Command))

AddCommand 添加子命令 ex: AddCommand(migrate, module.Migrate())

cmdOpts can be flags options ex:

func WithFlags(flag string) func(*cobra.Command) {
	return func(cmd *cobra.Command) {
		cmd.Flags().StringVarP(&flag, "targets", "t", "nothing", "specify targets")
	}
}

func (*AppCtx) Conf

func (app *AppCtx) Conf(config interface{}) error

Conf 解析配置， 并在 config 目录下生成 xxx.yml 文件

func (*AppCtx) Run

func (app *AppCtx) Run(jobs ...launcher.IJob)

Run 启动服务

func (*AppCtx) RunContext

func (app *AppCtx) RunContext(ctx context.Context, jobs ...launcher.IJob)

RunContext 启动服务

func (*AppCtx) WithOptions

func (app *AppCtx) WithOptions(opts ...AppCtxOption) *AppCtx

type AppCtxOption

type AppCtxOption = func(app *AppCtx)

func WithHelpMode

func WithHelpMode() AppCtxOption

func WithName

func WithName(name string) AppCtxOption

WithName 设置 name

func WithRoot

func WithRoot(root string) AppCtxOption

WithRoot 指定项目根目录， 即 go.mod 所在的目录。

root 可以是相对 main.go 的相对路径， 也是可以是绝对路径

type ProjectInfo

type ProjectInfo struct {
	Name    string `flag:"name" usage:"project name"`
	Workdir string `flag:"dir" usage:"project src path, \ndefault: <project_name>"`
	PkgName string `flag:"pkg" usage:"go module name, \ndefault: github.com/go-jarvis/<project_name>"`
}

var Project *ProjectInfo

var makefile = tmpl.GetFile("Makefile")

func (*ProjectInfo) CreateProject

func (info *ProjectInfo) CreateProject()

CreateProject create a new project