MIT licensed and maintained by Mark Karpov
This version can be pinned in stack with:stache-2.3.3@sha256:277a4d71f3612a72f314275c7ff3c872637de2b0e2ac7c9eca5bd83ee7aeea2f,4487

Module documentation for 2.3.3

  • Text
    • Text.Mustache
      • Text.Mustache.Compile
        • Text.Mustache.Compile.TH
      • Text.Mustache.Parser
      • Text.Mustache.Render
      • Text.Mustache.Type
Used by 2 packages in nightly-2022-12-01(full list with versions):

Stache

Hackage Stackage Nightly Stackage LTS CI

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:

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

Changes

Stache 2.3.3

  • Allow vector-0.13
  • Changing license from BSD-3 to MIT

Stache 2.3.2

  • Builds with mtl-2.3.

Stache 2.3.1

  • Uses aeson-2.x.x.x.

Stache 2.3.0

  • Allowed parsing a wider range of keys in the templates thus making the library’s behavior closer to other existing implementations.

Stache 2.2.1

  • Works with GHC 9.0.1, dropped support for GHC 8.6.x and older.

Stache 2.2.0

  • Added the executable program.

Stache 2.1.1

  • Fixed the bug related to incorrect indentation with nested partials. Issue 44.

  • Dropped support for GHC 8.2 and older.

Stache 2.1.0

  • Dropped support for GHC 8.0 and older.

  • Documentation improvements.

  • Added Template Haskell Lift instance for the Template type and its sub-components.

Stache 2.0.1

  • Now interpolation with escaping also escapes single quotes as &#39.

Stache 2.0.0

  • Uses Megaparsec 7. In particular, the parser now returns ParseErrorBundle on failure and the bundle is also inside MustacheException.

Stache 1.2.1

  • Fixed a bug in compileMustacheDir' from Text.Mustache.Compile.TH: it did not use the supplied predicate and selected only .mustache files like compileMustacheDir.

Stache 1.2.0

  • Added compileMustacheDir' and getMusthacheFilesInDir' that allow for a custom template predicate. Also exposed isMustacheFile as the default predicate used by functions like compileMustacheDir.

  • Abandon attempts to support GHC 7.8.

Stache 1.1.2

  • Fixed compilation of the test suite with Cabal 2.0/GHC 8.2.1.

Stache 1.1.1

  • Exported mustacheRenderW, MustacheWarning, and displayMustacheWarning from Text.Mustache.

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 now uses Megaparsec 6 for parsing.

  • MustacheException now includes original input as Text.

  • compileMustacheText and parseMustache now accept strict Text instead of lazy Text.

  • Minor improvement in rendering speed.

  • Stop depending on exceptions and drop MonadThrow constraints.

Stache 0.2.2

  • Add the getMustacheFilesInDir function.

  • 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.

Stache 0.1.3

  • Cosmetic improvements.

  • Minor improvement in performance of parser.

Stache 0.1.2

  • Fixed compilation of benchmarks with Megaparsec 5.0.1 and later.

Stache 0.1.1

  • Added benchmarks.

Stache 0.1.0

  • Initial release.