Author

Version

0.2.0

License

Apache-2.0

Repository

github.com/moonbit-community/liquid-moonbit

Last updated

2 days ago

Downloads

#Liquid for MoonBit

A Liquid template engine with reusable compiled templates, typed filter arguments, and structured diagnostics. The package also includes Jekyll/Shopify-inspired extensions; it does not claim full compatibility with every Liquid dialect.

#Compile and render

Compile once, then render with a context. Both operations return Result; applications decide how to display or log diagnostics.

///|
test {
  let context = @liquid.LiquidContext::new()
  context.set("name", @liquid.string_value("MoonBit"))
  let template = @liquid.compile("Hello {{ name | upcase }}!").unwrap()
  assert_eq(template.render(context).unwrap(), "Hello MOONBIT!")
}

Templates support output pipelines, assignment, capture, conditions, case, loops, loop control, counters, cycle, ifchanged, raw text, comments, and whitespace control. Context values can be strings, numbers, explicit floats, booleans, arrays, objects, or null. Use float_value to preserve floating arithmetic when supplying an integral float from the host.

#Typed filters

Filter arguments are values, not strings containing Liquid syntax. Literal quote characters remain part of a supplied string. Filters return diagnostics for unknown names and invalid concatenation operands.

///|
test {
  let result = @liquid.apply_filter(
    @liquid.array_value([@liquid.number_value(1)]),
    "concat",
    [@liquid.array_value([@liquid.number_value(2)])],
  ).unwrap()
  assert_eq(result.to_string(), "[1, 2]")
}

#Registered templates

include shares the caller's variables; render starts an isolated context with explicit arguments. Register source text on the context. Recursive partials are bounded, and partial diagnostics identify the template.

///|
test {
  let context = @liquid.LiquidContext::new()
  context.register_template("greeting", "Hello {{ name }}!")
  let template = @liquid.compile("{% render 'greeting', name: 'Alice' %}").unwrap()
  assert_eq(template.render(context).unwrap(), "Hello Alice!")
}

#Diagnostics

Diagnostic exposes phase, code, message, offset, and template. Parse offsets identify an opening tag using zero-based UTF-16 code units; runtime offsets are currently absent. Rendering returns Err if diagnostics occur. Context mutations performed before an error are not rolled back. A fresh context isolates variable bindings between renders; it does not provide transactional rollback. Missing output values are errors unless handled by a filter such as default; absent values in conditions remain falsy.

#Source organization

Import moonbit-community/liquid for the public interface. The root package provides the entry point: engine/ owns compilation and rendering, value/ owns the Liquid value type, and internal/ contains shared value operations and filter implementations. Tests live beside the source they exercise. Files ending in _test.mbt use the package interface (black-box tests); _wbtest.mbt is reserved for tests that need private implementation access (white-box tests). Public entry-point integration tests live in the root package.

#Runnable example

moon run examples/basic --target native

#Development

moon check --target all --deny-warn --warn-list +25+73
moon fmt --check
moon test --target wasm
moon test --target wasm-gc
moon test --target js
moon test --target native

The reference corpus contains 20 cases generated with Shopify Ruby Liquid 5.4.0. It covers selected behavior, not complete standards compliance. Install that gem outside this repository, then run ruby tools/reference_cases.rb --check. See ARCHITECTURE.md for module responsibilities and limitations.

Diagnostic

source

using @moonbit-community/liquid/engine { type Diagnostic }

A machine-readable parse or render failure. Offsets use UTF-16 code units. Runtime failures without a source span have offset=None.

LiquidContext

source

using @moonbit-community/liquid/engine { type LiquidContext }

Application variables and explicitly registered templates.

LiquidValue

source

using @moonbit-community/liquid/value { type LiquidValue }

Template

source

using @moonbit-community/liquid/engine { type Template }

An opaque, compiled template. Use compile to construct it.

apply_filter

source

fn apply_filter(value : @moonbit-community/liquid/value.LiquidValue
LiquidValue, name : String, parameters : Array[@moonbit-community/liquid/value.LiquidValue
LiquidValue], options? : Map[String, @moonbit-community/liquid/value.LiquidValue
LiquidValue]) -> Result[@moonbit-community/liquid/value.LiquidValue
LiquidValue, @moonbit-community/liquid/engine.Diagnostic
Diagnostic]

Apply a built-in filter to evaluated arguments.

array_value

source

fn array_value(arr : Array[@moonbit-community/liquid/value.LiquidValue
LiquidValue]) -> @moonbit-community/liquid/value.LiquidValue
LiquidValue

bool_value

source

fn bool_value(b : Bool) -> @moonbit-community/liquid/value.LiquidValue
LiquidValue

compile

source

fn compile(source : String) -> Result[@moonbit-community/liquid/engine.Template
Template, Array[@moonbit-community/liquid/engine.Diagnostic
Diagnostic]]

Parse and compile a template, rejecting malformed or unknown tags.

float_value

source

fn float_value(n : Double) -> @moonbit-community/liquid/value.LiquidValue
LiquidValue

Construct an explicitly floating-point number, including integral values like 4.0.

null_value

source

fn null_value() -> @moonbit-community/liquid/value.LiquidValue
LiquidValue

number_value

source

fn number_value(n : Double) -> @moonbit-community/liquid/value.LiquidValue
LiquidValue

object_value

source

fn object_value(obj : Map[String, @moonbit-community/liquid/value.LiquidValue
LiquidValue]) -> @moonbit-community/liquid/value.LiquidValue
LiquidValue

string_value

source

fn string_value(s : String) -> @moonbit-community/liquid/value.LiquidValue
LiquidValue

Source Files

lib.mbt

Site source Report issue Packages Build queue Skills Statistics

liquid

#Liquid for MoonBit

#Compile and render

#Typed filters

#Registered templates

#Diagnostics

#Source organization

#Runnable example

#Development

#Diagnostic

#LiquidContext

#LiquidValue

#Template

#apply_filter

#array_value

#bool_value

#compile

#float_value

#null_value

#number_value

#object_value

#string_value

Source Files

Diagnostic

LiquidContext

LiquidValue

Template

apply_filter

array_value

bool_value

compile

float_value

null_value

number_value

object_value

string_value