package sprig

import "github.com/Masterminds/sprig/v3"

Package sprig provides 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 := template.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.

{
	// 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
}

Hello john jacob jingleheimer schmidt

Index ¶

• func FuncMap() template.FuncMap
• func GenericFuncMap() map[string]interface{}
• func HermeticHtmlFuncMap() template.FuncMap
• func HermeticTxtFuncMap() ttemplate.FuncMap
• func HtmlFuncMap() template.FuncMap
• func TxtFuncMap() ttemplate.FuncMap
• type DSAKeyFormat

Examples ¶

• package

Functions ¶

func FuncMap ¶

func FuncMap() template.FuncMap

FuncMap produces the function map.

Use this to pass the functions into the template engine:

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

func GenericFuncMap ¶

func GenericFuncMap() map[string]interface{}

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

func HermeticHtmlFuncMap ¶

func HermeticHtmlFuncMap() template.FuncMap

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

func HermeticTxtFuncMap ¶

func HermeticTxtFuncMap() ttemplate.FuncMap

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

func HtmlFuncMap ¶

func HtmlFuncMap() template.FuncMap

HtmlFuncMap returns an 'html/template'.Funcmap

func TxtFuncMap ¶

func TxtFuncMap() ttemplate.FuncMap

TxtFuncMap returns a 'text/template'.FuncMap

Types ¶

type DSAKeyFormat ¶

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

DSAKeyFormat stores the format for DSA keys. Used by pemBlockForKey

Source Files ¶

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