schema

Documentation

Index

• Variables
• type Parameter
• type Schema
  • func New(dir string) *Schema
  • func (s *Schema) AutomaticEnv(interactive bool) error
  • func (s *Schema) LoadSchema() error
  • func (s Schema) Show(o io.Writer)

Variables

var (

	// ErrCancelInput is a signal to break the interactive inputing process.
	ErrCancelInput = errors.New("cancel interactive inputing process")
)

var (
	// ErrNotExist means no input schema for interactive prompt.
	ErrNotExist = errors.New("no schema found in current satck")
)

Types

type Parameter

type Parameter struct {
	Title       string `yaml:"title"`
	Description string `yaml:"description"`
	Type        string `yaml:"type"`
	Key         string `yaml:"key"`
	Value       string `yaml:"value"`
	Default     string `yaml:"default"`
	Required    bool   `yaml:"required"`
}

Parameter is a field in the schema.

type Schema

type Schema struct {
	// Dir is the path to stack! Not schema directly.
	Dir        string
	Parameters []Parameter `yaml:"parameters"`
}

Schema represents a input schema of a stack.

func New

func New(dir string) *Schema

New creates and returns a schema.

func (*Schema) AutomaticEnv

func (s *Schema) AutomaticEnv(interactive bool) error

AutomaticEnv sets envs automatically.

func (*Schema) LoadSchema

func (s *Schema) LoadSchema() error

LoadSchema reads the schema

func (Schema) Show

func (s Schema) Show(o io.Writer)

Show displays the info of input shcema.