Dapatkan Visual Studio untuk menjalankan Template T4 di setiap bangunan

Bagaimana cara mendapatkan templat T4 untuk menghasilkan output pada setiap build? Seperti sekarang, itu hanya membuat ulang ketika saya membuat perubahan pada templat.

Saya telah menemukan pertanyaan lain yang mirip dengan ini:

Transformasi T4 dan membangun ketertiban dalam Visual Studio (tidak dijawab)

Bagaimana cara membuat file t4 di studio visual?(jawaban tidak cukup detail [sementara masih banyak rumit] dan bahkan tidak masuk akal total)

Pasti ada cara yang lebih sederhana untuk melakukan ini!

Saya menggunakan jawaban JoelFan untuk muncul bersama ini. Saya menyukainya lebih baik karena Anda tidak harus ingat untuk memodifikasi acara pra-bangun setiap kali Anda menambahkan file .tt baru ke proyek.

• tambahkan TextTransform.exe ke %PATH%
• membuat file batch bernama transform_all.bat (lihat di bawah)
• buat acara pra-bangun " 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

Saya setuju dengan GarethJ - dalam VS2010 jauh lebih mudah untuk membuat ulang tt templat pada setiap build. Blog Oleg Sych menjelaskan cara melakukannya. Pendeknya:

1. Instal Visual Studio SDK
2. Instal Visual Studio 2010 Pemodelan dan Visualisasi SDK
3. Buka di file proyek editor teks dan tambahkan ke akhir file tetapi sebelumnya </Project>

Itu dia. Buka proyek Anda. Pada setiap build semua * .tt templat akan diproses ulang

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

Ada paket NuGet hebat yang melakukan hal ini:

PM> Install-Package Clarius.TransformOnBuild

Rincian tentang paket dapat ditemukan di sini

Saya menggunakan jawaban MarkGr dan mengembangkan solusi ini. Pertama, buat file batch yang disebut RunTemplate.bat di folder alat terpisah di atas folder solusi utama. File batch hanya memiliki garis:

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

File batch ini mengambil 2 parameter ... % 1 adalah path ke file .tt tanpa ekstensi .tt. % 2 adalah jalur ke setiap DLL yang dirujuk oleh arahan Majelis dalam templat.

Selanjutnya, masuk ke Properti Proyek dari proyek yang berisi template T4. Pergilah ke Bangun Acara dan tambahkan baris perintah acara Bangun sebelumnya :

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

mengganti MyTemplate dengan nama file file .tt Anda (yaitu MyTemplate.tt) tanpa ekstensi .tt. Ini akan memiliki hasil memperluas templat untuk menghasilkan MyTemplate.cs sebelum membangun proyek. Kemudian build aktual akan mengkompilasi MyTemplate.cs

Baru-baru ini menemukan plugin VS yang hebat ini, Chirpy .

Tidak hanya menghasilkan T4 pada build, tetapi juga memungkinkan pendekatan berbasis T4 untuk meminimalkan javascript, CSS, dan bahkan memungkinkan Anda menggunakan sintaks KURANG untuk CSS Anda!

Mungkin cara paling sederhana adalah menginstal ekstensi Visual Studio yang disebut AutoT4 .

Ini menjalankan semua templat T4 pada pembuatan secara otomatis.

Pra-bangun dapat direduksi menjadi satu baris:

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

Ini mengubah semua .ttfile dalam proyek dan mencantumkannya ke output build.

Jika Anda tidak ingin output build maka Anda harus mengatasi beberapa "perilaku menarik" :

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

Tentu saja, Anda bisa menarik ini ke dalam file batch yang Anda lewati jalur direktori proyek jika Anda mau.

NB Path mungkin memerlukan beberapa penyesuaian. Jalur di atas adalah tempat VS 2008 menginstalnya di mesin saya; tetapi Anda mungkin menemukan bahwa nomor versi antara TextTemplatingdan TextTransform.exeberbeda.

Lihat C: \ Program Files (x86) \ Common Files \ Microsoft Shared \ TextTemplating ada exe transformasi baris perintah di sana. Atau menulis tugas MSBuild dengan host kustom dan melakukan transformasi sendiri.

Memperluas jawaban Seth Reno dan JoelFan , saya datang dengan ini. Dengan solusi ini tidak perlu mengingat untuk memodifikasi acara pra-bangun setiap kali Anda menambahkan file .tt baru ke proyek.

Prosedur Implementasi

• Buat file batch bernama transform_all.bat (lihat di bawah)
• Buat acara pra-bangun transform_all.bat "$(ProjectDir)" $(ProjectExt)untuk setiap proyek dengan .tt yang ingin Anda buat

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

CATATAN

1. Transformasi teks mengasumsikan kode dalam templat T4 adalah bahasa yang sama dengan jenis proyek Anda. Jika kasus ini tidak berlaku untuk Anda, maka Anda harus mengganti $(ProjectExt)argumen dengan ekstensi file yang Anda inginkan untuk dihasilkan oleh kode.

2. .TTfile harus ada di direktori proyek agar tidak dapat dibangun. Anda dapat membuat file TT di luar direktori proyek dengan menentukan jalur yang berbeda sebagai argumen pertama ( mis. Ganti "$(ProjectDir)"dengan jalur yang berisi file TT.)

3. Ingat juga untuk mengatur jalur yang benar ke transform_all.batfile batch.
   Sebagai contoh, saya menempatkannya di direktori solusi saya sehingga acara pra-bangun adalah sebagai berikut"$(SolutionDir)transform_all.bat" "$(ProjectDir)" $(ProjectExt)

Jika Anda menggunakan Visual Studio 2010, Anda dapat menggunakan Visual Studio Modeling dan Visualisasi SDK: http://code.msdn.microsoft.com/vsvmsdk

Ini berisi tugas-tugas msbuild untuk mengeksekusi templat T4 pada waktu build.

Lihat blog Oleg untuk penjelasan lebih lanjut: http://www.olegsych.com/2010/04/understanding-t4-msbuild-integration

Hai, skrip saya juga dapat mem-parsing ekstensi keluaran

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%

Buat saja transform_all.bat $(SolutionDir)acara pra-bangun, dan semua file * .tt dalam solusi Anda akan diubah secara otomatis.

Dynamo.AutoTT akan melakukan apa yang Anda butuhkan. Anda dapat mengonfigurasinya untuk menonton file melalui regex atau menghasilkan saat dibangun. Anda juga dapat menentukan templat T4 mana yang ingin Anda picu.

Anda dapat mengunduhnya dari sini: https://github.com/MartinF/Dynamo.AutoTT

Cukup buat, salin dll dan file AddIn ke

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

dan pergilah.

Jika Anda ingin menjalankannya dalam VS2012 Anda harus memodifikasi file Dynamo.AutoTT.AddIn dan mengatur Versi ke 11.0 di dalam file AddIn;

Terima kasih kepada GitHub.com/Mono/T4 , saat ini Anda dapat melakukannya untuk membangun .NET Core dan Visual Studio dengan menambahkan ini ke .csprojfile Anda :

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

Jika Anda mengubah template Anda ke bahasa pemrograman yang berbeda Anda harus menambahkan sesuatu seperti <Compile Remove="**\*.vb" />dan <Compile Include="**\*.vb" />untuk mendapatkan file-file ini dikompilasi bahkan jika Anda belum membuat file.

Removedan Includetrik hanya diperlukan untuk generasi pertama kali, atau Anda dapat membuat XML lebih pendek seperti ini:

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

dan jalankan build dua kali (untuk pertama kali). Jika Anda telah membuat file yang dikomit ke repositori, tidak akan ada masalah pada pembangunan kembali dengan kedua contoh.

Di Visual Studio Anda mungkin ingin melihat sesuatu seperti ini:

alih-alih ini:

Jadi tambahkan sesuatu seperti ini ke file proyek Anda:

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

Contoh lengkap di sini: GitHub.com/Konard/T4GenericsExample (termasuk pembuatan beberapa file dari templat tunggal).

Inilah solusi saya - mirip dengan jawaban yang diterima. Kami memiliki masalah dengan kontrol sumber kami. File .cs target hanya baca dan T4 gagal. Berikut adalah kode, yang menjalankan T4 di folder temp, membandingkan file target, dan menyalinnya hanya jika terjadi perubahan yang sama. Itu tidak memperbaiki masalah dengan file read.only, tapi setidaknya itu tidak terlalu sering terjadi:

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

Anda dapat mencoba menambahkan perintah check-out Anda pada sebuah baris (:: Anda dapat mencoba ....)

Di proyek Anda tetapkan ini sebagai tindakan prebuild:

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

Anda hanya perlu menambahkan perintah ini ke acara pra-bangun proyek:

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

Pemeriksaan konfigurasi = debug, pastikan Anda tidak membuat ulang kode dalam mode rilis, ketika Anda melakukan build di server build TFS misalnya.

Di visual studio 2013, klik kanan template T4 dan atur transformasi pada properti build menjadi true.

Inilah cara saya menempelkannya. Link . Pada dasarnya membangun di atas blog yang hebat (blogs.clariusconsulting.net/kzu/how-to-transform-t4-templates-on-build-without-installing-a-visual-studio-sdk/ tidak dapat memposting lebih dari itu 2 links :() Saya datang dengan file .targets ini untuk digunakan dengan file proj studio visual.

Ini berguna ketika Anda menggunakan dll-s lain di dalam .tt Anda dan Anda ingin hasilnya berubah karena dll-s sedang berubah.

Bagaimana itu bekerja:

1. Buat tt, tambahkan jalur nama perakitan = "$ (SolutionDir) \ ke \ other \ project \ output \ foo.dll dan atur transformasi dan hasilnya seperti yang diharapkan

2. Hapus referensi perakitan dari .tt

3. Di dalam file proj, gunakan kode ini untuk mengatur transformasi saat dibangun:

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

   • Bagian pertama Menempatkan TextTransform.exe

   • $(IncludeForTransform)akan sama dengan c:\path\to\dll\foo.dll' -r c:\path\to\dll\bar.dllkarena itulah cara untuk menambahkan referensi untuk TextTransform pada baris perintah

      <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" />ini membuat daftar semua file tt di dalam proyek dan subdirektori

   • <Exec Command="... menghasilkan baris untuk setiap file .tt yang ditemukan yang terlihat seperti "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. Satu-satunya yang tersisa untuk dilakukan adalah menambahkan path ke dlls di dalam:

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

   Di sini <InProject>False</InProject>menyembunyikan item-item ini dari Tampilan Solusi

Jadi sekarang Anda harus dapat menghasilkan kode Anda pada build dan perubahan dll-s.

Anda dapat menghapus alat kustom (dari properti di dalam Visual Studio) sehingga VS tidak mencoba untuk mengubah dan gagal total setiap saat. Karena kami menghapus referensi perakitan pada langkah 2

T4Executer melakukan ini untuk VS2019. Anda bisa menentukan templat untuk diabaikan saat dibangun, dan ada opsi eksekusi setelah pembuatan.

Anda cukup menginstal Paket NuGet : Clarius.TransformOnBuild

Kemudian, setiap kali Anda mengklik proyek Rebuild (atau Solusi), file .tt Anda akan berjalan

Di Visual Studio 2017 (mungkin versi berikutnya juga), Anda harus menambahkan ini di acara Pra-bangun:

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

ps Ubah path ke template Anda jika lokasinya tidak di direktori proyek root.

Beberapa orang membangun paket nuget untuk ini.

Catatan: Saya mendapatkan kesalahan kompilasi dari TextTemplate.exe dan paket itu (karena paket itu memanggil TextTemplate.exe) tetapi tidak dari Visual Studio. Jadi ternyata perilakunya tidak sama; kepala.

EDIT: Ini akhirnya menjadi masalah saya.

Inilah acara pra-bangun yang hanya menggunakan Microsoft Tooling dan jalur standar. Ini diuji di vs2019 / netcore3.1.

Ganti "AppDbContext.tt" dengan jalur file relatif proyek Anda:

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

Microsoft juga memiliki panduan untuk membuat makro seperti "$ (SolutionDirectory)" tersedia di templat dengan menggunakan T4ParameterValues dalam file proyek Anda.