cli

Documentation

Index

• func ValidateTagName(tagName string) error
• type Command
• type CommandName
• type CommandNames
  • func (commandNames CommandNames) Len() int
  • func (commandNames CommandNames) Less(i, j int) bool
  • func (commandNames CommandNames) Swap(i, j int)
• type Option
• type Options
  • func (options Options) Get(name string) *Option
  • func (options Options) HasOption(name string) bool
• type Parser
  • func NewParser(globalOptions Options, commandByName map[CommandName]Command) *Parser
  • func (parser *Parser) Parse(args []string) (commandName CommandName, options Options, arguments []string, err error)

Functions

func ValidateTagName

func ValidateTagName(tagName string) error

Types

type Command

type Command interface {
	Name() CommandName
	Synopsis() string
	Description() string
	Options() Options
	Exec(options Options, args []string) error
}

type CommandName

type CommandName string

type CommandNames

type CommandNames []CommandName

func (CommandNames) Len

func (commandNames CommandNames) Len() int

func (CommandNames) Less

func (commandNames CommandNames) Less(i, j int) bool

func (CommandNames) Swap

func (commandNames CommandNames) Swap(i, j int)

type Option

type Option struct {
	LongName    string
	ShortName   string
	Description string
	HasArgument bool
	Argument    string
}

type Options

type Options []Option

func (Options) Get

func (options Options) Get(name string) *Option

func (Options) HasOption

func (options Options) HasOption(name string) bool

type Parser

type Parser struct {
	// contains filtered or unexported fields
}

func NewParser

func NewParser(globalOptions Options, commandByName map[CommandName]Command) *Parser

func (*Parser) Parse

func (parser *Parser) Parse(args []string) (commandName CommandName, options Options, arguments []string, err error)