README
¶
bindflags
Quickly bind the structure to a cobra-cli comoand or pflag flagset
快速将结构绑定到 cobra-cli comoand 或 pflag 标志集
Usage
go get github.com/Li-giegie/bindflags
func TestBindFlags(t *testing.T) {
f := pflag.NewFlagSet("test", pflag.ContinueOnError)
s := new(student)
MustBindFlags(f, s)
f.PrintDefaults()
// -a, --age int age
// -d, --desc string desc
// -n, --name string name (default "ss")
// -s, --sex sex (default true)
//PASS
}
type student struct {
Name string `flag:"Name:name;shorthand:n;value:ss;usage:name of student"`
Age int `flag:"age;a;0;usage:age of student"`
Sex bool `flag:"sex;s;true;sex"`
Desc studentDesc
}
type studentDesc string
func (s studentDesc) GetFlagTag() IFlagTag {
return &FlagTag{
Name: "desc",
Shorthand: "d",
Value: "",
Usage: "student description",
}
}
Documentation
¶
Index ¶
- Variables
- func BindFlags(f *flag.FlagSet, a any, group ...string) error
- func BindPFlags(flag *pflag.FlagSet, a any, group ...string) error
- func MustBindFlags(f *flag.FlagSet, a any, group ...string)
- func MustBindPFlags(flag *pflag.FlagSet, a any)
- type FlagTag
- type GetFlagTag
- type GetPFlagTag
- type IFlagTag
- type IpFlagTag
- type PFlagTag
Constants ¶
This section is empty.
Variables ¶
var TagName = "flag"
Functions ¶
func BindPFlags ¶
BindPFlags binds the struct member field to the cobra flag, and the struct input parameter must be a pointer type; Add a declaration to the tag of the field such as Key-value pair:Name string 'flag:"Name:name; shorthand:n; value:ss; usage:name of student"` No key: Name string 'flag:"name; n; ss; name of student"` Blend mode: "Name string 'flag:"Name:name; n; ss; name of student"`” Or define a custom type, and then implement the GetFlagTag interface for the type BindFlags 把结构体成员字段绑定到cobra FlagSet中，结构体入参必须是指针类型；在字段的tag加上声明如 键值对：Name string `flag:"Name:name;shorthand:n;value:ss;usage:name of student"` 无键值：Name string `flag:"name;n;ss;name of student"` 混合模式： “Name string `flag:"Name:name;n;ss;name of student"`” 再或者 定义一个自定义类型，然后给类型实现 GetFlagTag 接口
func MustBindPFlags ¶
Types ¶
type GetFlagTag ¶
type GetFlagTag interface {
GetFlagTag() IFlagTag
}
type GetPFlagTag ¶
type GetPFlagTag interface {
GetPFlagTag() IpFlagTag
}
Source Files