codegen

Documentation

Index

• type Template
  • func NewTemplate(mappings template.FuncMap) *Template
  • func (t *Template) Generate(fileName string, optGenerator ...func() (string, error)) error
  • func (t *Template) GenerateContent() (string, error)
  • func (t *Template) Parse(fileName string) error

Types

type Template

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

Template is a wrapper around the text/template package that provides a generic way for generating files according to the "go generate" pattern.

In addition to the standard template delimiters (https://pkg.go.dev/text/template), it supports /*{{ ... }}*/, which allows to "hide" template code in go comments. Data is provided to the template as function pipelines.

func NewTemplate

func NewTemplate(mappings template.FuncMap) *Template

NewTemplate creates a new Template with the given pipeline mappings.

func (*Template) Generate

func (t *Template) Generate(fileName string, optGenerator ...func() (string, error)) error

Generate generates the file with the given fileName (it can receive an optional generator function that overrides the way the content is generated).

func (*Template) GenerateContent

func (t *Template) GenerateContent() (string, error)

GenerateContent generates the dynamic content of the file by processing the template.

func (*Template) Parse

func (t *Template) Parse(fileName string) error

Parse parses the given file and extracts the header and content by splitting the file at the "go:generate" directive. It automatically removes existing "//go:build ignore" directives from the header.