renderer

Documentation

Overview

Package renderer implements data-driven templates for generating textual output

The renderer extends the standard golang text/template and sprig functions.

Templates are executed by applying them to a data structure (configuration). Values in the template refer to elements of the data structure (typically a field of a struct or a key in a map).

Actions can be combined using UNIX-like pipelines.

The input text for a template is UTF-8-encoded text in any format.

See renderer.ExtraFunctions for our custom functions.

Detailed documentation on the syntax and available functions can be found here:

• https://golang.org/pkg/text/template
• http://masterminds.github.io/sprig
• https://godoc.org/github.com/VirtusLab/render/renderer#ExtraFunctions
• https://godoc.org/github.com/VirtusLab/render/renderer#Renderer.NestedRender
• https://godoc.org/github.com/VirtusLab/render/renderer#Renderer.ReadFile

Index

• func ExtraFunctions() template.FuncMap
• func Gzip(input interface{}) (string, error)
• func MergeFunctions(dst *template.FuncMap, src template.FuncMap) error
• func ToYaml(marshallable interface{}) (string, error)
• func Ungzip(input interface{}) (string, error)
• func WithCryptFunctions() func(*config.Config)
• func WithDelim(left, right string) func(*config.Config)
• func WithExtraFunctions() func(*config.Config)
• func WithFunctions(extraFunctions template.FuncMap) func(*config.Config)
• func WithMoreFunctions(moreFunctions template.FuncMap) func(*config.Config)
• func WithMoreParameters(extraParams ...map[string]interface{}) func(*config.Config)
• func WithOptions(options ...string) func(*config.Config)
• func WithParameters(parameters map[string]interface{}) func(*config.Config)
• func WithSprigFunctions() func(*config.Config)
• type Renderer
  • func New(configurators ...func(*config.Config)) Renderer

Functions

func ExtraFunctions

func ExtraFunctions() template.FuncMap

ExtraFunctions provides additional template functions to the standard (text/template) ones:

• toYaml - provides a configuration data structure fragment as a YAML format
• gzip - use gzip compression inside the templates, for best results use with b64enc
• ungzip - use gzip extraction inside the templates, for best results use with b64dec

func Gzip

func Gzip(input interface{}) (string, error)

Gzip compresses the input using gzip algorithm

func MergeFunctions

func MergeFunctions(dst *template.FuncMap, src template.FuncMap) error

MergeFunctions merges two template.FuncMap instances, overrides if necessary

func ToYaml

func ToYaml(marshallable interface{}) (string, error)

ToYaml is a template function, it turns a marshallable structure into a YAML fragment

func Ungzip

func Ungzip(input interface{}) (string, error)

Ungzip un-compresses the input using gzip algorithm

func WithCryptFunctions

func WithCryptFunctions() func(*config.Config)

WithCryptFunctions mutates Renderer configuration by merging the Crypt template functions

func WithDelim

func WithDelim(left, right string) func(*config.Config)

WithDelim mutates Renderer configuration by replacing the left and right delimiters

func WithExtraFunctions

func WithExtraFunctions() func(*config.Config)

WithExtraFunctions mutates Renderer configuration by merging the custom template functions

func WithFunctions

func WithFunctions(extraFunctions template.FuncMap) func(*config.Config)

WithFunctions mutates Renderer configuration by replacing the template functions

func WithMoreFunctions

func WithMoreFunctions(moreFunctions template.FuncMap) func(*config.Config)

WithMoreFunctions mutates Renderer configuration by merging the given template functions,

func WithMoreParameters

func WithMoreParameters(extraParams ...map[string]interface{}) func(*config.Config)

WithMoreParameters mutates Renderer configuration by merging the given template parameters

func WithOptions

func WithOptions(options ...string) func(*config.Config)

WithOptions mutates Renderer configuration by replacing the template functions

func WithParameters

func WithParameters(parameters map[string]interface{}) func(*config.Config)

WithParameters mutates Renderer configuration by replacing all template parameters

func WithSprigFunctions

func WithSprigFunctions() func(*config.Config)

WithSprigFunctions mutates Renderer configuration by merging the Sprig template functions

Types

type Renderer

type Renderer interface {
	base.Renderer
	Clone(configurators ...func(*config.Config)) Renderer
	FileRender(inputPath, outputPath string) error
	DirRender(inputDir, outputDir string) error
	NestedRender(args ...interface{}) (string, error)
	ReadFile(file string) (string, error)
}

Renderer allows for parameterised text template rendering

func New

func New(configurators ...func(*config.Config)) Renderer

New creates a new renderer with the specified parameters and zero or more options