获取Visual Studio在每个版本上运行T4模板

如何获得T4模板以在每次构建时生成其输出？现在，它仅在我对模板进行更改时才重新生成。

我发现了其他与此类似的问题：

Visual Studio中的T4转换和构建顺序（未回答）

如何在Visual Studio中构建t4文件？（答案不够详细（尽管仍然很复杂），甚至完全没有意义）

必须有一个更简单的方法来做到这一点！

我用JoelFan的答案来提出这个问题。我更喜欢它，因为您不必记住每次将新的.tt文件添加到项目时都要修改预构建事件。

• 将TextTransform.exe添加到您的 %PATH%
• 创建了一个名为transform_all.bat的批处理文件（如下所示）
• 创建预构建事件“ 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

我同意GarethJ的观点-在VS2010中，在每个版本上重新生成tt模板要容易得多。Oleg Sych的博客描述了如何做到这一点。简而言之：

1. 安装Visual Studio SDK
2. 安装Visual Studio 2010建模和可视化SDK
3. 在文本编辑器项目文件中打开，然后添加到文件末尾，但之前 </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" />

有一个很棒的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)

用您的.tt文件（即MyTemplate.tt）的文件名（不带.tt扩展名）替换MyTemplate。这将导致在构建项目之前将模板扩展为生成MyTemplate.cs。然后实际构建将编译MyTemplate.cs

最近发现了这个很棒的VS插件Chirpy。

它不仅会在构建中生成T4，而且允许使用基于T4的方法来最小化javascript，CSS，甚至允许您为CSS使用LESS语法！

可能最简单的方法是安装一个名为AutoT4的Visual Studio扩展。

它自动运行所有T4模板。

预构建可以简化为一行：

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"

当然，您可以将其提取到批处理文件中，如果需要，可以将项目目录路径传递到该文件中。

注意：该路径可能需要进行一些调整。上面的路径是VS 2008在我的计算机上安装它的位置；但是您可能会发现TextTemplating和之间的版本号TextTransform.exe不同。

签出C：\ Program Files（x86）\ Common Files \ Microsoft Shared \ TextTemplating那里有一个命令行转换exe。或者，使用自定义主机编写MSBuild任务，然后自己进行转换。

扩展Seth Reno和JoelFan的答案时，我了这个。使用此解决方案，无需在每次向项目中添加新的.tt文件时都记得修改预构建事件。

实施程序

• 创建一个名为transform_all.bat的批处理文件（如下所示）
• 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

笔记

1. 文本转换假定T4模板中的代码与项目类型使用相同的语言。如果这种情况不适用于您，那么您将必须$(ProjectExt)用要生成代码的文件的扩展名替换参数。

2. .TT文件必须位于项目目录中，否则将无法生成。您可以通过将其他路径指定为第一个参数来构建项目目录之外的TT文件（即，用"$(ProjectDir)"包含TT文件的路径替换）。

3. 还要记住还要为transform_all.bat批处理文件设置正确的路径。
   例如，我将其放置在解决方案目录中，因此预构建事件如下"$(SolutionDir)transform_all.bat" "$(ProjectDir)" $(ProjectExt)

如果您使用的是Visual Studio 2010，则可以使用Visual Studio建模和可视化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和AddIn文件复制到

C：\ Users \ Documents \ Visual Studio 2012 \ Addins \

而你走了。

如果要在VS2012中使用它，则需要修改Dynamo.AutoTT.AddIn文件，并将AddIn文件中的Version设置为11.0。

感谢GitHub.com/Mono/T4，目前，您可以通过将它添加到.csproj文件中来进行.NET Core和Visual Studio构建：

  <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>

并只运行两次构建（第一次）。如果您已经生成了提交到存储库的文件，那么这两个示例在重建时都不会出现问题。

在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（包括从单个模板生成多个文件）。

这是我的解决方案-类似于已接受的答案。我们的源代码管理有问题。目标.cs文件为只读文件，并且T4失败。这是在temp文件夹中运行T4，比较目标文件并仅在有相同更改的情况下将其复制的代码。它不能解决只读文件的问题，但至少不会经常发生：

变形蝙蝠

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

您可以尝试在一行上添加结帐命令（::您可以尝试....）

在您的项目中，将其设置为预构建操作：

Path-To-Transform.bat "$(ProjectDir)"

您只需要将此命令添加到项目的预构建事件中：

if $(ConfigurationName) == Debug $(MSBuildToolsPath)\Msbuild.exe  /p:CustomBeforeMicrosoftCSharpTargets="$(ProgramFiles)\MSBuild\Microsoft\VisualStudio\v11.0\TextTemplating\Microsoft.TextTemplating.targets"  $(ProjectPath) /t:TransformAll 

例如，在TFS构建服务器上进行构建时，对configuration = debug的检查可确保您不会在发布模式下重新生成代码。

在Visual Studio 2013中，右键单击T4模板，然后将“构建时转换”属性设置为true。

这就是我的解决方法。链接。基本上建立在一个很棒的博客上（blogs.clariusconsulting.net/kzu/how-to-transform-t4-templates-on-build-without-installing-a-visual-studio-sdk/不能发布超过2个链接:(）我想出了.targets文件，用于Visual Studio项目文件。

当您在.tt中使用其他dll且您希望结果随dll的变化而变化时，此功能很有用。

这个怎么运作：

1. 创建tt，添加程序集名称=“ $（SolutionDir）path \到\ other \ project \ output \ foo.dll，并将转换和结果设置为预期的值

2. 从.tt删除程序集引用

3. 在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, '&amp;quot; -r &amp;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="&quot;$(_TransformExe)&quot; &quot;@(_TextTransform)&quot; -r &quot;$(IncludeForTransform)&quot;" 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"

4. 剩下要做的唯一一件事就是在以下位置添加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文件都会运行

在Visual Studio 2017中（可能也是下一版本），应在Pre-build事件中添加此内容：

"$(DevEnvDir)TextTransform.exe" -out "$(ProjectDir)YourTemplate.cs" "$(ProjectDir)YourTemplate.tt"

ps如果模板不在根项目目录中，请更改其路径。

有人造了一个nuget包为此。

旁注：我同时从TextTemplate.exe和该程序包（因为该程序包调用TextTemplate.exe）获得编译错误，但没有从Visual Studio中获得编译错误。因此，显然行为是不一样的。小心。

编辑：这最终是我的问题。

这是仅使用Microsoft工具和标准路径的预构建事件。已在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）”之类的宏可用。