stache: Mustache templates for Haskell

[ bsd3, library, text ] [ Propose Tags ]

Mustache templates for Haskell.


[Skip to Readme]
Versions 0.1.0, 0.1.1, 0.1.2, 0.1.3, 0.1.4, 0.1.5, 0.1.6, 0.1.7, 0.1.8, 0.2.0, 0.2.1, 0.2.2, 1.0.0, 1.1.0, 1.1.1, 1.1.2, 1.2.0, 1.2.1
Change log CHANGELOG.md
Dependencies aeson (>=0.11 && <1.4), base (>=4.8 && <5.0), bytestring (==0.10.*), containers (==0.5.*), deepseq (==1.4.*), directory (>=1.2 && <1.4), filepath (>=1.2 && <1.5), megaparsec (>=6.0 && <7.0), mtl (>=2.1 && <3.0), semigroups (==0.18.*), template-haskell (>=2.10 && <2.14), text (==1.2.*), unordered-containers (>=0.2.5 && <0.3), vector (>=0.11 && <0.13), void (==0.7.*) [details]
License BSD-3-Clause
Author Mark Karpov <markkarpov92@gmail.com>
Maintainer Mark Karpov <markkarpov92@gmail.com>
Revised Revision 4 made by mrkkrp at Mon Mar 26 17:26:45 UTC 2018
Category Text
Home page https://github.com/stackbuilders/stache
Bug tracker https://github.com/stackbuilders/stache/issues
Source repo head: git clone https://github.com/stackbuilders/stache.git
Uploaded by mrkkrp at Sun Oct 1 06:28:27 UTC 2017
Distributions LTSHaskell:1.2.1, NixOS:1.2.1, Stackage:1.2.1, openSUSE:1.2.1
Downloads 4211 total (35 in the last 30 days)
Rating 2.0 (votes: 1) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2017-10-01 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Flags

NameDescriptionDefaultType
dev

Turn on development settings.

DisabledManual

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

For package maintainers and hackage trustees


Readme for stache-1.2.1

[back to package description]

Stache

License BSD3 Hackage Stackage Nightly Stackage LTS Build Status Coverage Status

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.

Quick start

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 err -> putStrLn (parseErrorPretty err)
    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:

Contribution

Issues, bugs, and questions may be reported in the GitHub issue tracker for this project.

Pull requests are also welcome and will be reviewed quickly.

License

Copyright © 2016–2017 Stack Builders

Distributed under BSD 3 clause license.