gonja

README

gonja

gonja is a pure go implementation of the Jinja template engine. It aims to be as compatible as possible with the original python implementation.

Usage

As a library

Install or update using go get:

go get github.com/ardanlabs/gonja

Example

package main

import (
	"os"
	"fmt"

	"github.com/ardanlabs/gonja"
	"github.com/ardanlabs/gonja/exec"
)

func main() {
	template, err := gonja.FromString("Hello {{ name | capitalize }}!")
	if err != nil {
		panic(err)
	}

	data := exec.NewContext(map[string]interface{}{
		"name": "bob",
	})

	if err = template.Execute(os.Stdout, data); err != nil { // Prints: Hello Bob!
		panic(err)
	}
}

Documentation

• For details on how the Jinja template language works, please refer to the Jinja documentation ;
• gonja API documentation is available on godoc ;
• filters: please refer to docs/filters.md ;
• control structures: please take a look at docs/control_structures.md ;
• tests: please see docs/tests.md ;
• global functions: please browse through docs/global_functions.md.
• global variables: please open docs/global_variables.md.
• methods: please take a peek at docs/methods.md.

Limitations

• format: format does not take python's string format syntax as a parameter, instead it takes Go's. Essentially {{ 3.14|stringformat:"pi is %.2f" }} is fmt.Sprintf("pi is %.2f", 3.14)
• escape / force_escape: Unlike Jinja's behavior, the escape-filter is applied immediately. Therefore there is no need for a force_escape filter
• Only subsets of native python types (bool, int, float, str, dict and list) methods have been re-implemented in Go and can slightly differ from the original ones

Development

Guidelines

Please read through the contribution guidelines before diving into any work.

Requirements

• Install go >= 1.26 by following the official documentation ;
• Install ginkgo by any means you see fit.

Tests

The unit tests can be run using:

ginkgo run -p ./...

Tribute

A massive thank you to the original author @noirbizarre for doing the initial work in https://github.com/noirbizarre/gonja which this project was forked from and @NikolaLohinski who has been maintaining the project since.

Documentation

Overview

Package gonja implements a Jinja2-like template engine for Go.

Index

• Variables
• func FromBytes(source []byte) (*exec.Template, error)
• func FromFile(filepath string) (*exec.Template, error)
• func FromString(source string) (*exec.Template, error)
• func SetLoggerLevel(level logrus.Level)
• func SetLoggerOutput(out io.Writer)
• type Config

Variables

var (
	DefaultLoader      = loaders.MustNewFileSystemLoader("")
	DefaultConfig      = config.New()
	DefaultContext     = exec.EmptyContext().Update(builtins.GlobalFunctions).Update(builtins.GlobalVariables)
	DefaultEnvironment = &exec.Environment{
		Context:           DefaultContext,
		Filters:           builtins.Filters,
		Tests:             builtins.Tests,
		ControlStructures: builtins.ControlStructures,
		Methods:           builtins.Methods,
	}
)

var NewConfig = config.New

Functions

func FromBytes

func FromBytes(source []byte) (*exec.Template, error)

func FromFile

func FromFile(filepath string) (*exec.Template, error)

func FromString

func FromString(source string) (*exec.Template, error)

func SetLoggerLevel

func SetLoggerLevel(level logrus.Level)

func SetLoggerOutput

func SetLoggerOutput(out io.Writer)

Types

type Config

type Config config.Config