SimpleTextTemplate.Abstractions 1.1.0

SimpleTextTemplate

シンプルなテキストテンプレートエンジンです。

説明

SimpleTextTemplateは、識別子の置換のみに対応したテキストテンプレートエンジンです。

インストール

NuGet（正式リリース版）

dotnet add package SimpleTextTemplate
dotnet add package SimpleTextTemplate.Contexts

dotnet add package SimpleTextTemplate.Generator

Azure Artifacts（開発用ビルド）

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

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

使い方

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

SimpleTextTemplate

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

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

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

SimpleTextTemplate.Generator

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

var context = new SampleContext(Encoding.UTF8.GetBytes("Hello, World!"));

using var bufferWriter = new ArrayPoolBufferWriter<byte>();
ZTemplate.Render(bufferWriter, context);

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

readonly record struct SampleContext(byte[] Identifier);

static partial class ZTemplate
{
    // TemplateAttributeでは、テンプレート文字列を指定してください。
    [Template("{{ Identifier }}")]  
    public static partial void Render(IBufferWriter<byte> bufferWriter, SampleContext context);

    // TemplateFileAttributeでは、指定されたファイルを解析します。
    // 相対パスを指定した場合、プロジェクトファイルが存在するディレクトリが基準となります。
    // 基準ディレクトリを変更する場合は、プロジェクトファイルで次のように設定します。
    // <PropertyGroup>
    //     <SimpleTextTemplatePath></SimpleTextTemplatePath>
    // </PropertyGroup>

    // [TemplateFile("template.txt")]
    // public static partial void Render(IBufferWriter<byte> bufferWriter, SampleContext context);
}

サンプルプロジェクト

ベンチマーク

レンダリング

BenchmarkDotNet=v0.13.1, OS=Windows 10.0.19043.1526 (21H1/May2021Update)
AMD Ryzen 7 5800U with Radeon Graphics, 1 CPU, 16 logical and 8 physical cores
.NET SDK=6.0.200-preview.22055.15
  [Host]   : .NET 6.0.2 (6.0.222.6406), X64 RyuJIT
  .NET 6.0 : .NET 6.0.2 (6.0.222.6406), X64 RyuJIT

Job=.NET 6.0  Runtime=.NET 6.0  

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

サポートフレームワーク

• .NET 6

作者

finphie

ライセンス

MIT

クレジット

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

ライブラリ

• CommunityToolkit.HighPerformance
• Humanizer.Core
• Microsoft.CodeAnalysis.Analyzers
• Microsoft.CodeAnalysis.CSharp.Workspaces
• Utf8Utility

テスト

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

アナライザー

• Microsoft.CodeAnalysis.NetAnalyzers (SDK組み込み)
• 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