template

Documentation

Index

• type Append
• type Appends
• type Delete
• type Deletes
• type Edits
• type Move
• type Moves
• type Params
  • func (p Params) Has(param string) bool
• type Replace
• type Replaces
• type Service
  • func NewService(ui ui.UI) *Service
  • func (s *Service) Load(path string) error
  • func (s *Service) Params() Params
  • func (s *Service) Template(inputs interface{}) (*Template, error)
• type Template
  • func (t *Template) Execute(u ui.UI, root string) error

Types

type Append

type Append struct {
	Filepath string `yaml:"filepath"`
	Content  string `yaml:"content"`
}

Append is used for adding content to files.

type Appends

type Appends []Append

Appends is the type for a slice of Append type.

type Delete

type Delete struct {
	Glob string
}

Delete is used for deteling files or directories.

type Deletes

type Deletes []Delete

Deletes is the type for a slice of Delete type.

type Edits

type Edits struct {
	Deletes  Deletes  `yaml:"deletes"`
	Moves    Moves    `yaml:"moves"`
	Appends  Appends  `yaml:"appends"`
	Replaces Replaces `yaml:"replaces"`
}

Edits define all the required edits for a template.

type Move

type Move struct {
	Src  string `yaml:"src"`
	Dest string `yaml:"dest"`
}

Move is used for moving (renaming) a file or directory.

type Moves

type Moves []Move

Moves is the type for a slice of Move type.

type Params

type Params []string

Params define required params for a template.

func (Params) Has

func (p Params) Has(param string) bool

type Replace

type Replace struct {
	Filepath string `yaml:"filepath"`
	Old      string `yaml:"old"`
	New      string `yaml:"new"`
}

Replace is used for replacing content in files.

type Replaces

type Replaces []Replace

Replaces is the type for a slice of Replace type.

type Service

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

Service

func NewService

func NewService(ui ui.UI) *Service

NewService creates a new template service.

func (*Service) Load

func (s *Service) Load(path string) error

Load reads a template YAML file and makes it available for other methods.

func (*Service) Params

func (s *Service) Params() Params

func (*Service) Template

func (s *Service) Template(inputs interface{}) (*Template, error)

type Template

type Template struct {
	Name        string `yaml:"name"`
	Description string `yaml:"description"`
	Edits       Edits  `yaml:"edits"`
}

Template has all specifications for a Basil code template.

func (*Template) Execute

func (t *Template) Execute(u ui.UI, root string) error

Execute runs all the edits defined for the template.