ビルドごとに出力を生成するT4テンプレートを取得するにはどうすればよいですか?現在のように、テンプレートに変更を加えた場合にのみ再生成されます。
私はこれに似た他の質問を見つけました:
Visual StudioでのT4変換とビルド順序(未回答)
Visual Studioでビルドするt4ファイルを取得するにはどうすればよいですか?(回答は[まだ十分に複雑ですが]十分に詳細ではなく、完全に意味がありません)
これを行うには、もっと簡単な方法が必要です。
ビルドごとに出力を生成するT4テンプレートを取得するにはどうすればよいですか?現在のように、テンプレートに変更を加えた場合にのみ再生成されます。
私はこれに似た他の質問を見つけました:
Visual StudioでのT4変換とビルド順序(未回答)
Visual Studioでビルドするt4ファイルを取得するにはどうすればよいですか?(回答は[まだ十分に複雑ですが]十分に詳細ではなく、完全に意味がありません)
これを行うには、もっと簡単な方法が必要です。
私はGarethJに同意します-VS2010では、ビルドごとにttテンプレートを再生成する方がはるかに簡単です。Oleg Sychのブログでは、その方法について説明しています。要するに:
</Project>
それでおしまい。プロジェクトを開きます。ビルドごとに、すべての*.ttテンプレートが再処理されます
<!-- This line could already present in file. If it is so just skip it -->
<Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
<!-- process *.tt templates on each build -->
<PropertyGroup>
<TransformOnBuild>true</TransformOnBuild>
</PropertyGroup>
<Import Project="$(MSBuildExtensionsPath)\Microsoft\VisualStudio\TextTemplating\v10.0\Microsoft.TextTemplating.targets" />
JoelFanの答えを使ってこれを思いついた。プロジェクトに新しい.ttファイルを追加するたびにビルド前のイベントを変更することを覚えておく必要がないので、私はそれがより好きです。
%PATH%
transform_all ..\..
"transform_all.bat
@echo off
SETLOCAL ENABLEDELAYEDEXPANSION
:: set the working dir (default to current dir)
set wdir=%cd%
if not (%1)==() set wdir=%1
:: set the file extension (default to vb)
set extension=vb
if not (%2)==() set extension=%2
echo executing transform_all from %wdir%
:: create a list of all the T4 templates in the working dir
dir %wdir%\*.tt /b /s > t4list.txt
echo the following T4 templates will be transformed:
type t4list.txt
:: transform all the templates
for /f %%d in (t4list.txt) do (
set file_name=%%d
set file_name=!file_name:~0,-3!.%extension%
echo: \--^> !file_name!
TextTransform.exe -out !file_name! %%d
)
echo transformation complete
これを実行する優れたNuGetパッケージがあります。
PM> Install-Package Clarius.TransformOnBuild
私はMarkGrの答えを使用して、このソリューションを開発しました。まず、メインソリューションフォルダーの上にある別のツールフォルダーにRunTemplate.batというバッチファイルを作成します。バッチファイルには次の行があります。
"%CommonProgramFiles%\Microsoft Shared\TextTemplating\1.2\texttransform.exe" -out %1.cs -P %2 -P "%ProgramFiles%\Reference Assemblies\Microsoft\Framework\v3.5" %1.tt
このバッチファイルは2つのパラメータを取ります... %1は、.tt拡張子のない.ttファイルへのパスです。 %2は、テンプレート内のアセンブリディレクティブによって参照されるDLLへのパスです。
次に、T4テンプレートを含むプロジェクトのプロジェクトプロパティに移動します。ビルドイベントに移動し、次のビルド前イベントコマンドラインを追加します。
$(SolutionDir)..\..\tools\RunTemplate.bat $(ProjectDir)MyTemplate $(OutDir)
MyTemplateを、 .tt拡張子のない.ttファイルのファイル名(つまり、MyTemplate.tt)に置き換えます。これにより、プロジェクトをビルドする前に、テンプレートを拡張してMyTemplate.csを生成できます。次に、実際のビルドはMyTemplate.csをコンパイルします
最近、この素晴らしいVSプラグインChirpyを見つけました。
ビルドでT4を生成するだけでなく、JavaScript、CSSを縮小するためのT4ベースのアプローチを可能にし、CSSにLESS構文を使用することもできます。
おそらく最も簡単な方法は、AutoT4と呼ばれるVisualStudio拡張機能をインストールすることです。
ビルド時にすべてのT4テンプレートを自動的に実行します。
プレビルドは、次の1行に減らすことができます。
forfiles /p "$(ProjectDir)." /m "*.tt" /s /c "cmd /c echo Transforming @path && \"%CommonProgramFiles(x86)%\Microsoft Shared\TextTemplating\1.2\TextTransform.exe\" @file"
これにより、プロジェクト内のすべての.tt
ファイルが変換され、ビルド出力に一覧表示されます。
ビルド出力が必要ない場合は、「興味深い動作」を回避する必要があります。
forfiles /p "$(ProjectDir)." /m "*.tt" /s /c "cmd /c @\"%CommonProgramFiles(x86)%\Microsoft Shared\TextTemplating\1.2\TextTransform.exe\" @file"
もちろん、必要に応じて、これをバッチファイルに引き出してプロジェクトディレクトリパスを渡すこともできます。
注意:パスには微調整が必要な場合があります。上記のパスは、VS2008が私のマシンにインストールした場所です。TextTemplating
ただし、との間のバージョン番号TextTransform.exe
が異なる場合があります。
C:\ Program Files(x86)\ Common Files \ Microsoft Shared \ TextTemplatingをチェックしてください。そこには、コマンドライン変換exeがあります。または、カスタムホストを使用してMSBuildタスクを記述し、自分で変換を実行します。
GitHub.com/Mono/T4のおかげで、現時点では、これを.csproj
ファイルに追加することで、.NETCoreとVisualStudioの両方のビルドで実行できます。
<ItemGroup>
<DotNetCliToolReference Include="dotnet-t4-project-tool" Version="2.0.5" />
<TextTemplate Include="**\*.tt" />
</ItemGroup>
<Target Name="TextTemplateTransform" BeforeTargets="BeforeBuild">
<ItemGroup>
<Compile Remove="**\*.cs" />
</ItemGroup>
<Exec WorkingDirectory="$(ProjectDir)" Command="dotnet t4 %(TextTemplate.Identity)" />
<ItemGroup>
<Compile Include="**\*.cs" />
</ItemGroup>
</Target>
テンプレートをさまざまなプログラミング言語に変換する場合は、ファイルをまだ生成していない場合でも、これらのファイルをコンパイルするために、など<Compile Remove="**\*.vb" />
を追加する必要があります。<Compile Include="**\*.vb" />
Remove
Include
初めて生成する場合にのみ必要なトリックです。または、次のようにXMLを短くすることができます。
<ItemGroup>
<DotNetCliToolReference Include="dotnet-t4-project-tool" Version="2.0.5" />
<TextTemplate Include="**\*.tt" />
</ItemGroup>
<Target Name="TextTemplateTransform" BeforeTargets="BeforeBuild">
<Exec WorkingDirectory="$(ProjectDir)" Command="dotnet t4 %(TextTemplate.Identity)" />
</Target>
ビルドを2回実行するだけです(初めて)。リポジトリにコミットされたファイルをすでに生成している場合は、両方の例で再構築しても問題はありません。
Visual Studioでは、次のようなものを見たいと思うかもしれません。
これの代わりに:
したがって、次のようなものをプロジェクトファイルに追加します。
<ItemGroup>
<Compile Update="UInt16Class.cs">
<DependentUpon>UInt16Class.tt</DependentUpon>
</Compile>
<Compile Update="UInt32Class.cs">
<DependentUpon>UInt32Class.tt</DependentUpon>
</Compile>
<Compile Update="UInt64Class.cs">
<DependentUpon>UInt64Class.tt</DependentUpon>
</Compile>
<Compile Update="UInt8Class.cs">
<DependentUpon>UInt8Class.tt</DependentUpon>
</Compile>
</ItemGroup>
ここで完全な例:GitHub.com/Konard/T4GenericsExample(単一のテンプレートからの複数のファイルの生成を含む)。
Seth RenoとJoelFanの答えを拡張して、私はこれを思いついた。このソリューションでは、プロジェクトに新しい.ttファイルを追加するたびにビルド前のイベントを変更することを覚えておく必要はありません。
transform_all.bat "$(ProjectDir)" $(ProjectExt)
ビルドする.ttを使用して、プロジェクトごとにビルド前イベントを作成しますtransform_all.bat
@echo off
SETLOCAL ENABLEDELAYEDEXPANSION
:: set the correct path to the the app
if not defined ProgramFiles(x86). (
echo 32-bit OS detected
set ttPath=%CommonProgramFiles%\Microsoft Shared\TextTemplating\1.2\
) else (
echo 64-bit OS detected
set ttPath=%CommonProgramFiles(x86)%\Microsoft Shared\TextTemplating\1.2\
)
:: set the working dir (default to current dir)
if not (%1)==() pushd %~dp1
:: set the file extension (default to vb)
set ext=%2
if /i %ext:~1%==vbproj (
set ext=vb
) else if /i %ext:~1%==csproj (
set ext=cs
) else if /i [%ext%]==[] (
set ext=vb
)
:: create a list of all the T4 templates in the working dir
echo Running TextTransform from %cd%
dir *.tt /b /s | findstr /vi obj > t4list.txt
:: transform all the templates
set blank=.
for /f "delims=" %%d in (t4list.txt) do (
set file_name=%%d
set file_name=!file_name:~0,-3!.%ext%
echo: \--^> !!file_name:%cd%=%blank%!
"%ttPath%TextTransform.exe" -out "!file_name!" "%%d"
)
:: delete T4 list and return to previous directory
del t4list.txt
popd
echo T4 transformation complete
ノート
テキスト変換は、T4テンプレートのコードがプロジェクトタイプと同じ言語であることを前提としています。このケースが当てはまらない場合は、$(ProjectExt)
引数をコードで生成するファイルの拡張子に置き換える必要があります。
.TT
ファイルはプロジェクトディレクトリにある必要があります。そうでない場合、ファイルはビルドされません。最初の引数として別のパスを指定することにより、プロジェクトディレクトリの外にTTファイルを作成できます(つまり"$(ProjectDir)"
、TTファイルを含むパスに置き換えます)。
transform_all.bat
バッチファイルへの正しいパスを設定することも忘れないでください。
たとえば、ソリューションディレクトリに配置したため、ビルド前のイベントは次のようになりました。"$(SolutionDir)transform_all.bat" "$(ProjectDir)" $(ProjectExt)
Visual Studio 2010を使用している場合は、Visual Studio Modeling and Visualization SDKを使用できます:http: //code.msdn.microsoft.com/vsvmsdk
これには、ビルド時にT4テンプレートを実行するためのmsbuildタスクが含まれています。
詳細については、Olegのブログをご覧ください: http ://www.olegsych.com/2010/04/understanding-t4-msbuild-integration
ねえ、私のスクリプトは出力拡張も解析できます
for /r %1 %%f in (*.tt) do (
for /f "tokens=3,4 delims==, " %%a in (%%f) do (
if %%~a==extension "%CommonProgramFiles%\Microsoft Shared\TextTemplating\1.2\texttransform.exe" -out %%~pnf.%%~b -P %%~pf -P "%ProgramFiles%\Reference Assemblies\Microsoft\Framework\v3.5" %%f
)
)
echo Exit Code = %ERRORLEVEL%
ビルド前のイベントを作成するだけtransform_all.bat $(SolutionDir)
で、ソリューション内のすべての*.ttファイルが自動的に変換されます。
Dynamo.AutoTTは必要なことを実行します。正規表現を介してファイルを監視するか、ビルド時に生成するように構成できます。また、トリガーするT4テンプレートを指定することもできます。
ここからダウンロードできます:https ://github.com/MartinF/Dynamo.AutoTT
それをビルドし、dllファイルとアドインファイルをにコピーするだけです
C:\ Users \ Documents \ Visual Studio 2012 \ Addins \
そして離れてあなたは行きます。
VS2012で実行したい場合は、Dynamo.AutoTT.AddInファイルを変更し、AddInファイル内でバージョンを11.0に設定する必要があります。
このコマンドをプロジェクトのビルド前イベントに追加する必要があります。
if $(ConfigurationName) == Debug $(MSBuildToolsPath)\Msbuild.exe /p:CustomBeforeMicrosoftCSharpTargets="$(ProgramFiles)\MSBuild\Microsoft\VisualStudio\v11.0\TextTemplating\Microsoft.TextTemplating.targets" $(ProjectPath) /t:TransformAll
構成=デバッグのチェックでは、たとえばTFSビルドサーバーでビルドを実行するときに、リリースモードでコードを再生成しないようにします。
Visual Studio 2017(おそらく次のバージョンも)では、ビルド前のイベントにこれを追加する必要があります。
"$(DevEnvDir)TextTransform.exe" -out "$(ProjectDir)YourTemplate.cs" "$(ProjectDir)YourTemplate.tt"
psテンプレートがルートプロジェクトディレクトリにない場合は、テンプレートへのパスを変更します。
これが私の解決策です-受け入れられた答えに似ています。ソース管理に問題がありました。ターゲットの.csファイルは読み取り専用であり、T4は失敗していました。これは、tempフォルダーでT4を実行し、ターゲットファイルを比較し、同じ変更があった場合にのみコピーするコードです。read.onlyファイルの問題は修正されませんが、少なくとも頻繁には発生しません。
Transform.bat
ECHO Transforming T4 templates
SET CurrentDirBackup=%CD%
CD %1
ECHO %1
FOR /r %%f IN (*.tt) DO call :Transform %%f
CD %CurrentDirBackup%
ECHO T4 templates transformed
goto End
:Transform
set ttFile=%1
set csFile=%1
ECHO Transforming %ttFile%:
SET csFile=%ttFile:~0,-2%cs
For %%A in ("%ttFile%") do Set tempTT=%TEMP%\%%~nxA
For %%A in ("%csFile%") do Set tempCS=%TEMP%\%%~nxA
copy "%ttFile%" "%tempTT%
"%COMMONPROGRAMFILES(x86)%\microsoft shared\TextTemplating\11.0\TextTransform.exe" "%tempTT%"
fc %tempCS% %csFile% > nul
if errorlevel 1 (
:: You can try to insert you check-out command here.
"%COMMONPROGRAMFILES(x86)%\microsoft shared\TextTemplating\11.0\TextTransform.exe" "%ttFile%"
) ELSE (
ECHO no change in %csFile%
)
del %tempTT%
del %tempCS%
goto :eof
:End
チェックアウトコマンドを1行に追加してみることができます(::試すことができます....)
プロジェクトで、これをビルド前のアクションとして設定します。
Path-To-Transform.bat "$(ProjectDir)"
Visual Studio 2013で、T4テンプレートを右クリックし、ビルドプロパティの変換をtrueに設定します。
これが私がそれに取り組んだ方法です。リンク。基本的に素晴らしいブログの上に構築する(blogs.clariusconsulting.net/kzu/how-to-transform-t4-templates-on-build-without-installing-a-visual-studio-sdk/は2つ以上投稿することはできませんリンク:()ビジュアルスタジオのプロジェクトファイルで使用するために、この.targetsファイルを思いつきました。
.tt内で他のdll-sを使用していて、dll-sの変更に応じて結果を変更したい場合に便利です。
使い方:
.ttからアセンブリ参照を削除します
projファイル内で、次のコードを使用してビルド時に変換を設定します。
<PropertyGroup>
<!-- Initial default value -->
<_TransformExe>$(CommonProgramFiles)\Microsoft Shared\TextTemplating\10.0\TextTransform.exe</_TransformExe>
<!-- If explicit VS version, override default -->
<_TransformExe Condition="'$(VisualStudioVersion)' != ''">$(CommonProgramFiles)\Microsoft Shared\TextTemplating\$(VisualStudioVersion)\TextTransform.exe</_TransformExe>
<!-- Cascading probing if file not found -->
<_TransformExe Condition="!Exists('$(_TransformExe)')">$(CommonProgramFiles)\Microsoft Shared\TextTemplating\10.0\TextTransform.exe</_TransformExe>
<_TransformExe Condition="!Exists('$(_TransformExe)')">$(CommonProgramFiles)\Microsoft Shared\TextTemplating\11.0\TextTransform.exe</_TransformExe>
<_TransformExe Condition="!Exists('$(_TransformExe)')">$(CommonProgramFiles)\Microsoft Shared\TextTemplating\12.0\TextTransform.exe</_TransformExe>
<!-- Future proof 'til VS2013+2 -->
<_TransformExe Condition="!Exists('$(_TransformExe)')">$(CommonProgramFiles)\Microsoft Shared\TextTemplating\13.0\TextTransform.exe</_TransformExe>
<_TransformExe Condition="!Exists('$(_TransformExe)')">$(CommonProgramFiles)\Microsoft Shared\TextTemplating\14.0\TextTransform.exe</_TransformExe>
<_TransformExe Condition="!Exists('$(_TransformExe)')">$(CommonProgramFiles)\Microsoft Shared\TextTemplating\15.0\TextTransform.exe</_TransformExe>
<IncludeForTransform>@(DllsToInclude, '&quot; -r &quot;')</IncludeForTransform>
</PropertyGroup>
最初の部分はTextTransform.exeを見つけます
$(IncludeForTransform)
c:\path\to\dll\foo.dll' -r c:\path\to\dll\bar.dll
コマンドラインでTextTransformの参照を追加する方法であるため、 はに等しくなります
<Target Name="TransformOnBuild" BeforeTargets="BeforeBuild">
<!--<Message Text="$(IncludeForTransform)" />-->
<Error Text="Failed to find TextTransform.exe tool at '$(_TransformExe)." Condition="!Exists('$(_TransformExe)')" />
<ItemGroup>
<_TextTransform Include="$(ProjectDir)**\*.tt" />
</ItemGroup>
<!-- Perform task batching for each file -->
<Exec Command=""$(_TransformExe)" "@(_TextTransform)" -r "$(IncludeForTransform)"" Condition="'%(Identity)' != ''" />
</Target>
<_TextTransform Include="$(ProjectDir)**\*.tt" />
これにより、プロジェクトおよびサブディレクトリ内のすべてのttファイルのリストが作成されます
<Exec Command="...
見つかった.ttファイルごとに次のような行を生成します"C:\path\to\Transform.exe" "c:\path\to\my\proj\TransformFile.tt" -r"c:\path\to\foo.dll" -r "c:\path\to\bar.dll"
あとは、次の内部のdllへのパスを追加するだけです。
<ItemGroup>
<DllsToInclude Include="$(ProjectDir)path\to\foo.dll">
<InProject>False</InProject>
</DllsToInclude>
<DllsToInclude Include="$(ProjectDir)path\to\bar.dll">
<InProject>False</InProject>
</DllsToInclude>
</ItemGroup>
ここで<InProject>False</InProject>
は、これらのアイテムをソリューションビューから非表示にします
これで、ビルド時とdll-sの変更時にコードを生成できるようになります。
カスタムツールを(Visual Studio内のプロパティから)削除して、VSが変換を試みたり、毎回惨めに失敗したりしないようにすることができます。手順2でアセンブリ参照を削除したため
T4ExecuterはVS2019に対してこれを行います。ビルド時に無視するテンプレートを指定でき、ビルド後に実行オプションがあります。
NuGetパッケージをインストールするだけです:Clarius.TransformOnBuild
その後、[プロジェクト(またはソリューション)の再構築]をクリックするたびに、 .ttファイルが実行されます
何人かの男がこのためのnugetパッケージを作成しました。
補足:TextTemplate.exeとそのパッケージ(パッケージがTextTemplate.exeを呼び出すため)の両方からコンパイルエラーが発生しますが、VisualStudioからは発生しません。したがって、明らかに動作は同じではありません。注意喚起。
編集:これは私の問題になってしまいました。
これは、MicrosoftToolingと標準パスのみを使用したビルド前のイベントです。vs2019/netcore3.1でテストされています。
「AppDbContext.tt」をプロジェクト相対ファイルパスに置き換えます。
"$(MSBuildBinPath)\msbuild" $(SolutionPath) /t:$(ProjectName):Transform /p:TransformFile="AppDbContext.tt" /p:CustomAfterMicrosoftCommonTargets="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\TextTemplating\Microsoft.TextTemplating.targets"
Microsoftには、プロジェクトファイルでT4ParameterValuesを使用して、テンプレートで「$(SolutionDirectory)」などのマクロを使用できるようにするためのガイドもあります。