Support for Required Variables in Template #19
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added renderTemplateM which allows for failure if a required variable is not in context. The template parser now checks for an '!' prefixing a variable. If found, the variable is considered required.
| Context $ M.adjust | ||
| (\z -> case z of | ||
| _ | null vs -> x | ||
| MapVal m -> | ||
| MapVal $ addToContext (Variable vs fs) x m | ||
| MapVal $ addToContext (Variable vs fs r) x m |
There was a problem hiding this comment.
Unsure if I correctly modified addToContext
| @@ -377,10 +377,11 @@ pOpen = pOpenDollar <|> pOpenBraces | |||
|
|
|||
| pVar :: Monad m => Parser m Variable | |||
| pVar = do | |||
| required <- True <$ P.try (P.string "!") <|> pure False | |||
There was a problem hiding this comment.
This may not be the syntax you are looking for.
|
|
||
| -- | Render a compiled template in a "context" which provides | ||
| -- values for the template's variables. | ||
| renderTemplate :: (TemplateTarget a, ToContext a b) | ||
| => Template a -> b -> Doc a | ||
| renderTemplate t x = S.evalState (renderTemp t (toContext x)) 0 | ||
| renderTemplate t x = runIdentity $ renderTemplateM t x |
There was a problem hiding this comment.
Maybe renderTemplate should be moved to Text.DocTemplates
| resolveVariable' v val = | ||
| case applyPipes (varPipes v) $ multiLookup (varParts v) val of | ||
| ListVal xs -> mconcat $ map (resolveVariable' mempty) xs | ||
| ListVal xs -> foldMapA (resolveVariable' mempty) xs |
There was a problem hiding this comment.
Please double check ListVal line
| BoolVal True -> resolved True ["true"] | ||
| BoolVal False -> resolved False ["false"] | ||
| NullVal | ||
| | varRequired v -> missingRequired v |
There was a problem hiding this comment.
Does missing Required need to be added to any other?
| @@ -373,22 +376,42 @@ instance Monoid (Resolved a) where | |||
| mappend = (<>) | |||
| mempty = Resolved False [] | |||
|
|
|||
| resolveVariable :: TemplateTarget a | |||
| => Variable -> Context a -> Resolved a | |||
| class Monad m => MissingRequired m where | |||
There was a problem hiding this comment.
Are there any other instances that should be added?
because PandocError accepts Text not String
BebeSparkelSparkel
added a commit
to BebeSparkelSparkel/pandoc
that referenced
this pull request
Dec 18, 2022
Allows an error to be thrown if a required variable is missing from the context. This has only been applied to the HTML writer but could be added to all the writers. I do not think this is a breaking change since existing templates do not have required variables. It requires the new features in doctemplates pull request jgm/doctemplates#19
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added renderTemplateM which allows for failure if a required variable is not in context. The template parser now checks for an '!' prefixing a variable. If found, the variable is considered required.
Short script demonstration
closes #18