Scriban模板引擎中的多行文本缩进控制技巧

在YAML配置文件中使用Scriban模板引擎时，开发者经常会遇到多行文本缩进控制的挑战。本文将通过一个典型场景，深入探讨如何优雅地解决模板渲染中的缩进问题。

问题背景

当我们在YAML的多行字符串中嵌入Scriban模板时，常常会遇到以下情况：

- data: |
    {{- capture var -}}
    line1
    line2
    line3
    {{ end }}
    ## body
    {{ var }}

期望的输出是保持所有行对齐，但实际结果却是：

- data: |
    ## body
    line1
        line2
        line3

可以看到，只有第一行的缩进被正确处理，后续行保留了原始缩进。这是因为Scriban的空白控制({{-和-}})只能作用于单行的开始和结束位置。

技术原理分析

这种现象的根本原因在于：

1. YAML的多行字符串(|)会保留原始格式
2. Scriban的空白控制主要针对模板标签周围的空白
3. 嵌入的模板内容被视为独立文本块，其内部格式不受外层控制

解决方案

自定义缩进处理函数

最可靠的解决方案是创建一个自定义函数来处理公共缩进：

public static string IndentCommon(string text)
{
    var lines = text.Split(new[] { "\r\n", "\n" }, StringSplitOptions.None);

    var indentLengths = lines
        .Where(line => !string.IsNullOrWhiteSpace(line))
        .Select(line => line.TakeWhile(char.IsWhiteSpace).Count());

    int commonIndent = indentLengths.Any() ? indentLengths.Min() : 0;

    var trimmedLines = lines.Select(line =>
        line.Length >= commonIndent ? line.Substring(commonIndent) : line);

    return string.Join(Environment.NewLine, trimmedLines);
}

使用方式：

- data: |
    {{- capture var -}}
    line1
    line2
    line3
    {{ end }}
    ## body
    {{ var | indent_common }}

函数工作原理

1. 分割文本：将输入文本按行分割
2. 计算缩进：找出所有非空行的最小公共缩进量
3. 统一处理：从每行开头移除公共缩进量
4. 重组文本：将处理后的行重新组合为完整文本

最佳实践建议

1. 预处理与后处理：对于复杂的模板，考虑在渲染前后进行文本处理
2. 保持一致性：在团队中统一缩进风格，通常建议使用4个空格
3. 测试验证：特别关注多平台下的换行符差异(CRLF vs LF)
4. 性能考量：对于大型文本，注意字符串操作的开销

总结

在Scriban与YAML结合使用时，理解文本处理的生命周期至关重要。通过自定义函数解决缩进问题不仅灵活可靠，还能保持代码的可维护性。开发者应当根据实际需求选择最适合的文本处理策略，确保配置文件的整洁和一致性。

掌握这些技巧后，开发者可以更加自信地在各种配置场景中使用Scriban模板，产出格式完美的输出结果。