Module documentation for 0.2.0

Stache

This is a Haskell implementation of Mustache templates. The implementation
conforms to the version 1.1.3 of the
official Mustache specification. It is
extremely simple and straightforward to use with minimal but complete
API—three functions to compile templates (from directory, from file, and
from lazy text) and one to render them.

The implementation uses the Megaparsec parsing library to parse the
templates which results in superior quality of error messages.

For rendering you only need to create Aeson's Value where you put the data
to interpolate. Since the library re-uses Aeson's instances and most data
types in the Haskell ecosystem are instances of classes like
Data.Aeson.ToJSON, the whole process is very simple for the end user.

Template Haskell helpers for compilation of templates at compile time are
available in the Text.Mustache.Compile.TH module. The helpers currently
work only with GHC 8 and later.

One feature that is not currently supported is lambdas. The feature is
marked as optional in the spec and can be emulated via processing of parsed
template representation. The decision to drop lambdas is intentional, for
the sake of simplicity and better integration with Aeson.

Stache 1.1.2

Stache 1.1.1

Stache 1.1.0

Added mustacheRenderW that allows to render a Template collecting
warnings in the process. Also added the MusthacheWarning type
representing the warnings themselves and displayMustacheWarning to
pretty-print the warnings.

Stache 1.0.0

Improved metadata and documentation.

Breaking change: the renderMustache function does not throw exceptions
when referenced key is not provided as per the spec. This is the behaviour
we had before 0.2.0, and it played better with the rest of Mustache.
Correspondingly, MustacheRenderException was removed.

Stache 0.2.2

Make TH helpers compileMustacheDir and compileMustacheFile detect
changes in the templates and force recompilation.

Stache 0.2.1

Made TH parse errors nicer.

Stache 0.2.0

Breaking change: the renderMustache function will throw an exception
when referenced key was not provided. This is a better behavior than
silent interpolation of an empty string, because missing values are almost
always a mistake and it's easy to provide empty strings explicitly anyway.

Allowed directory-1.3.0.0.

Stache 0.1.8

Rename specs directory to specification as the previous name somehow
caused conflicts when deploying an application on Heroku with Stache as a
dependency.

Stache 0.1.7

Added mustache quasi-quoter.

Stache 0.1.6

Fixed a bug in the lookup algorithm for dot-separated keys.

Stache 0.1.5

When section's key is a number or non-empty string, it's accessible as .
in the section body.

Allow Aeson 1.0.

Stache 0.1.4

Numbers are now treated as “true” values.

Added Semigroup instance for Key.

Now change of delimiters affects special unescaped variable syntax as
well, for example: {{=<< >>=}}<<{var}>> will be parsed as unescaped
variable var.

compileMustacheFile now shows full path to malformed template when the
template cannot be parsed.

Defined displayException method of Exception type class for
MustacheException using parseErrorPretty from Megaparsec.