sprig: github.com/Masterminds/sprig Index | Examples | Files

package sprig

import "github.com/Masterminds/sprig"

Sprig: Template functions for Go.

This package contains a number of utility functions for working with data inside of Go `html/template` and `text/template` files.

To add these functions, use the `template.Funcs()` method:

t := templates.New("foo").Funcs(sprig.FuncMap())

Note that you should add the function map before you parse any template files.

In several cases, Sprig reverses the order of arguments from the way they
appear in the standard library. This is to make it easier to pipe
arguments into functions.

See http://masterminds.github.io/sprig/ for more detailed documentation on each of the available functions.

Code:

// Set up variables and template.
vars := map[string]interface{}{"Name": "  John Jacob Jingleheimer Schmidt "}
tpl := `Hello {{.Name | trim | lower}}`

// Get the Sprig function map.
fmap := TxtFuncMap()
t := template.Must(template.New("test").Funcs(fmap).Parse(tpl))

err := t.Execute(os.Stdout, vars)
if err != nil {
    fmt.Printf("Error during template execution: %s", err)
    return
}

Output:

Hello john jacob jingleheimer schmidt

Index

Examples

Package Files

crypto.go date.go defaults.go dict.go doc.go functions.go list.go numeric.go reflect.go regex.go semver.go strings.go

func FuncMap Uses

func FuncMap() template.FuncMap

Produce the function map.

Use this to pass the functions into the template engine:

tpl := template.New("foo").Funcs(sprig.FuncMap()))

func GenericFuncMap Uses

func GenericFuncMap() map[string]interface{}

GenericFuncMap returns a copy of the basic function map as a map[string]interface{}.

func HermeticHtmlFuncMap Uses

func HermeticHtmlFuncMap() template.FuncMap

HermeticHtmlFuncMap returns an 'html/template'.Funcmap with only repeatable functions.

func HermeticTxtFuncMap Uses

func HermeticTxtFuncMap() ttemplate.FuncMap

HermeticTextFuncMap returns a 'text/template'.FuncMap with only repeatable functions.

func HtmlFuncMap Uses

func HtmlFuncMap() template.FuncMap

HtmlFuncMap returns an 'html/template'.Funcmap

func TxtFuncMap Uses

func TxtFuncMap() ttemplate.FuncMap

TextFuncMap returns a 'text/template'.FuncMap

type DSAKeyFormat Uses

type DSAKeyFormat struct {
    Version       int
    P, Q, G, Y, X *big.Int
}

Package sprig imports 39 packages (graph) and is imported by 108 packages. Updated 2018-09-19. Refresh now. Tools for package owners.