clitag

Documentation

Index

• Constants
• Variables
• type Parser
  • func (p *Parser) Parse(v interface{}) ([]StructField, error)
  • func (p *Parser) ParseField(parent StructField, f reflect.StructField) ([]StructField, error)
  • func (p *Parser) ParseFields(parent StructField, tp reflect.Type) ([]StructField, error)
• type ParserConfig
• type StructField
  • func Parse(v interface{}) ([]StructField, error)
• type Tag
  • func (t Tag) AliasesString() string
  • func (t Tag) LongDescription() string
  • func (t Tag) OptionsString() string

Constants

const DefaultTagName = "cli"

DefaultTagName ftagのデフォルト名

Variables

var DefaultParser = &Parser{Config: &ParserConfig{TagName: DefaultTagName}}

Types

type Parser

type Parser struct {
	Config *ParserConfig
}

Parser ftagのパーサー

func (*Parser) Parse

func (p *Parser) Parse(v interface{}) ([]StructField, error)

Parse ftagをパースする

func (*Parser) ParseField

func (p *Parser) ParseField(parent StructField, f reflect.StructField) ([]StructField, error)

func (*Parser) ParseFields

func (p *Parser) ParseFields(parent StructField, tp reflect.Type) ([]StructField, error)

type ParserConfig

type ParserConfig struct {
	TagName    string
	OptionsMap map[string][]string // 指定可能な値(オプション)参照用のマップ
}

ParserConfig パーサ設定

type StructField

type StructField struct {
	reflect.StructField
	Tag
}

Field reflect.StructField + Tag

func Parse

func Parse(v interface{}) ([]StructField, error)

Parse デフォルトのParser(タグ名:cli)でftagをパースする

type Tag

type Tag struct {
	FlagName       string
	FieldName      string
	Aliases        []string
	Shorthand      string
	Description    string
	Squash         bool
	Ignore         bool
	Category       string
	Order          int
	Options        []string // 設定可能な値のリスト
	DisplayOptions []string // 表示用
}

Tag structにつけられたftagの値

例: タグが`example,aliases=foo bar,short=e,desc=foobar`の場合 - FlagName: example - Aliases: foo, bar - Shorthand: e - Description: foobar - Squash: false - Ignore: false - Category: (empty) - Order: 0

func (Tag) AliasesString

func (t Tag) AliasesString() string

func (Tag) LongDescription

func (t Tag) LongDescription() string

LongDescription DescriptionにAliasesとOptionsを連結して返す

func (Tag) OptionsString

func (t Tag) OptionsString() string