SimpleTextTemplate.Abstractions 2.0.0

SimpleTextTemplate

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

説明

• 文字列をUTF-8バイト列としてIBufferWriter<byte>に出力します。
• 文字列を{{と}}で囲むことで変数を埋め込みます。
• {{と}}内の先頭と末尾の空白（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.Buffers;
using System.Text;
using CommunityToolkit.HighPerformance.Buffers;
using SimpleTextTemplate;

var context = new SampleContext("Hello, World", new(2000, 1, 1, 0, 0, 0, TimeSpan.Zero));

var bufferWriter = new ArrayPoolBufferWriter<byte>();
var template = new TemplateWriter<ArrayPoolBufferWriter<byte>>(ref bufferWriter);

template.Write("{{ DateTime }}_{{ Identifier }}!!!", context);
template.Dispose();

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

bufferWriter.Dispose();

readonly record struct SampleContext(string Identifier, [property: Identifier("o")] DateTimeOffset DateTime);

サンプルプロジェクト

生成コード

file static class Intercept
{
    [global::System.Runtime.CompilerServices.InterceptsLocation(@"<path>\Program.cs", 11, 10)]
    public static void Write0(this ref global::SimpleTextTemplate.TemplateWriter<global::CommunityToolkit.HighPerformance.Buffers.ArrayPoolBufferWriter<byte>> writer, string _, in global::SampleContext context)
    {
        writer.WriteValue(global::System.Runtime.CompilerServices.Unsafe.AsRef(in context).@DateTime, "o");
        writer.WriteLiteral("_"u8);
        writer.WriteString(global::System.Runtime.CompilerServices.Unsafe.AsRef(in context).@Identifier);
        writer.WriteLiteral("!!!"u8);
    }
}

SimpleTextTemplate（非推奨）

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(), (Utf8Array)"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));

ベンチマーク

[!Note] UTF-8またはUTF-16で出力
()で囲まれているメソッドは正確には処理が異なるため、参考情報

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

サポートフレームワーク

.NET 8

作者

finphie

ライセンス

MIT

クレジット

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

ライブラリ

• CommunityToolkit.Diagnostics
• 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
• 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