engine

Documentation

Overview

Package engine provides a simple templating engine for scaffolding projects.

Index

• Variables
• func IsValidIdentifier(s string) bool
• type Engine
  • func New() *Engine
  • func (e *Engine) Factory(reader io.Reader) (*template.Template, error)
  • func (e *Engine) Render(w io.Writer, tmpl *template.Template, vars any) error
  • func (e *Engine) TmplString(str string, vars any) (string, error)
• type Vars

Variables

var ErrTemplateIsEmpty = fmt.Errorf("template is empty")

ErrTemplateIsEmpty is returned when a provided reader is empty.

Functions

func IsValidIdentifier

func IsValidIdentifier(s string) bool

Types

type Engine

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

func New

func New() *Engine

func (*Engine) Factory

func (e *Engine) Factory(reader io.Reader) (*template.Template, error)

Factory returns a new template from the provided reader. if the reader is empty, an ErrTemplateIsEmpty is returned.

func (*Engine) Render

func (e *Engine) Render(w io.Writer, tmpl *template.Template, vars any) error

func (*Engine) TmplString

func (e *Engine) TmplString(str string, vars any) (string, error)

type Vars

type Vars map[string]any