htt parses Go templates into trees that keep source positions and HTML structure, and executes those trees. It accepts the templates text/template and html/template accept.
It was factored out of muxt, which uses it to type check templates, format them, and record which template nodes a package's tests reach.
Render pages for a browser with the standard library's html/template. htt runs templates so that tests and tools can see what a template produces and which parts of it ran. Its contextual escaping is not yet equivalent to html/template's. The documentation of ExecuteTemplate lists the known differences, for example:
- An action in attribute-name position, such as
<div {{.Name}}="x">, is written as escaped text instead of a tag with a filtered attribute name. - A text template called from an HTML template runs without the caller's escaping context.
- The value of a
styleorsrcdocattribute is not escaped for the CSS or HTML document it holds.
The aim is to close every difference and make htt/template a package you can serve from. Until then, treat its output as test data.
The API carries no compatibility promise; any release may change it.
| Import path | Provides |
|---|---|
github.com/typelate/htt |
The parser, the tree (actions, HTML elements, attributes and comments as nodes with positions), and the execution engine. |
github.com/typelate/htt/template |
The API of html/template over that engine. |
github.com/typelate/htt/lex |
The lexer both use. |
go get github.com/typelate/htthtt/template has the names html/template has:
package main
import (
"os"
"github.com/typelate/htt/template"
)
func main() {
t := template.Must(template.New("greeting.gohtml").Parse(`<p>Hello, {{.}}!</p>` + "\n"))
if err := t.Execute(os.Stdout, "<World>"); err != nil {
panic(err)
}
}<p>Hello, <World>!</p>
ParseTree returns a tree in which HTML elements are nodes beside the actions, each with its position in the source:
package main
import (
"fmt"
"github.com/typelate/htt"
"github.com/typelate/htt/lex"
)
func main() {
const src = "<ul>\n{{range .}}<li>{{.}}</li>{{end}}\n</ul>\n"
tree, err := htt.ParseTree("list.gohtml", "list.gohtml", src, map[string]*htt.Tree{}, lex.NewOptions())
if err != nil {
panic(err)
}
htt.Walk(tree, func(t *htt.Tree, n htt.Node) {
if el, ok := n.(*htt.HTMLElementNode); ok {
p := t.Position(n)
fmt.Printf("%s:%d:%d <%s>\n", p.ParseName, p.Line, p.Column, el.TagName)
}
})
}list.gohtml:1:1 <ul>
list.gohtml:2:12 <li>
When the environment variable MUXT_TEMPLATE_COVER names a directory as the process starts, each execution through htt/template appends the template blocks it reaches to <dir>/<pid>.cov, in the format of a Go cover profile. muxt test-template-mutations sets it for its coverage pre-pass. Unset, nothing is written.
MIT; see LICENSE.md. Parts derive from the Go standard library's text/template and html/template, which carry Go's BSD-style license.