Demandez à Visual Studio d'exécuter un modèle T4 sur chaque build

Comment obtenir un modèle T4 pour générer sa sortie sur chaque build? Dans l'état actuel des choses, il ne le régénère que lorsque je modifie le modèle.

J'ai trouvé d'autres questions similaires à celle-ci:

Transformation T4 et ordre de construction dans Visual Studio (sans réponse)

Comment obtenir des fichiers T4 à construire dans Visual Studio? (les réponses ne sont pas assez détaillées [tout en étant encore très compliquées] et n'ont même pas de sens)

Il doit y avoir un moyen plus simple de le faire!

J'ai utilisé la réponse de JoelFan pour venir avec ça. Je l'aime mieux car vous n'avez pas à vous rappeler de modifier l'événement de pré-construction chaque fois que vous ajoutez un nouveau fichier .tt au projet.

• ajoutez TextTransform.exe à votre %PATH%
• créé un fichier batch nommé transform_all.bat (voir ci-dessous)
• créer un événement de pré-construction " 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

Je suis d'accord avec GarethJ - dans VS2010, il est beaucoup plus facile de régénérer les modèles tt sur chaque build. Le blog d'Oleg Sych décrit comment le faire. En bref:

1. Installer le SDK Visual Studio
2. Installer le SDK de modélisation et de visualisation Visual Studio 2010
3. Ouvrir dans le fichier de projet de l'éditeur de texte et ajouter à la fin du fichier mais avant </Project>

C'est tout. Ouvrez votre projet. Sur chaque build, tous les modèles * .tt seront retraités

<!-- 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" />

Il existe un excellent package NuGet qui fait exactement cela:

PM> Install-Package Clarius.TransformOnBuild

Les détails sur le package peuvent être trouvés ici

J'ai utilisé la réponse de MarkGr et développé cette solution. Tout d'abord, créez un fichier de commandes appelé RunTemplate.bat dans un dossier d' outils distinct au-dessus du dossier de solution principal. Le fichier batch a juste la ligne:

"%CommonProgramFiles%\Microsoft Shared\TextTemplating\1.2\texttransform.exe" -out %1.cs -P %2 -P "%ProgramFiles%\Reference Assemblies\Microsoft\Framework\v3.5" %1.tt

Ce fichier de commandes prend 2 paramètres ... % 1 est le chemin d'accès au fichier .tt sans l'extension .tt. 2% est le chemin vers les DLL visées par l' Assemblée directives dans le modèle.

Ensuite, allez dans les propriétés du projet du projet contenant le modèle T4. Accédez aux événements de construction et ajoutez la ligne de commande d'événement de pré-construction suivante :

$(SolutionDir)..\..\tools\RunTemplate.bat $(ProjectDir)MyTemplate $(OutDir)

en remplaçant MyTemplate par le nom de fichier de votre fichier .tt (c'est-à-dire MyTemplate.tt) sans l'extension .tt. Cela aura pour résultat de développer le modèle pour produire MyTemplate.cs avant de générer le projet. Ensuite, la version réelle compilera MyTemplate.cs

Récemment trouvé ce super plugin VS, Chirpy .

Non seulement il génère votre T4 sur une version, mais il permet une approche basée sur T4 pour la minification de javascript, CSS, et vous permet même d'utiliser la syntaxe LESS pour votre CSS!

Le moyen le plus simple consiste probablement à installer une extension Visual Studio appelée AutoT4 .

Il exécute tous les modèles T4 lors de la construction de manière automatique.

La pré-construction peut être réduite à une seule ligne:

forfiles /p "$(ProjectDir)." /m "*.tt" /s /c "cmd /c echo Transforming @path && \"%CommonProgramFiles(x86)%\Microsoft Shared\TextTemplating\1.2\TextTransform.exe\" @file"

Cela transforme tous les .ttfichiers du projet et les répertorie dans la sortie de construction.

Si vous ne voulez pas la sortie de construction, vous devez contourner un "comportement intéressant" :

forfiles /p "$(ProjectDir)." /m "*.tt" /s /c "cmd /c @\"%CommonProgramFiles(x86)%\Microsoft Shared\TextTemplating\1.2\TextTransform.exe\" @file"

Bien sûr, vous pouvez extraire ceci dans un fichier batch auquel vous transmettez le chemin du répertoire du projet si vous le souhaitez.

NB Le chemin peut nécessiter quelques ajustements. Le chemin ci-dessus est l'endroit où VS 2008 l'a installé sur ma machine; mais vous constaterez peut-être que le numéro de version entre TextTemplatinget TextTransform.exeest différent.

Vérifiez C: \ Program Files (x86) \ Common Files \ Microsoft Shared \ TextTemplating, il y a un exe de transformation de ligne de commande. Vous pouvez également écrire une tâche MSBuild avec un hôte personnalisé et effectuer la transformation vous-même.

En développant les réponses de Seth Reno et JoelFan , je suis venu avec ceci. Avec cette solution, vous n'avez pas besoin de vous rappeler de modifier l'événement de pré-génération chaque fois que vous ajoutez un nouveau fichier .tt au projet.

Procédure de mise en œuvre

• Créez un fichier batch nommé transform_all.bat (voir ci-dessous)
• Créez un événement de pré-génération transform_all.bat "$(ProjectDir)" $(ProjectExt)pour chaque projet avec un .tt que vous souhaitez générer

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

REMARQUES

1. La transformation de texte suppose que le code du modèle T4 est le même langage que votre type de projet. Si ce cas ne s'applique pas à vous, vous devrez alors remplacer l' $(ProjectExt)argument par l'extension des fichiers que vous souhaitez que le code génère.

2. .TTles fichiers doivent être dans le répertoire du projet sinon ils ne seront pas compilés. Vous pouvez créer des fichiers TT en dehors du répertoire du projet en spécifiant un chemin différent comme premier argument ( c'est-à-dire remplacer "$(ProjectDir)"par le chemin contenant les fichiers TT.)

3. N'oubliez pas également de définir le chemin d'accès correct au transform_all.batfichier de commandes.
   Par exemple, je l'ai placé dans mon répertoire de solution pour que l'événement de pré-construction soit le suivant"$(SolutionDir)transform_all.bat" "$(ProjectDir)" $(ProjectExt)

Si vous utilisez Visual Studio 2010, vous pouvez utiliser le SDK Visual Studio Modeling and Visualization: http://code.msdn.microsoft.com/vsvmsdk

Cela contient des tâches msbuild pour exécuter des modèles T4 au moment de la construction.

Consultez le blog d'Oleg pour plus d'explications: http://www.olegsych.com/2010/04/understanding-t4-msbuild-integration

Hé, mon script peut également analyser l'extension de sortie

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%

Créez simplement transform_all.bat $(SolutionDir)un événement de pré-construction et tous les fichiers * .tt de votre solution seront transformés automatiquement.

Dynamo.AutoTT fera ce dont vous avez besoin. Vous pouvez le configurer pour regarder les fichiers via une regex ou générer sur build. Il vous permet également de spécifier les modèles T4 que vous souhaitez déclencher.

Vous pouvez le télécharger à partir d'ici : https://github.com/MartinF/Dynamo.AutoTT

Construisez-le, copiez les fichiers dll et AddIn dans

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

et c'est parti.

Si vous voulez le faire démarrer dans VS2012, vous devrez modifier le fichier Dynamo.AutoTT.AddIn et définir la version sur 11.0 dans le fichier AddIn;

Merci à GitHub.com/Mono/T4 , pour le moment, vous pouvez le faire pour les versions .NET Core et Visual Studio en ajoutant ceci à votre .csprojfichier:

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

Si vous transformez vos modèles en différents langages de programmation, vous devez ajouter quelque chose comme <Compile Remove="**\*.vb" />et <Compile Include="**\*.vb" />pour que ces fichiers soient compilés même si vous n'avez pas encore généré de fichiers.

Removeet Includeastuce uniquement nécessaire pour la première génération, ou vous pouvez raccourcir le XML comme ceci:

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

et exécutez simplement build deux fois (pour la première fois). Si vous avez déjà généré des fichiers validés dans le référentiel, il n'y aura aucun problème lors des reconstructions avec les deux exemples.

Dans Visual Studio, vous souhaiterez peut-être voir quelque chose comme ceci:

au lieu de cela:

Ajoutez donc quelque chose comme ceci à votre fichier de projet:

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

Exemple complet ici: GitHub.com/Konard/T4GenericsExample (inclut la génération de plusieurs fichiers à partir d'un seul modèle).

Voici ma solution - similaire à la réponse acceptée. Nous avons eu un problème avec notre contrôle de source. Les fichiers .cs cibles sont en lecture seule et le T4 a échoué. Voici le code, qui exécute T4 dans le dossier temporaire, compare les fichiers cibles et ne le copie qu'en cas de même changement. Cela ne résout pas le problème avec les fichiers read.only, mais au moins cela ne se produit pas très souvent:

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

Vous pouvez essayer d'ajouter votre commande d'extraction sur une ligne (:: Vous pouvez essayer ....)

Dans votre projet, définissez ceci comme une action de pré-construction:

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

Il vous suffit d'ajouter cette commande à l'événement de pré-construction du projet:

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

La vérification de configuration = debug, garantit que vous ne régénérez pas le code en mode release, lorsque vous faites la compilation sur le serveur de build TFS par exemple.

Dans Visual Studio 2013, cliquez avec le bouton droit sur le modèle T4 et définissez la propriété transform on build sur true.

Voici comment je l'ai abordé. Lien . Fondamentalement, en s'appuyant sur un excellent blog (blogs.clariusconsulting.net/kzu/how-to-transform-t4-templates-on-build-without-installing-a-visual-studio-sdk/ ne peut pas publier plus de 2 links :() J'ai créé ce fichier .targets à utiliser avec les fichiers proj de Visual Studio.

C'est utile lorsque vous utilisez d'autres dll-s dans votre .tt et que vous voulez que le résultat change à mesure que les dll changent.

Comment ça fonctionne:

1. Créez le tt, ajoutez le nom de l'assembly = "$ (SolutionDir) path \ to \ other \ project \ output \ foo.dll et configurez la transformation et le résultat comme prévu

2. Supprimer les références d'assembly de .tt

3. Dans le fichier proj, utilisez ce code pour configurer la transformation lors de la construction:

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

   • La première partie localise TextTransform.exe

   • $(IncludeForTransform)sera égal à c:\path\to\dll\foo.dll' -r c:\path\to\dll\bar.dllcar c'est la façon d'ajouter des références pour le TextTransform sur la ligne de commande

      <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" />cela crée une liste de tous les fichiers tt à l'intérieur du projet et des sous-répertoires

   • <Exec Command="... produit une ligne pour chacun des fichiers .tt trouvés qui ressemble à "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. La seule chose à faire est d'ajouter les chemins vers les DLL à l'intérieur de:

       <ItemGroup>
         <DllsToInclude Include="$(ProjectDir)path\to\foo.dll">
           <InProject>False</InProject>
         </DllsToInclude>
         <DllsToInclude Include="$(ProjectDir)path\to\bar.dll">
           <InProject>False</InProject>
         </DllsToInclude>
       </ItemGroup>

   Ici <InProject>False</InProject>masque ces éléments de la vue Solution

Alors maintenant, vous devriez être en mesure de générer votre code lors de la compilation et du changement de dll-s.

Vous pouvez supprimer l'outil personnalisé (des propriétés à l'intérieur de Visual Studio) afin que le VS n'essaye pas de se transformer et échoue lamentablement à chaque fois. Parce que nous avons supprimé les références d'assemblage à l'étape 2

T4Executer fait cela pour VS2019. Vous pouvez spécifier des modèles à ignorer lors de la construction, et il existe une option d'exécution après la construction.

Vous venez d'installer le package NuGet : Clarius.TransformOnBuild

Ensuite, chaque fois que vous cliquez sur Rebuild project (ou Solution), vos fichiers .tt s'exécuteront

Dans Visual Studio 2017 (probablement les prochaines versions également), vous devez ajouter ceci dans l'événement Pre-build:

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

ps Modifiez le chemin de votre modèle s'il ne se trouve pas dans le répertoire racine du projet.

Un type a construit un paquet nuget pour ça.

Remarque: j'obtiens des erreurs de compilation de TextTemplate.exe et de ce package (car ce package appelle TextTemplate.exe) mais pas de Visual Studio. Donc, apparemment, le comportement n'est pas le même; la tête haute.

EDIT: Cela a fini par être mon problème.

Voici un événement de pré-construction utilisant uniquement les outils Microsoft et les chemins standard. Il est testé dans vs2019 / netcore3.1.

Remplacez "AppDbContext.tt" par le chemin de fichier relatif à votre projet:

"$(MSBuildBinPath)\msbuild" $(SolutionPath) /t:$(ProjectName):Transform /p:TransformFile="AppDbContext.tt" /p:CustomAfterMicrosoftCommonTargets="$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)\TextTemplating\Microsoft.TextTemplating.targets"

Microsoft a également un guide pour rendre des macros telles que "$ (SolutionDirectory)" disponibles dans le modèle en utilisant T4ParameterValues dans votre fichier de projet.