config

Documentation

Index

• func SetConfig(command string, flagSet *pflag.FlagSet) error
• type Config
  • func (c *Config) Wd() string
• type GenConfig
• type GenDocsConfig
• type GenSdkConfig
• type GenSwaggerConfig
• type GenZrpcclientConfig
• type HooksConfig
• type IvmAddApiConfig
• type IvmAddConfig
• type IvmAddProtoConfig
• type IvmConfig
• type IvmInitConfig
• type NewConfig
• type ServerlessConfig
• type ServerlessDeleteConfig
• type ServerlessNewConfig
• type TemplateBuildConfig
• type TemplateConfig
• type TemplateInitConfig
• type UpgradeConfig

Functions

func SetConfig

func SetConfig(command string, flagSet *pflag.FlagSet) error

Types

type Config

type Config struct {
	Syntax  string `mapstructure:"syntax"`
	Version string `mapstructure:"version"`

	/*
		===============================command flags start========================================
	*/
	// global flags
	Debug bool `mapstructure:"debug"`

	DebugSleepTime int `mapstructure:"debug-sleep-time"`

	// new command
	New NewConfig `mapstructure:"new"`

	// gen command
	Gen GenConfig `mapstructure:"gen"`

	// ivm command
	Ivm IvmConfig `mapstructure:"ivm"`

	// template command
	Template TemplateConfig `mapstructure:"template"`

	// upgrade command
	Upgrade UpgradeConfig `mapstructure:"upgrade"`

	// serverless command
	Serverless ServerlessConfig `mapstructure:"serverless"`
}

var C Config

C global command flags

func (*Config) Wd

func (c *Config) Wd() string

type GenConfig

type GenConfig struct {
	Hooks HooksConfig `mapstructure:"hooks"`

	// global flags
	Home string `mapstructure:"home"`

	Style            string `mapstructure:"style"`
	SplitApiTypesDir bool   `mapstructure:"split-api-types-dir"`

	// code style flags
	ChangeLogicTypes bool `mapstructure:"change-logic-types"`

	RpcStylePatch   bool `mapstructure:"rpc-style-patch"`
	RegenApiHandler bool `mapstructure:"regen-api-handler"`

	// git flags
	GitChange bool `mapstructure:"git-change"`

	ApiGitChangePath   string `mapstructure:"api-git-change-path"`
	ModelGitChangePath string `mapstructure:"model-git-change-path"`
	ProtoGitChangePath string `mapstructure:"proto-git-change-path"`

	// model flags
	ModelMysqlStrict bool `mapstructure:"model-mysql-strict"`

	ModelMysqlIgnoreColumns   []string `mapstructure:"model-mysql-ignore-columns"`
	ModelMysqlDDLDatabase     string   `mapstructure:"model-mysql-ddl-database"`
	ModelMysqlDatasource      bool     `mapstructure:"model-mysql-datasource"`
	ModelMysqlDatasourceUrl   string   `mapstructure:"model-mysql-datasource-url"`
	ModelMysqlDatasourceTable []string `mapstructure:"model-mysql-datasource-table"`
	ModelMysqlCache           bool     `mapstructure:"model-mysql-cache"`
	ModelMysqlCachePrefix     string   `mapstructure:"model-mysql-cache-prefix"`
	GenMysqlCreateTableDDL    bool     `mapstructure:"gen-mysql-create-table-ddl"`

	// rpc flags
	RpcClient bool `mapstructure:"rpc-client"`

	// gen code flags
	Desc []string `mapstructure:"desc"`

	DescIgnore []string `mapstructure:"desc-ignore"`

	// other
	Route2Code bool

	Sdk        GenSdkConfig        `mapstructure:"sdk"`
	Swagger    GenSwaggerConfig    `mapstructure:"swagger"`
	Zrpcclient GenZrpcclientConfig `mapstructure:"zrpcclient"`
	Docs       GenDocsConfig       `mapstructure:"docs"`
}

type GenDocsConfig

type GenDocsConfig struct {
	Output   string `mapstructure:"output"`
	Format   string `mapstructure:"format"`
	ApiDir   string `mapstructure:"api-dir"`
	ProtoDir string `mapstructure:"proto-dir"`
}

type GenSdkConfig

type GenSdkConfig struct {
	Hooks HooksConfig `mapstructure:"hooks"`

	Scope        string `mapstructure:"scope"`
	ApiDir       string `mapstructure:"api-dir"`
	ProtoDir     string `mapstructure:"proto-dir"`
	WrapResponse bool   `mapstructure:"wrap-response"`
	Output       string `mapstructure:"output"`
	Language     string `mapstructure:"language"`
	GoVersion    string `mapstructure:"goVersion"`
	GoModule     string `mapstructure:"goModule"`
	GoPackage    string `mapstructure:"goPackage"`
}

type GenSwaggerConfig

type GenSwaggerConfig struct {
	Output   string `mapstructure:"output"`
	ApiDir   string `mapstructure:"api-dir"`
	ProtoDir string `mapstructure:"proto-dir"`
}

type GenZrpcclientConfig

type GenZrpcclientConfig struct {
	Hooks HooksConfig `mapstructure:"hooks"`

	Scope     string `mapstructure:"scope"`
	Output    string `mapstructure:"output"`
	GoVersion string `mapstructure:"goVersion"`
	GoModule  string `mapstructure:"goModule"`
	GoPackage string `mapstructure:"goPackage"`
}

type HooksConfig

type HooksConfig struct {
	Before []string `mapstructure:"before"`
	After  []string `mapstructure:"after"`
}

type IvmAddApiConfig

type IvmAddApiConfig struct {
	Name     string   `mapstructure:"name"`
	Group    string   `mapstructure:"group"`
	Handlers []string `mapstructure:"handlers"`
}

type IvmAddConfig

type IvmAddConfig struct {
	Api   IvmAddApiConfig   `mapstructure:"api"`
	Proto IvmAddProtoConfig `mapstructure:"proto"`
}

type IvmAddProtoConfig

type IvmAddProtoConfig struct {
	Methods  []string `mapstructure:"methods"`
	Name     string   `mapstructure:"name"`
	Services []string `mapstructure:"services"`
}

type IvmConfig

type IvmConfig struct {
	// global flags
	Version string `mapstructure:"version"`

	Init IvmInitConfig `mapstructure:"init"`
	Add  IvmAddConfig  `mapstructure:"add"`
}

type IvmInitConfig

type IvmInitConfig struct {
	Style            string `mapstructure:"style"`
	ChangeLogicTypes bool   `mapstructure:"change-logic-types"`
}

type NewConfig

type NewConfig struct {
	Core     bool     `mapstructure:"core"`
	Home     string   `mapstructure:"home"`     // 新建项目使用的模板文件目录
	Module   string   `mapstructure:"module"`   // 新建的项目的 go module
	Mono     bool     `mapstructure:"mono"`     // 是否是 mono 项目(即在一个mod项目之下, 但该项目本身无 go.mod 文件)
	Output   string   `mapstructure:"output"`   // 输出到的目录
	Remote   string   `mapstructure:"remote"`   // 远程仓库地址
	Frame    string   `mapstructure:"frame"`    // 使用 jzero 内置的框架
	Branch   string   `mapstructure:"branch"`   // 使用远程模板仓库的某个分支
	Local    string   `mapstructure:"local"`    // 使用本地模板与 branch 对应
	Style    string   `mapstructure:"style"`    // 项目代码风格
	Features []string `mapstructure:"features"` // 新建项目使用哪些特性, 灵活构建模板
}

type ServerlessConfig

type ServerlessConfig struct {
	New    NewConfig              `mapstructure:"new"`
	Delete ServerlessDeleteConfig `mapstructure:"delete"`
}

type ServerlessDeleteConfig

type ServerlessDeleteConfig struct {
	Plugin []string `mapstructure:"plugin"`
}

type ServerlessNewConfig

type ServerlessNewConfig struct {
	Module string `mapstructure:"module"` // 新建的项目的 go module
	Remote string `mapstructure:"remote"` // 远程仓库地址
	Frame  string `mapstructure:"frame"`  // 使用 jzero 内置的框架
	Branch string `mapstructure:"branch"` // 使用远程模板仓库的某个分支
	Local  string `mapstructure:"local"`  // 使用本地模板与 branch 对应
	Style  string `mapstructure:"style"`  // 项目代码风格
}

type TemplateBuildConfig

type TemplateBuildConfig struct {
	Output     string   `mapstructure:"output"`
	WorkingDir string   `mapstructure:"working-dir"`
	Name       string   `mapstructure:"name"`
	Ignore     []string `mapstructure:"ignore"`
}

type TemplateConfig

type TemplateConfig struct {
	Init  TemplateInitConfig  `mapstructure:"init"`
	Build TemplateBuildConfig `mapstructure:"build"`
}

type TemplateInitConfig

type TemplateInitConfig struct {
	Output string `mapstructure:"output"`
	Remote string `mapstructure:"remote"`
	Branch string `mapstructure:"branch"`
}

type UpgradeConfig

type UpgradeConfig struct {
	Channel string `mapstructure:"channel"`
}