Skip to content

AlteranAncient/stick

 
 

Repository files navigation

Stick

Build Status GoDoc

A Go language port of the Twig templating engine.

Introduction

Twig is a powerful templating language that supports macros, vertical and horizontal reuse, and an easy-to-learn syntax that promotes separation of logic and markup. Twig is also extremely extensible, and by default will autoescape content based on content type.

Stick brings these great features to Go projects.

Current status

In development

Stick is currently quite usable except for a few important missing features: autoescaping, whitespace control, and proper error handling.

Stick is made up of three main parts: a lexer, a parser, and a template executor. Stick's lexer and parser are complete. Template execution is under development, but most functionality is complete.

See the to do list for additional information.

Installation

Stick is intended to be used as a library. The recommended way to install the library is using go get.

go get -u github.com/tyler-sommer/stick

Usage

Execute a simple Stick template.

package main

import (
	"github.com/tyler-sommer/stick"
	"os"
)

func main() {
    env := stick.NewEnv(nil)
	env.Execute("Hello, {{ name }}!", os.Stdout, map[string]stick.Value{"name": "Tyler"})
}

See godoc for more information.

To do

  • Autoescaping
  • Whitespace control
  • Improve error reporting
Further
  • Improve test coverage (especially error cases)
  • Custom operators and tags
  • Sandbox
  • Generate native Go code from a given parser tree

About

A golang port of the Twig templating engine

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 99.5%
  • HTML 0.5%