stache
Mustache templates for Haskell
https://github.com/stackbuilders/stache
| Version on this page: | 2.3.4 |
| LTS Haskell 22.39: | 2.3.4@rev:2 |
| Stackage Nightly 2024-10-31: | 2.3.4@rev:3 |
| Latest on Hackage: | 2.3.4@rev:3 |
stache-2.3.4@sha256:8d5ccca8d57c2268bba9f43f9c426aa896ebb92c33629fd000f65861c8ccee74,4319Module documentation for 2.3.4
Stache
This is a Haskell implementation of Mustache templates. The implementation conforms to the version 1.1.3 of the official Mustache specification. It has a 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 high-quality error messages.
For rendering one only needs to create Aeson’s Value that is used for
interpolation of template variables. 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 process is simple for the end user.
Template Haskell helpers for compilation of templates at compile time are
available in the Text.Mustache.Compile.TH module.
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.
Usage
Here is an example of basic usage:
{-# LANGUAGE OverloadedStrings #-}
module Main (main) where
import Data.Aeson
import Data.Text
import Text.Megaparsec
import Text.Mustache
import qualified Data.Text.Lazy.IO as TIO
main :: IO ()
main = do
let res = compileMustacheText "foo"
"Hi, {{name}}! You have:\n{{#things}}\n * {{.}}\n{{/things}}\n"
case res of
Left bundle -> putStrLn (errorBundlePretty bundle)
Right template -> TIO.putStr $ renderMustache template $ object
[ "name" .= ("John" :: Text)
, "things" .= ["pen" :: Text, "candle", "egg"]
]
If I run the program, it prints the following:
Hi, John! You have:
* pen
* candle
* egg
For more information about Mustache templates the following links may be helpful:
- The official Mustache site: https://mustache.github.io/
- The manual: https://mustache.github.io/mustache.5.html
- The specification: https://github.com/mustache/spec
- Stack Builders Stache tutorial: https://www.stackbuilders.com/tutorials/haskell/mustache-templates/
License
MIT, see the LICENSE file.
Contributing
Do you want to contribute to this project? Please take a look at our contributing guideline to know how you can help us build it.
Check out our libraries | Join our team