CptWesley / T4.SourceGenerator

Roslyn Source Generator for T4 templates.
MIT License
2 stars 0 forks source link

Buy Me a Coffee
License: MIT
NuGetNuGet

T4.SourceGenerator

T4.SourceGenerator

Modern Roslyn Source Generator for T4 templates, which transforms T4 templates during compilation using the mono T4 templating engine (Mono.TextTemplating). This means that C#11 features are available to be used in your T4 templates.

Installing

Through NuGet wizard

Look for the T4.SourceGenerator on NuGet and install the package.

With PowerShell

To install the package through PowerShell, use the following command:

Install-Package T4.SourceGenerator

Manual installation

To install the package manually, include the following snippet in your .csproj file:

<Project Sdk="Microsoft.NET.Sdk">

  <ItemGroup>
    <PackageReference Include="T4.SourceGenerator" Version="1.2.0" PrivateAssets="all" />
  </ItemGroup>

</Project>

Usage

After installing the package, add your T4 templates with .tt or .t4 extensions to your project. Adding your template files might add some items to your .csproj file that look like this (for Bar.tt):

<Project Sdk="Microsoft.NET.Sdk">

  <ItemGroup>
    <None Remove="templates\Bar.tt" />
  </ItemGroup>

  <ItemGroup>
    <AdditionalFiles Update="Templates\Bar.tt">
      <Generator>TextTemplatingFileGenerator</Generator>
    </AdditionalFiles>
  </ItemGroup>

  <ItemGroup>
    <Service Include="{508349b6-6b84-4df5-91f0-309beebad82d}" />
  </ItemGroup>

</Project>

These entries are used by the regular T4 template engine and are not necessary (and will most likely lead to conflicts) with the code generation provided by this package. Thus these lines should be removed.

Instead, your templates should be included in your .csproj as AdditionalFiles as such (for Bar.tt):

<Project Sdk="Microsoft.NET.Sdk">

  <ItemGroup>
    <AdditionalFiles Include="Bar.tt" />
  </ItemGroup>

</Project>

Licensing

The source code is fully MIT licensed.

Contribution

Any help is welcome. Feel free to open issues or feature requests or create a pull request.

Support Me

Want to support me in other ways? You can buy me a coffee! But don't feel obliged to!