Crates.io | hairy |
lib.rs | hairy |
version | 0.4.0 |
source | src |
created_at | 2022-05-27 21:06:18.744874 |
updated_at | 2024-05-03 08:29:49.775044 |
description | Compiled text templates (not unlike Mustache and Handlebars), with support for expressions and custom functions inside such expressions. |
homepage | https://www.bitpowder.com/libs/indigo/ |
repository | https://gitlab.com/bitpowder/indigo-ng |
max_upload_size | |
id | 595314 |
size | 164,911 |
The hairy
crate provides text templates, not unlike mustache and handlebars (and the earlier ctemplate original), but a bit different.
Scoping is different: variables must specify explicitly which scope they use (by using a.b
syntax). This is to avoid implicit behaviour when variables are (accidentally) overwritten.
To catch errors early on, optionally types can be added, which are checked compile time.
All errors are treated as hard errors and are reported.
So missing values and typing errors are not silently ignored.
Also, the templates support evaluation: {{=expression}}
.
The supported expressions are from the [expry
] crate, which allows executing expression on binary encoded JSON-like values (with support for defining custom functions).
Auto-escaping is applied to the output to avoid security issues (such as letting user input be exected as javascript).
In short the features and syntax:
type key: expry
pairs (JSON is a valid expry). type
can be either inline
(value is replaced during compilation of the template) or default
(which is a default value that is added to the evaluation time value if the key does not exist). The first non-parsable line signals the end of the variables.{{=value}}
(supports expressions, see below). Escape mode can
be specified with {{=value:escape_mode}}
. Values are processed by a user-definable escaper
that can take the escape mode into account. Normally only strings and numbers are displayed,
and the null
value is considered a skip (without generating an error). Other values are considered an error, except when the sjs
(script-js) or js
escape modes are used.{{if value}}contents{{end}}
. Contents is displayed if value evaluates to true
. An else construct is supported: {{if value}}foo{{else}}bar{{end}}
.{{for variable in name}}content{{end}}
, which can be used to iterate over (arrays of) any type. The contents of the array is available in the loop body under key variable
;{{define name}}content{{end}}
. Templates can have optional default values (in an object) with {{define name defaults object}}content{{end}}
. Defaults are resolved at template compile time, using the global context given to the compile function;{{call name}}
or {{call name with value}}
. name
can be an expression. If the name starts with a *
, name can be an expression that resolves to a string (which is treated as a template name). If the name starts with **
, name should be an expression that resolves to a binary form template code (as produced by the compile functions). If the with
syntax is used, only the data specified in value
is passed along (so the current context is not automatically transferred/merged, to do that use for value {...this, key: value}
). This is done to avoid errors.expr ??? alternative
try syntax (on error in expr
, alternative
will be executed). Shorthand for expr ??? null
is expr ???
, which can be used in loops with {{for i in someField???}}
, which ignores errors if the field is not found. Same for conditionals.expry
expressions can be used instead of values as above (think of expressions, functional calls, selectors, etc).