schema

Documentation

Index

• type Argument
  • func (a *Argument) Validate() error
• type Command
  • func (c *Command) Validate() error
• type Option
  • func (o *Option) Validate() error
• type Program
  • func (program *Program) Command() *Command
  • func (p *Program) Validate() error
• type Schema
  • func Load(reader io.Reader) (*Schema, error)
  • func (s *Schema) Find(subcommandPath []string) *Command
  • func (s *Schema) Save(writer io.Writer) error
  • func (s *Schema) Validate() error
  • func (s *Schema) Walk(f func(path name.Path, cmd *Command) error) error
• type Type
  • func (typ Type) Validate() error

Types

type Argument

type Argument struct {
	Name        string `yaml:"name"`
	Description string `yaml:"description"`
	Type        Type   `yaml:"type"`
	Variadic    bool   `yaml:"variadic"`
}

func (*Argument) Validate

func (a *Argument) Validate() error

type Command

type Command struct {
	Description string              `yaml:"description"`
	Options     map[string]*Option  `yaml:"options"`
	Arguments   []*Argument         `yaml:"arguments"`
	Subcommands map[string]*Command `yaml:"subcommands"`
}

func (*Command) Validate

func (c *Command) Validate() error

type Option

type Option struct {
	Short       string `yaml:"short"`
	Description string `yaml:"description"`
	Type        Type   `yaml:"type"`
	Default     string `yaml:"default"`
}

func (*Option) Validate

func (o *Option) Validate() error

type Program

type Program struct {
	Name        string              `yaml:"name"`
	Version     string              `yaml:"version"`
	Description string              `yaml:"description"`
	Options     map[string]*Option  `yaml:"options"`
	Arguments   []*Argument         `yaml:"arguments"`
	Subcommands map[string]*Command `yaml:"subcommands"`
}

func (*Program) Command

func (program *Program) Command() *Command

func (*Program) Validate

func (p *Program) Validate() error

type Schema

type Schema struct {
	Program Program
}

func Load

func Load(reader io.Reader) (*Schema, error)

func (*Schema) Find

func (s *Schema) Find(subcommandPath []string) *Command

func (*Schema) Save

func (s *Schema) Save(writer io.Writer) error

func (*Schema) Validate

func (s *Schema) Validate() error

func (*Schema) Walk

func (s *Schema) Walk(f func(path name.Path, cmd *Command) error) error

type Type

type Type string

const (
	TypeUnspecified Type = ""
	TypeString      Type = "string"
	TypeInteger     Type = "integer"
	TypeFloat       Type = "float"
	TypeBoolean     Type = "boolean"
)

func (Type) Validate

func (typ Type) Validate() error