ProjectForge.Render

Functions for rendering Project and File Templates.

Rendering a Template interpolates the partial values in a Template with values from a Value.

Rendering templates

renderFileTemplate

Arguments

:: (MonadLogger m, MonadIO m)

=> RenderTemplateOpts

-> FileTemplate

-> Value

values to interpolate into the template

-> m (FilePath, Text)

Renders a FileTemplate using renderMustache. Values to be input into the template are presented via a Value representation.

>>> import Data.Aeson (toJSON, object, (.=))
>>> import ProjectForge.Compile
>>> import Blammo.Logging.Simple
>>> let settings = toJSON (object [ "prjId" .= "P0000"])
>>> let exampleTemplate = compileFileTemplate ("{{prjId}}.md",  "This is {{prjId}}")
>>> runSimpleLoggingT .  (\x -> renderFileTemplate defaultRenderTemplateOpts x settings) =<< exampleTemplate
([],("P0000.md","This is P0000"))

renderProjectTemplate

Arguments

:: (MonadIO m, MonadLogger m)

=> RenderTemplateOpts

-> ProjectTemplate

-> Value

values to interpolate into each FileTemplate of the ProjectTemplate

-> m [(FilePath, Text)]

Renders a ProjectTemplate, returning a list of filepaths and file contents that may be written to files.

writeTemplateResult :: (MonadLogger m, MonadIO m) => [(FilePath, Text)] -> m ()

Utility for writing the results for renderProjectTemplate to files.

Rendering Options and Exception Handling

newtype RenderTemplateOpts

Options to control how renderFileTemplate is run.

Constructors

MkRenderTemplateOpts

Fields

• handleWarnings :: RenderWarnHandling

Instances

Show RenderTemplateOpts

Defined in ProjectForge.Render

Methods

showsPrec :: Int -> RenderTemplateOpts -> ShowS

show :: RenderTemplateOpts -> String

showList :: [RenderTemplateOpts] -> ShowS

Eq RenderTemplateOpts

Defined in ProjectForge.Render

Methods

(==) :: RenderTemplateOpts -> RenderTemplateOpts -> Bool

(/=) :: RenderTemplateOpts -> RenderTemplateOpts -> Bool

data RenderWarnHandling

Flag for how to handle any 'Text.Stache.Type.MustacheWarning's that may result from renderFileTemplate.

Constructors

WarningAsError

lift mustache warnings to errors

Ignore

Ignore warnings

Instances

Show RenderWarnHandling

Defined in ProjectForge.Render

Methods

showsPrec :: Int -> RenderWarnHandling -> ShowS

show :: RenderWarnHandling -> String

showList :: [RenderWarnHandling] -> ShowS

Eq RenderWarnHandling

Defined in ProjectForge.Render

Methods

(==) :: RenderWarnHandling -> RenderWarnHandling -> Bool

(/=) :: RenderWarnHandling -> RenderWarnHandling -> Bool

data RenderException

New type wrapper for a list of 'Text.Stache.Type.MustacheWarning's so that it can be made an instance of Exception.

Instances

Exception RenderException

Defined in ProjectForge.Render

Methods

toException :: RenderException -> SomeException

fromException :: SomeException -> Maybe RenderException

displayException :: RenderException -> String

Show RenderException

Defined in ProjectForge.Render

Methods

showsPrec :: Int -> RenderException -> ShowS

show :: RenderException -> String

showList :: [RenderException] -> ShowS

Eq RenderException

Defined in ProjectForge.Render

Methods

(==) :: RenderException -> RenderException -> Bool

(/=) :: RenderException -> RenderException -> Bool

defaultRenderTemplateOpts :: RenderTemplateOpts

Default RenderTemplateOpts