Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 2.04 KB

README.md

File metadata and controls

54 lines (39 loc) · 2.04 KB

##temple - intelligent template utilities for go

The html/template package is extremely powerful, but lacks many quality-of-life features that can make it tricky. This package adds some of these features:

  • A way to statically embed templates into your binary for production use, while still allowing editing without restarting your app while developing.
  • Rendering groups of templates together (Like rendering Header, Content, Footer in a single response)
  • Master / Child template execution.
  • Buffer pool built in to reduce garbage generated.
  • Nothing written to your http response until entire template is rendered successfully. No more partial responses on errors.

Usage:

Embed your templates:

go get github.com/captncraig/temple/templeGen

templeGen [pkg=myPackage] [var=myWebTemplates] -o=templates.go -dir=templates

This will generate a file (templates.go) with a map of template names to base-64 encoded template data for every file in the templates directory. It will include all top level files regardless of extension.

Create a TemplateStore

import (
	"flag"
	"log"

	"github.com/captncraig/temple"
)

var devMode = flag.Bool("dev", false, "activate dev mode for templates")
var templateManager temple.TemplateStore

func main() {
	flag.Parse()
	templateManager, err := temple.New(*devMode, myTemplates, "templates")
	if err != nil {
		log.Fatal(err)
	}
	...
}

The flag approach is only one way to activate dev-mode. Other ways are certainly possible. In dev-mode, the templateManager will load all template files any time any template is requested. This will ensure you always serve the latest version of all templates. If devMode is false, it will rely on its embedded, pre-parsed versions of the templates for maximum portability and performance.

Render templates

func Endpoint(w http.ResponseWriter, r *http.Response){
	ctx := GetMyData() // get data for template rendering
	err := templateManager.Execute(w, ctx, "myTemplate")
}
See example project for more detailed usage patterns, including master/child.