Sparkdo.TextTemplating.Scriban 1.0.2

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher.
There is a newer prerelease version of this package available.
See the version list below for details. 
dotnet add package Sparkdo.TextTemplating.Scriban --version 1.0.2
                    


                    

                
NuGet\Install-Package Sparkdo.TextTemplating.Scriban -Version 1.0.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Sparkdo.TextTemplating.Scriban" Version="1.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Sparkdo.TextTemplating.Scriban" Version="1.0.2" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Sparkdo.TextTemplating.Scriban" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Sparkdo.TextTemplating.Scriban --version 1.0.2
                    


                    

                
#r "nuget: Sparkdo.TextTemplating.Scriban, 1.0.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Sparkdo.TextTemplating.Scriban@1.0.2
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Sparkdo.TextTemplating.Scriban&version=1.0.2
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Sparkdo.TextTemplating.Scriban&version=1.0.2
                    


                            Install as a Cake Tool

Sparkdo.TextTemplating.Scriban

Sparkdo 文本模板 Scriban 引擎实现库，基于 Scriban 库提供强大的模板渲染功能。

功能特性

  • 基于 Scriban 库的模板渲染引擎
  • 支持本地化功能
  • 支持模型绑定
  • 支持复杂模板逻辑
  • 与 Sparkdo 框架无缝集成
  • 支持模板布局和继承

安装

<PackageReference Include="Sparkdo.TextTemplating.Scriban" Version="x.x.x" />

核心组件

ScribanTemplateRenderingEngine

Scriban 模板渲染引擎实现，提供基于 Scriban 库的模板渲染功能：

  • EngineName: 引擎名称常量
  • Name: 获取引擎名称
  • RenderAsync(): 渲染模板
  • RenderInternalAsync(): 内部渲染模板
  • RenderSingleTemplateAsync(): 渲染单个模板
  • RenderTemplateContentWithScribanAsync(): 使用 Scriban 渲染模板内容
  • CreateScribanTemplateContext(): 创建 Scriban 模板上下文

ScribanTemplateLocalizer

Scriban 模板本地化器，用于在 Scriban 模板中提供本地化功能：

  • Invoke(): 调用函数
  • InvokeAsync(): 异步调用函数
  • GetString(): 获取本地化字符串

扩展类

  • ScribanTemplateDefinitionExtensions: Scriban 模板定义扩展方法

模块配置

  • SparkdodoTextTemplatingScribanModule: 文本模板 Scriban 模块配置

使用示例

基本用法

public class MyService
{
    private readonly ITemplateRenderer _templateRenderer;

    public MyService(ITemplateRenderer templateRenderer)
    {
        _templateRenderer = templateRenderer;
    }

    public async Task<string> RenderTemplateAsync()
    {
        var model = new { Name = "John", Age = 30 };
        return await _templateRenderer.RenderAsync("MyTemplate", model);
    }
}

通过 TemplateDefinitionProvider 注册模板定义

public class MyTemplateDefinitionProvider : TemplateDefinitionProvider
{
    public override void Define(ITemplateDefinitionContext context)
    {
        context.Add(new TemplateDefinition("MyTemplate")
            .WithScribanEngine()
            .WithContent("Hello {{ model.name }}, you are {{ model.age }} years old!")
        );
    }
}

本地化支持

在 Scriban 模板中使用本地化：

{{ L "welcome_message" model.name }}

扩展性

该库提供了完整的 Scriban 模板渲染引擎实现，可以通过以下方式扩展：

  1. 实现自定义的模板渲染引擎
  2. 扩展本地化功能
  3. 添加自定义的 Scriban 函数

代码结构说明

本项目包含以下主要组件：

核心实现

  • ScribanTemplateRenderingEngine: Scriban 模板渲染引擎实现
  • ScribanTemplateLocalizer: Scriban 模板本地化器

扩展类

  • ScribanTemplateDefinitionExtensions: Scriban 模板定义扩展方法

模块配置

  • SparkdodoTextTemplatingScribanModule: 文本模板 Scriban 模块配置

所有公共接口和类都添加了详细的 XML 文档注释，便于开发者理解和使用。

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.3-preview.1 32 5/17/2026
1.0.2 108 4/27/2026
1.0.2-preview.5 57 4/15/2026
1.0.2-preview.4 70 2/8/2026
1.0.2-preview.3 66 2/1/2026
1.0.2-preview.2 67 1/31/2026
1.0.2-preview.1 188 12/4/2025
1.0.1 222 11/27/2025
1.0.0 215 11/25/2025
1.0.0-preview.5 140 10/24/2025