Visual Studio | Do Design Space

2018年9月8日 — さかぽん

Text Template Transformation Toolkit (T4) はテンプレートエンジンの一つで、主に Visual Studio で使われているものです。
これを使うと、ソースコードやデータの集合などのファイルを自動生成できます。

今回は例として、次のような Markdown を記述したら、
それに対応するクラスやプロパティを C# のソースコードとして生成することを考えます。

Person

int Id
string Name
DateTime Birthday
Uri
System.Text.Encoding Encoding

empty
number

int n
double? scale
DayOfWeek

view raw RecordTypes.md hosted with ❤ by GitHub

この Markdown の仕様を次のように定めます。

空行は無視
箇条書きでない行がクラス名
その下に続く箇条書きはプロパティ
- 「- Type PropertyName」の形式
- プロパティ名が省略された場合は、型名と同じ
クラス名およびプロパティ名は、PascalCase, camelCase のどちらを指定してもよい

以下では、このような .md ファイルを入力として、
プロパティおよびコンストラクターを持つ部分クラスを .cs ファイルに出力するように T4 で実装していきます。

まず、プロジェクトに上記の .md ファイルを追加しておきます。
そしてプロジェクトに「テキストテンプレート (.tt)」を追加します。

追加された .tt ファイルを、仕様に従って次のように実装します。

	<#@ template debug="false" hostspecific="true" language="C#" #>
	<#@ assembly name="System.Core" #>
	<#@ import namespace="System.Collections.Generic" #>
	<#@ import namespace="System.IO" #>
	<#@ import namespace="System.Linq" #>
	<#@ output extension=".cs" #>
	<#
	var types = GetTypeDefs(Host.ResolvePath("RecordTypes.md"));
	#>
	using System;

	namespace RecordGenConsole
	{
	<# foreach (var type in types) { #>
	public partial class <#= type.Key #>
	{
	<# foreach (var prop in type.Value) { #>
	public <#= prop.Value #> <#= prop.Key #> { get; }
	<# } #>

	public <#= type.Key #>(<#= string.Join(", ", type.Value.Select(p => $"{p.Value} {ToCamel(p.Key)}")) #>)
	{
	<# foreach (var prop in type.Value) { #>
	<#= prop.Key #> = <#= ToCamel(prop.Key) #>;
	<# } #>
	}
	}

	<# } #>
	}
	<#+
	Dictionary<string, Dictionary<string, string>> GetTypeDefs(string filePath)
	{
	var lines = File.ReadLines(filePath)
	.Where(l => !string.IsNullOrWhiteSpace(l))
	.ToArray();
	var typeLines = lines
	.Select((l, i) => new { l, i })
	.Where(_ => !_.l.StartsWith("-"))
	.ToArray();
	return typeLines
	.ToDictionary(_ => ToPascal(_.l.Trim()), _ => GetProps(_.i));

	Dictionary<string, string> GetProps(int i) => lines
	.Skip(i + 1)
	.TakeWhile(l => l.StartsWith("-"))
	.Select(l => l.Trim('-', ' ').Split())
	.ToDictionary(p => ToPascal(GetPropName(p)), p => p[0]);
	}

	string GetPropName(string[] prop) => prop[prop.Length == 1 ? 0 : 1];
	string ToPascal(string s) => char.ToUpperInvariant(s[0]) + s.Substring(1);
	string ToCamel(string s) => char.ToLowerInvariant(s[0]) + s.Substring(1);
	#>

view raw RecordTypes.tt hosted with ❤ by GitHub

注意点は以下の通りです。

初期状態では出力の拡張子が .txt になっているため、.cs に変更する
プロジェクト内のファイルのパスを取得するには、hostspecific="true" を指定して Host.ResolvePath メソッドを使う
<#= #> ：テキストの出力
<# #> ：コードを書ける、変数を使える
<#+ #> ：メソッド、クラスなどを定義できる

.tt ファイルを保存したときに処理が実行されます。
または、.tt ファイルを右クリックして [カスタムツールの実行] を選択すれば実行されます。

これで、以下のように RecordTypes.cs が生成されます。

	using System;
	using System.Text;

	namespace RecordGenConsole
	{
	class Program
	{
	static void Main(string[] args)
	{
	var person = new Person(4, "Shiro", DateTime.UtcNow, null, Encoding.UTF8);

	var n = new Number(3, 2.5, DayOfWeek.Sunday);
	Console.WriteLine(n.Scaled); // 7.5
	}
	}

	public partial class Number
	{
	public double Scaled => (Scale ?? 1) * N;
	}
	}

view raw Program.cs hosted with ❤ by GitHub

	using System;

	namespace RecordGenConsole
	{
	public partial class Person
	{
	public int Id { get; }
	public string Name { get; }
	public DateTime Birthday { get; }
	public Uri Uri { get; }
	public System.Text.Encoding Encoding { get; }

	public Person(int id, string name, DateTime birthday, Uri uri, System.Text.Encoding encoding)
	{
	Id = id;
	Name = name;
	Birthday = birthday;
	Uri = uri;
	Encoding = encoding;
	}
	}

	public partial class Empty
	{

	public Empty()
	{
	}
	}

	public partial class Number
	{
	public int N { get; }
	public double? Scale { get; }
	public DayOfWeek DayOfWeek { get; }

	public Number(int n, double? scale, DayOfWeek dayOfWeek)
	{
	N = n;
	Scale = scale;
	DayOfWeek = dayOfWeek;
	}
	}

	}

view raw RecordTypes.cs hosted with ❤ by GitHub

作成したサンプル

RecordGenConsole (GitHub)

テストしたバージョン

Visual Studio 2017

参照

.NET Core 向けビルドスクリプト

2018年9月1日 — さかぽん

ビルド用 PowerShell スクリプトの Build Release (GitHub) を .NET Framework プロジェクト形式向けに提供していましたが、
今回は .NET Core プロジェクト形式向けのビルドツールを追加しました。

ツールの内容：

(1) Version 1up

アセンブリのバージョン (x.y.z の z の部分) を 1 だけ増加させます。
.NET Core プロジェクト形式では、プロジェクトファイル (.csproj) でバージョンを書き換えます。

(2) Zip Release

プロジェクトを Release でビルドして、ZIP ファイルを作成します。
ビルド前にアセンブリのバージョンを増加させます。

(3) NuGet Packup

プロジェクトを Release でビルドして、NuGet パッケージを作成します。
ビルド前にアセンブリのバージョンを増加させます。

これらのツール (PowerShell スクリプト) を使う方法としては、Visual Studio の「外部ツール」に登録するのが便利だと思います。
前回にビルド用のスクリプトを Visual Studio の外部ツールに登録する方法について書きましたが、
.NET Core 版の手順も改めて以下に書いておきます。

セットアップ

Build-Release/Downloads (GitHub) からツールの最新版をダウンロードして任意のフォルダーに展開します。

Visual Studio のメニューで [ツール] – [外部ツール] を選択して各スクリプトを追加していきます。

タイトル: 任意
コマンド: powershell.exe
引数: -ExecutionPolicy Unrestricted "C:\scripts_folder\KTools.xxx.ps1"
初期ディレクトリ: $(ProjectDir)
- 右の ▶ ボタンで選択できる
- Version 1up では $(SolutionDir) でもよい
出力ウィンドウを使用: オン

プロジェクトの作成

.NET Core 向けのプロジェクトテンプレートを選択してプロジェクトを作成します。

.NET Framework プロジェクトではバージョン番号などを AssemblyInfo.cs に記述しますが、
.NET Core プロジェクトではプロジェクトファイル (.csproj) に記述します。
初期状態ではバージョンが設定されていない (その場合は 1.0.0 と判定される) ため、
プロジェクトのプロパティで [パッケージバージョン] の値を設定しておきます。

上記の設定をして保存すると、.csproj ファイルの <Version> に反映されます。

なお、.NET Core のプロジェクト形式でも、

<TargetFramework>net45</TargetFramework>

のようにすれば .NET Framework をターゲットにすることができます。
詳細は .NET Core と .NET Standard を参照してください。

ツールの実行：