SimpleTextTemplate.Abstractions 3.0.0

SimpleTextTemplate

SimpleTextTemplateは、変数の埋め込みのみに対応したテキストテンプレートエンジンです。

説明

• 文字列をUTF-8バイト列としてIBufferWriter<byte>に出力します。
• {{ <変数>:<format>:<culture> }}で変数を埋め込みます。（formatとcultureは省略可能）
• {{と}}内の先頭と末尾の空白（U+0020）は無視されます。
• {{と}}で囲まれた範囲以外の文字は、そのまま出力されます。

インストール

NuGet（正式リリース版）

dotnet add package SimpleTextTemplate.Generator

Azure Artifacts（開発用ビルド）

dotnet add package SimpleTextTemplate.Generator -s https://pkgs.dev.azure.com/finphie/Main/_packaging/DotNet/nuget/v3/index.json

使い方

次の例では、外部のライブラリであるCommunityToolkit.HighPerformanceを参照しています。

SimpleTextTemplate.Generator（推奨）

using System;
using System.Globalization;
using System.Text;
using CommunityToolkit.HighPerformance.Buffers;
using SimpleTextTemplate;

using var bufferWriter = new ArrayPoolBufferWriter<byte>();
var context = new SampleContext("Hello, World", 1000, new(2000, 1, 1, 0, 0, 0, TimeSpan.Zero));

var writer = TemplateWriter.Create(bufferWriter);
TemplateRenderer.Render(ref writer, "{{ DateTimeOffsetValue:o }}_{{ StringValue }}!", in context);
TemplateRenderer.Render(ref writer, "_{{ ConstantString }}_{{ ConstantInt:N3:ja-JP }}_{{ IntValue }}", in context, CultureInfo.InvariantCulture);
writer.Flush();

// 2000-01-01T00:00:00.0000000+00:00_Hello, World!_Hello_999.000_1000
Console.WriteLine(Encoding.UTF8.GetString(bufferWriter.WrittenSpan));

readonly record struct SampleContext(
    string StringValue,
    int IntValue,
    DateTimeOffset DateTimeOffsetValue)
{
    public const string ConstantString = "Hello";
    public const int ConstantInt = 999;
}

サンプルプロジェクト

生成コード

using System.Runtime.CompilerServices;
using CommunityToolkit.HighPerformance.Buffers;
using SimpleTextTemplate;

file static class Intercept
{
    [InterceptsLocation(1, "...")]
    public static void Write0(ref TemplateWriter<ArrayPoolBufferWriter<byte>> writer, string text, in SampleContext context, IFormatProvider? provider = null)
    {
        writer.WriteValue(Unsafe.AsRef(in context).@DateTimeOffsetValue, "o", CultureInfo.InvariantCulture);
        writer.WriteConstantLiteral("_"u8);
        writer.WriteString(Unsafe.AsRef(in context).@StringValue);
        writer.WriteConstantLiteral("!"u8);
    }

    [InterceptsLocation(1, "...")]
    public static void Write1(ref TemplateWriter<ArrayPoolBufferWriter<byte>> writer, string text, in SampleContext context, IFormatProvider? provider = null)
    {
        writer.WriteConstantLiteral("_Hello_999.000_"u8);
        writer.WriteValue(Unsafe.AsRef(in context).@IntValue, default, CultureInfo.InvariantCulture);
    }
}

<details> <summary>SimpleTextTemplate（非推奨）</summary>

SimpleTextTemplate.Renderer（非推奨）

SimpleTextTemplateとSimpleTextTemplate.Contextsへの参照が必要です。

using System;
using System.Text;
using CommunityToolkit.HighPerformance.Buffers;
using SimpleTextTemplate;
using SimpleTextTemplate.Contexts;
using Utf8Utility;

var symbols = new Utf8ArrayDictionary<Utf8Array>();
symbols.TryAdd((Utf8Array)"Identifier"u8.ToArray(), "Hello, World!"u8.ToArray());

using var bufferWriter = new ArrayPoolBufferWriter<byte>();
var source = "{{ Identifier }}"u8.ToArray();
var template = Template.Parse(source);
template.Render(bufferWriter, Context.Create(symbols));

// Hello, World!
Console.WriteLine(Encoding.UTF8.GetString(bufferWriter.WrittenSpan));

</details>

ベンチマーク

[!Note] ()で囲まれているメソッドは正確には処理が異なるが、参考として記載。

ベンチマークプロジェクト

サポートフレームワーク

.NET 9

作者

finphie

ライセンス

MIT

クレジット

このプロジェクトでは、次のライブラリ等を使用しています。

ライブラリ

• CommunityToolkit.HighPerformance
• Microsoft.CodeAnalysis.CSharp
• Utf8Utility

テスト

• FluentAssertions
• Microsoft.NET.Test.Sdk
• Newtonsoft.Json
• NuGet.Frameworks
• xunit
• xunit.runner.visualstudio

アナライザー

• DocumentationAnalyzers
• IDisposableAnalyzers
• Microsoft.CodeAnalysis.Analyzers
• Microsoft.CodeAnalysis.NetAnalyzers
• Microsoft.VisualStudio.Threading.Analyzers
• Roslynator.Analyzers
• Roslynator.Formatting.Analyzers
• StyleCop.Analyzers

ベンチマーク

• BenchmarkDotNet
• CommandLineParser
• Iced
• Microsoft.CodeAnalysis.CSharp
• Microsoft.Diagnostics.NETCore.Client
• Microsoft.Diagnostics.Runtime
• Microsoft.Diagnostics.Tracing.TraceEvent
• Perfolizer
• Scriban

その他

• Microsoft.SourceLink.GitHub
• PolySharp