README
¶
Mustache Template Engine for Go
Why a Fork?
I forked hoisie/mustache because it does not appear to be maintained, and I wanted to add the following functionality:
- Update the API to follow the idiomatic Go convention of returning errors (this is a breaking change)
- Add option to treat missing variables as errors
Overview
This library is an implementation of the Mustache template language in Go.
Mustache Spec Compliance
https://github.com/mustache/spec contains the formal standard for Mustache, and it is added as a submodule (using v1.1.3) for testing compliance. Currently ~40% of tests are failing, and the optional lambda support is not implemented. You can see which tests are disabled (b/c they are failing) by looking at spec_test.go. Getting all tests passing is my top priority (time permitting), and any PRs to that end are welcome.
Documentation
For more information about mustache, check out the mustache project page or the mustache manual.
Also check out some example mustache files
Installation
To install mustache.go, simply run go get github.com/cbroglie/mustache. To use it in a program, use import "github.com/cbroglie/mustache"
Usage
There are four main methods in this package:
Render(data string, context ...interface{}) (string, error)
RenderFile(filename string, context ...interface{}) (string, error)
ParseString(data string) (*Template, error)
ParseFile(filename string) (*Template, error)
There are also two additional methods for using layouts (explained below).
The Render method takes a string and a data source, which is generally a map or struct, and returns the output string. If the template file contains an error, the return value is a description of the error. There's a similar method, RenderFile, which takes a filename as an argument and uses that for the template contents.
data, err := mustache.Render("hello {{c}}", map[string]string{"c": "world"})
If you're planning to render the same template multiple times, you do it efficiently by compiling the template first:
tmpl, _ := mustache.ParseString("hello {{c}}")
var buf bytes.Buffer
for i := 0; i < 10; i++ {
tmpl.Render(map[string]string{"c": "world"}, &buf)
}
For more example usage, please see mustache_test.go
Escaping
mustache.go follows the official mustache HTML escaping rules. That is, if you enclose a variable with two curly brackets, {{var}}, the contents are HTML-escaped. For instance, strings like 5 > 2 are converted to 5 > 2. To use raw characters, use three curly brackets {{{var}}}.
Layouts
It is a common pattern to include a template file as a "wrapper" for other templates. The wrapper may include a header and a footer, for instance. Mustache.go supports this pattern with the following two methods:
RenderInLayout(data string, layout string, context ...interface{}) (string, error)
RenderFileInLayout(filename string, layoutFile string, context ...interface{}) (string, error)
The layout file must have a variable called {{content}}. For example, given the following files:
layout.html.mustache:
<html>
<head><title>Hi</title></head>
<body>
{{{content}}}
</body>
</html>
template.html.mustache:
<h1>Hello World!</h1>
A call to RenderFileInLayout("template.html.mustache", "layout.html.mustache", nil) will produce:
<html>
<head><title>Hi</title></head>
<body>
<h1>Hello World!</h1>
</body>
</html>
A note about method receivers
Mustache.go supports calling methods on objects, but you have to be aware of Go's limitations. For example, lets's say you have the following type:
type Person struct {
FirstName string
LastName string
}
func (p *Person) Name1() string {
return p.FirstName + " " + p.LastName
}
func (p Person) Name2() string {
return p.FirstName + " " + p.LastName
}
While they appear to be identical methods, Name1 has a pointer receiver, and Name2 has a value receiver. Objects of type Person(non-pointer) can only access Name2, while objects of type *Person(person) can access both. This is by design in the Go language.
So if you write the following:
mustache.Render("{{Name1}}", Person{"John", "Smith"})
It'll be blank. You either have to use &Person{"John", "Smith"}, or call Name2
Supported features
- Variables
- Comments
- Change delimiter
- Sections (boolean, enumerable, and inverted)
- Partials
Documentation
¶
Index ¶
- Variables
- func Render(data string, context ...interface{}) (string, error)
- func RenderFile(filename string, context ...interface{}) (string, error)
- func RenderFileInLayout(filename string, layoutFile string, context ...interface{}) (string, error)
- func RenderInLayout(data string, layoutData string, context ...interface{}) (string, error)
- type Tag
- type TagType
- type Template
Constants ¶
This section is empty.
Variables ¶
var ( // AllowMissingVariables defines the behavior for a variable "miss." If it // is true (the default), an empty string is emitted. If it is false, an error // is generated instead. AllowMissingVariables = true )
Functions ¶
func Render ¶
Render compiles a mustache template string and uses the the given data source - generally a map or struct - to render the template and return the output.
func RenderFile ¶
RenderFile loads a mustache template string from a file and compiles it, and then uses the the given data source - generally a map or struct - to render the template and return the output.
func RenderFileInLayout ¶
RenderFileInLayout loads a mustache template string and layout "wrapper" template string from files and compiles them, and then uses the the given data source - generally a map or struct - to render the compiled templates and return the output.
func RenderInLayout ¶
RenderInLayout compiles a mustache template string and layout "wrapper" and uses the given data source - generally a map or struct - to render the compiled templates and return the output.
Types ¶
type Tag ¶
type Tag interface {
// Type returns the type of the tag.
Type() TagType
// Name returns the name of the tag.
Name() string
// Tags returns any child tags. It panics for tag types which cannot contain
// child tags (i.e. variable tags).
Tags() []Tag
}
Tag represents the different mustache tag types.
Not all methods apply to all kinds of tags. Restrictions, if any, are noted in the documentation for each method. Use the Type method to find out the type of tag before calling type-specific methods. Calling a method inappropriate to the type of tag causes a run time panic.
type TagType ¶
type TagType uint
A TagType represents the specific type of mustache tag that a Tag represents. The zero TagType is not a valid type.
Defines representing the possible Tag types
type Template ¶
type Template struct {
// contains filtered or unexported fields
}
Template represents a compilde mustache template
func ParseFile ¶
ParseFile loads a mustache template string from a file and compiles it. The resulting output can be used to efficiently render the template multiple times with different data sources.
func ParseString ¶
ParseString compiles a mustache template string. The resulting output can be used to efficiently render the template multiple times with different data sources.
func (*Template) Render ¶
Render uses the given data source - generally a map or struct - to render the compiled template and return the output.
func (*Template) RenderInLayout ¶
RenderInLayout uses the given data source - generally a map or struct - to render the compiled template and layout "wrapper" template and return the output.
Source Files