template

Documentation

Overview

Package template contains methods that will template go text/templates files that may contain sjs snippets.

Index

• type Context
• type ReadFunc
• type Templator
  • func (t *Templator) Recurse(_ VM, numTimes int) (out string, err error)
  • func (t *Templator) SetContextData(contextData any, globalComputed goja.Value)
  • func (t *Templator) TemplateFile(ctx context.Context, vm VM, templateFile, outFile string, inputData any) error
  • func (t *Templator) TemplateString(ctx context.Context, vm VM, templatePath string, inputData any) (out string, err error)
  • func (t *Templator) TemplateStringInput(ctx context.Context, vm VM, name string, input string, inputData any) (out string, err error)
• type VM
• type WriteFunc

Types

type Context

type Context struct {
	Global            any
	Local             any
	GlobalComputed    goja.Value
	LocalComputed     goja.Value
	RecursiveComputed goja.Value
}

Context is the context that is passed templates or js.

type ReadFunc

type ReadFunc func(string) ([]byte, error)

ReadFunc represents a function that reads a file.

type Templator

type Templator struct {
	WriteFunc WriteFunc
	ReadFunc  ReadFunc
	TmplFuncs map[string]any
	Debug     bool
	// contains filtered or unexported fields
}

Templator extends the go text/template package to allow for sjs snippets.

func (*Templator) Recurse

func (t *Templator) Recurse(_ VM, numTimes int) (out string, err error)

Recurse will let the engine know how many times the template should execute.

func (*Templator) SetContextData

func (t *Templator) SetContextData(contextData any, globalComputed goja.Value)

SetContextData allows the setting of global context for templating.

func (*Templator) TemplateFile

func (t *Templator) TemplateFile(ctx context.Context, vm VM, templateFile, outFile string, inputData any) error

TemplateFile will template a file and write the output to outFile.

func (*Templator) TemplateString

func (t *Templator) TemplateString(ctx context.Context, vm VM, templatePath string, inputData any) (out string, err error)

TemplateString will template the provided file and return the output as a string.

func (*Templator) TemplateStringInput

func (t *Templator) TemplateStringInput(ctx context.Context, vm VM, name string, input string, inputData any) (out string, err error)

TemplateStringInput will template the provided input string and return the output as a string.

type VM

type VM interface {
	Get(name string) goja.Value
	Set(name string, value any) error
	Run(ctx context.Context, name string, src string, opts ...vm.Option) (goja.Value, error)
	ToObject(val goja.Value) *goja.Object
}

VM represents a virtual machine that can be used to run js.

type WriteFunc

type WriteFunc func(string, []byte) error

WriteFunc represents a function that writes a file.