common

package

v0.0.0-...-17df793 Latest Latest Go to latest Published: Feb 8, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/bhmy-shm/gofks

Documentation ¶

Index ¶

Constants
Variables
type ApiServer
type Command
- func NewCommand(use string, opts ...Option) *Command
type FlagSet
type Option
type RpcServer

Constants ¶

View Source

const DefaultFormat = "gofks"

Variables ¶

View Source

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

Functions ¶

This section is empty.

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"
)

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
ctx
env
flags
format
pathx
test
utils
version
zipx

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL