common

Documentation

Index

• Constants
• Variables
• type ApiServer
• type Command
  • func NewCommand(use string, opts ...Option) *Command
  • func (c *Command) AddCommand(cmds ...*Command)
  • func (c *Command) Flags() *FlagSet
  • func (c *Command) MustInit()
  • func (c *Command) PersistentFlags() *FlagSet
• type FlagSet
  • func (f *FlagSet) BoolVar(p *bool, name string)
  • func (f *FlagSet) BoolVarP(p *bool, name, shorthand string)
  • func (f *FlagSet) BoolVarPWithDefaultValue(p *bool, name, shorthand string, value bool)
  • func (f *FlagSet) BoolVarWithDefaultValue(p *bool, name string, value bool)
  • func (f *FlagSet) IntVar(p *int, name string)
  • func (f *FlagSet) IntVarWithDefaultValue(p *int, name string, value int)
  • func (f *FlagSet) StringSliceVar(p *[]string, name string)
  • func (f *FlagSet) StringSliceVarP(p *[]string, name, shorthand string)
  • func (f *FlagSet) StringSliceVarPWithDefaultValue(p *[]string, name, shorthand string, value []string)
  • func (f *FlagSet) StringSliceVarWithDefaultValue(p *[]string, name string, value []string)
  • func (f *FlagSet) StringVar(p *string, name string)
  • func (f *FlagSet) StringVarP(p *string, name, shorthand string)
  • func (f *FlagSet) StringVarPWithDefaultValue(p *string, name, shorthand string, value string)
  • func (f *FlagSet) StringVarWithDefaultValue(p *string, name string, value string)
• type Option
  • func WithArgs(arg cobra.PositionalArgs) Option
  • func WithRun(run func(*cobra.Command, []string)) Option
  • func WithRunE(runE func(*cobra.Command, []string) error) Option
• type RpcServer

Constants

const DefaultFormat = "gofks"

Variables

var (
	TemplateRpc map[RpcServer]string
	TemplateApi map[ApiServer]string
)

Types

type ApiServer

type ApiServer string

const (
	TemplateApiServer        ApiServer = "TemplateApiServer"
	TemplateApiClient        ApiServer = "TemplateApiClient"
	TemplateApiControl       ApiServer = "TemplateApiControl"
	TemplateApiServerContext ApiServer = "TemplateApiServerContext"
	TemplateApiServerMain    ApiServer = "TemplateApiServerMain"
	TemplateApiServerWire    ApiServer = "TemplateApiServerWire"
)

type Command

type Command struct {
	*cobra.Command
}

func NewCommand

func NewCommand(use string, opts ...Option) *Command

NewCommand 新增一个 cobra 命令

func (*Command) AddCommand

func (c *Command) AddCommand(cmds ...*Command)

func (*Command) Flags

func (c *Command) Flags() *FlagSet

func (*Command) MustInit

func (c *Command) MustInit()

MustInit 用于初始化命令的帮助信息和用法 首先获取了命令本身及其所有递归的子命令，然后为每个命令设置 Short, Long, Example 文本， 以及遍历所有的标志（Flags 和 PersistentFlags）来设置它们的用法说明（Usage）

func (*Command) PersistentFlags

func (c *Command) PersistentFlags() *FlagSet

PersistentFlags 是cobra 库中 *cobra.Command 对象的一个方法，用于添加和获取那些应用于命令以及命令的所有子命令的标志（flags）。

例如，如果你有一个叫做 serve 的命令，它有一个子命令叫做 start，
当你给 serve 命令添加一个持久标志时（比如 --port），这个 --port 标志也可以在 serve start 命令中使用。

type FlagSet

type FlagSet struct {
	*pflag.FlagSet
}

func (*FlagSet) BoolVar

func (f *FlagSet) BoolVar(p *bool, name string)

func (*FlagSet) BoolVarP

func (f *FlagSet) BoolVarP(p *bool, name, shorthand string)

func (*FlagSet) BoolVarPWithDefaultValue

func (f *FlagSet) BoolVarPWithDefaultValue(p *bool, name, shorthand string, value bool)

func (*FlagSet) BoolVarWithDefaultValue

func (f *FlagSet) BoolVarWithDefaultValue(p *bool, name string, value bool)

func (*FlagSet) IntVar

func (f *FlagSet) IntVar(p *int, name string)

func (*FlagSet) IntVarWithDefaultValue

func (f *FlagSet) IntVarWithDefaultValue(p *int, name string, value int)

func (*FlagSet) StringSliceVar

func (f *FlagSet) StringSliceVar(p *[]string, name string)

func (*FlagSet) StringSliceVarP

func (f *FlagSet) StringSliceVarP(p *[]string, name, shorthand string)

func (*FlagSet) StringSliceVarPWithDefaultValue

func (f *FlagSet) StringSliceVarPWithDefaultValue(p *[]string, name, shorthand string, value []string)

func (*FlagSet) StringSliceVarWithDefaultValue

func (f *FlagSet) StringSliceVarWithDefaultValue(p *[]string, name string, value []string)

func (*FlagSet) StringVar

func (f *FlagSet) StringVar(p *string, name string)

func (*FlagSet) StringVarP

func (f *FlagSet) StringVarP(p *string, name, shorthand string)

func (*FlagSet) StringVarPWithDefaultValue

func (f *FlagSet) StringVarPWithDefaultValue(p *string, name, shorthand string, value string)

func (*FlagSet) StringVarWithDefaultValue

func (f *FlagSet) StringVarWithDefaultValue(p *string, name string, value string)

type Option

type Option func(*cobra.Command)

func WithArgs

func WithArgs(arg cobra.PositionalArgs) Option

func WithRun

func WithRun(run func(*cobra.Command, []string)) Option

func WithRunE

func WithRunE(runE func(*cobra.Command, []string) error) Option

type RpcServer

type RpcServer string

const (
	TemplateRpcServer        RpcServer = "TemplateRpcServer"
	TemplateRpcServerClient  RpcServer = "TemplateRpcServerClient"
	TemplateRpcServerLogic   RpcServer = "TemplateRpcServerLogic"
	TemplateRpcServerProtoc  RpcServer = "TemplateRpcServerProtoc"
	TemplateRpcServerContext RpcServer = "TemplateRpcServerContext"
	TemplateRpcServerMain    RpcServer = "TemplateRpcServerMain"
	TemplateRpcServerWire    RpcServer = "TemplateRpcServerWire"
)