ginger
An implementation of the Jinja2 template language in Haskell
https://ginger.tobiasdammers.nl/
| Version on this page: | 0.9.1.0 |
| LTS Haskell 22.39: | 0.10.5.2 |
| Stackage Nightly 2023-12-26: | 0.10.5.2 |
| Latest on Hackage: | 0.10.5.2 |
ginger-0.9.1.0@sha256:dc19f586eff45161a0e4f1099eb26937c45bf7c993c77d21ad27b48696b283da,3766Ginger
A Haskell implementation of the Jinja2 template language.
A note of warning: the git repository at https://bitbucket.org/tdammers/ginger has been deleted and restored with a rewritten commit tree on 2016-04-06 in order to clean up the messy history. This means that if you have a checkout from before that date, merging the bitbucket repo will most likely break things; please do a fresh clone to fix this. Sorry for the inconvenience.
Introduction
Ginger provides most of the original Jinja2 template language, as much as that makes sense in a Haskell host application.
We do, however, avoid some of the most blatant Pythonisms, especially where we felt the features in question were more of an accidental result of binding template constructs to Python constructs.
On top of that, we deviate on a few points, and add some features that we think are very useful and help make the language better and more consistent.
Installation
Ginger is available from Hackage, and it is in Stackage, so you can use it in plain Cabal projects as well as Stack ones.
Installing with Cabal:
cabal install ginger
Installing with Stack:
stack install ginger
Using as part of another project:
Add the following to your .cabal’s build-depends:
ginger >=0.7.4.0 && <0.8
Template Syntax
Full template syntax documentation is available from the /docs subdirectory
in the project repository itself, or from the User Guide section on the
Ginger website.
Minimal example template
<!DOCTYPE html>
<html>
<head>
<title>{{ title }}</title>
</head>
{# This is a comment. Comments are removed from the output. #}
<body>
<menu id="nav-main">
{% for item in navigation %}
<li><a href="{{ item.url }}">{{ item.label }}</a></li>
{% endfor %}
</menu>
<div class="layout-content-main">
<h1>{{ title }}</h1>
{{ body }}
</div>
</body>
</html>
There are three kinds of delimiters:
- Interpolation, to inject values into the output; these default to
{{and}} - Flow Control, to create conditionals, loops, and other control constructs;
these default to
{%and%} - Comments, which are removed from the output; these default to
{#and#}.
These delimiters can be changed on the Haskell side. In principle, any string is accepted for any delimiter; you may, however, get surprising results if you pick delimiters that clash with other Ginger syntax, or with one another (e.g., using the same string to start interpolations and flow control constructs will not work).
Haskell API
The Haskell API is documented fully through Haddock documentation, available from Hackage. We’ll just provide a short overview here.
General
On the Haskell side of things, executing a template is a two-step process. First, template source code is parsed into a ‘Template’ data structure, which is then fed to ‘runGinger’ or ‘runGingerT’.
Parsing
Because Ginger templates can include other templates, the parser needs a way of resolving template names. Instead of hard-wiring the parser into ‘IO’ though, Ginger will work on any Monad type, but requires the caller to provide a suitable template resolver function. For ‘IO’, the resolver would typically load a file from a template directory, but other monads might have access to some sort of cache, or expose template compiled into a program, or simply return ‘Nothing’ unconditionally to disable any and all imports. A suitable example implementation for ‘IO’ would look like this:
loadFile fn = openFile fn ReadMode >>= hGetContents
loadFileMay fn =
tryIOError (loadFile fn) >>= \e ->
case e of
Right contents ->
return (Just contents)
Left err -> do
print err -- remove this line if you want to fail silently
return Nothing
(Taken from cli/GingerCLI.hs). This interprets the template name as a
filename relative to the CWD, and returns the file contents on success or
‘Nothing’ if there is any error.
If you don’t need a monadic context for resolving includes (e.g. because you have pre-loaded all template sources), you can use the pure ‘parseGinger’ flavor, which does not rely on a host monad.
Running
The core function for running a template is ‘runGinger’ (or its monadic flavor ‘runGingerT’); in order to pass an initial context to the template engine, pass a suitable ‘GingerContext’, which you can create using the ‘makeContext’ / ‘makeContextM’ functions.
An example call (for running a template in ‘IO’) would look something like this:
runGingerT (makeContextM scopeLookup (putStr . Text.unpack . htmlSource)) tpl