Text.Mustache

Compiling

Automatic

compileTemplate :: [FilePath] -> FilePath -> IO (Either ParseError MustacheTemplate)

Compiles a mustache template provided by name including the mentioned partials.

The same can be done manually using getFile, mustacheParser and getPartials.

This function also ensures each partial is only compiled once even though it may be included by other partials including itself.

A reference to the included template will be found in each including templates partials section.

Manually

compileTemplateWithCache :: [FilePath] -> [MustacheTemplate] -> FilePath -> IO (Either ParseError MustacheTemplate)

Compile a mustache template providing a list of precompiled templates that do not have to be recompiled.

parseTemplate :: String -> Text -> Either ParseError MustacheTemplate

data MustacheTemplate

A compiled Template with metadata.

Constructors

MustacheTemplate

Fields

name :: String

ast :: MustacheAST

partials :: [MustacheTemplate]

Instances

Show MustacheTemplate

Rendering

Generic

substitute :: ToMustache j => MustacheTemplate -> j -> Either String Text

Substitutes all mustache defined tokens (or tags) for values found in the provided data structure.

Equivalent to substituteValue . toMustache.

Specialized

substituteValue :: MustacheTemplate -> Value -> Either String Text

Substitutes all mustache defined tokens (or tags) for values found in the provided data structure.

Data Conversion

class ToMustache a where

Conversion class

Methods

toMustache :: a -> Value

Instances

ToMustache Bool

ToMustache Char

ToMustache ()

ToMustache Scientific

ToMustache Text

ToMustache Value

ToMustache Text

ToMustache Value

ToMustache [Char]

ToMustache m => ToMustache [m]

ToMustache m => ToMustache (Vector m)

ToMustache (Context Value -> MustacheAST -> Either String Text)

ToMustache (Context Value -> MustacheAST -> Either String MustacheAST)

ToMustache (Context Value -> MustacheAST -> String)

ToMustache (Context Value -> MustacheAST -> Text)

ToMustache (Context Value -> MustacheAST -> MustacheAST)

ToMustache (MustacheAST -> Either String String)

ToMustache (MustacheAST -> Either String Text)

ToMustache (MustacheAST -> Either String MustacheAST)

ToMustache (MustacheAST -> String)

ToMustache (MustacheAST -> Text)

ToMustache m => ToMustache (HashMap Text m)

object :: [(Text, Value)] -> Value

Convenience function for creating Object values.

This function is supposed to be used in conjuction with the ~> and ~= operators.

Examples

  data Address = Address { ... }

  instance Address ToJSON where
    ...

  data Person = Person { name :: String, address :: Address }

  instance ToMustache Person where
    toMustache (Person { name, address }) = object
      [ "name" ~> name
      , "address" ~= address
      ]

Here we can see that we can use the ~> operator for values that have themselves a ToMustache instance, or alternatively if they lack such an instance but provide an instance for the ToJSON typeclass we can use the ~= operator.

(~>) :: ToMustache m => Text -> m -> KeyValuePair

Map keys to values that provide a ToMustache instance

Recommended in conjunction with the OverloadedStrings extension.

(~=) :: ToJSON j => Text -> j -> KeyValuePair

Map keys to values that provide a ToJSON instance

Recommended in conjunction with the OverloadedStrings extension.

(~~>) :: (Conversion t Text, ToMustache m) => t -> m -> KeyValuePair

Conceptually similar to ~> but uses arbitrary String-likes as keys.

(~~=) :: (Conversion t Text, ToJSON j) => t -> j -> KeyValuePair

Conceptually similar to ~= but uses arbitrary String-likes as keys.

Util

These are functions used internally by the parser and renderer. Whether these will continue to be exposed is to be seen.

getFile :: [FilePath] -> FilePath -> EitherT ParseError IO Text

getFile searchSpace file iteratively searches all directories in searchSpace for a file returning it if found or raising an error if none of the directories contain the file.

This trows ParseErrors to be compatible with the internal Either Monad of compileTemplateWithCache.

getPartials :: MustacheAST -> [FilePath]

Find the names of all included partials in a mustache AST.

Same as join . fmap getPartials'

getPartials' :: MustacheNode Text -> [FilePath]

Find partials in a single MustacheNode

toString :: Value -> Text

search :: Context Value -> [Text] -> Maybe Value

data Context a

Representation of stateful context for the substitution process

Constructors

Context [a] a

Instances

ToMustache (Context Value -> MustacheAST -> Either String Text)

ToMustache (Context Value -> MustacheAST -> Either String MustacheAST)

ToMustache (Context Value -> MustacheAST -> String)

ToMustache (Context Value -> MustacheAST -> Text)

ToMustache (Context Value -> MustacheAST -> MustacheAST)