Template¶

Template is a sealed record that loads, parses, and renders Scriban templates from embedded resources with automatic two-level caching.

Rendering¶

From Embedded Resource¶

private static readonly Func<string, TemplateName> Named =
    TemplateName.ForGenerator<MyGenerator>();

var result = Template.RenderTemplate(Named("MyTemplate.scriban-cs"), model);

From Raw Text¶

var result = Template.RenderFromText(templateText, "MyTemplate", model);

Both methods return a RenderResult.

Properties¶

Caching¶

Templates are cached at two levels for IDE responsiveness:

1. Text cache — Embedded resource text is cached by (Assembly, ResourceName). Avoids repeated I/O on each keystroke.
2. Parse cache — Parsed Scriban templates are cached by template text content. Saves 5–10ms per parse.

Both caches use ConcurrentDictionary for thread safety during concurrent execution.

Snake Case Access¶

Model properties are automatically accessible in snake_case within templates:

record MyModel(string FullName, int MaxRetries);

{{ model.full_name }}     # Accesses FullName
{{ model.max_retries }}   # Accesses MaxRetries

This is handled by ScriptObject.ImportDeep with reflection caching — first import ~1–2ms, subsequent ~0.01ms.

Error Handling¶

If a template is not found, TemplateNotFoundException is thrown with a list of available templates in the assembly.

RenderResult¶

RenderResult is an abstract record representing the outcome of a template render.

Success¶

if (result is RenderResult.Success success)
{
    string code = success.Text;
    object? model = success.Context;
}

Failure¶

if (result is RenderResult.Failure failure)
{
    Diagnostic error = failure.Diagnostic;
}

Diagnostics¶

Errors are reported via SourceProductionContext.ReportDiagnostic() so they appear in the IDE.