Invisible link to canonical for Microformats
 

mustache (slug)

slug.mustache

slug.mustache — Mustache template renderer

A native Slug implementation of the Mustache spec v1.4.3, including the core suites and template inheritance.

Basic usage

val { render, parse } = import("slug.mustache")

render("Hello, !", { name: "World" })
// => "Hello, World!"

render(" ", { items: ["a", "b", "c"] })
// => "a b c "

Tag types

Tag Meaning
`` HTML-escaped variable
} Unescaped variable
`` Unescaped variable (alternate syntax)
`` Section — renders if truthy/non-empty
`` Inverted section — renders if falsey/empty
`` Closes a section
`` Partial — renders another template by name
`` Template inheritance — extend a parent
`` Block — defines or overrides a named region
`` Comment — ignored
`` Set delimiters

Partials

Pass a map of name -> template_string as the partials argument. Partials inherit the current context and are resolved at render time.

Template inheritance

Use ... to extend a parent template. Override named blocks with ....

Performance

For templates rendered multiple times, parse once and pass the AST to render or renderCached to avoid repeated parsing. renderCached additionally caches parsed partials across calls.

TOC

Functions

parse(template)

fn slug.mustache#parse(@str template) -> ?

parses a Mustache template string into an AST.

The returned AST can be passed directly to render or renderCached to avoid re-parsing on repeated renders. The AST shape is an implementation detail — do not rely on its structure directly.

Parameter Type Default
template @str —

render(templateOrAst, data, partials)

fn slug.mustache#render(templateOrAst, data, partials = nil) -> @str

renders a Mustache template and returns the resulting HTML string.

templateOrAst may be a template string or a pre-parsed AST from parse. partials may be a map of name -> template_string or a fn(name) -> str. For repeated renders of the same template with partials, prefer renderCached to avoid re-parsing partials on each call.

Parameter Type Default
templateOrAst   —
data   —
partials   nil

Throws: @struct(Error{type:MustacheError})

renderCached(templateOrAst, data, partials, cache)

fn slug.mustache#renderCached(templateOrAst, data, partials = nil, cache = {}) -> @str

renders a Mustache template with a partial cache for reuse across calls.

Returns a map { html: @str, cache: @map }. Pass the returned cache back on subsequent calls to avoid re-parsing partials.

templateOrAst may be a template string or a pre-parsed AST from parse. partials may be a map of name -> template_string or a fn(name) -> str.

Parameter Type Default
templateOrAst   —
data   —
partials   nil
cache   {}

Throws: @struct(Error{type:MustacheError})