Table of Contents

Installation

To properly set up a NuGet package within a source generator assembly, regardless of which registry it came from, some modifications are required in the target .csproj file. These modifications are necessary because dependencies cannot be added seamlessly to .NET Standard 2.0 source generators as described in dotnet/roslyn#47517. Follow these steps:

  1. After adding the package via dotnet add or your IDE's NuGet Package Manager, set the GeneratePathProperty to true and embed all the PrivateAssets in the target PackageReference xml property : 
    <PackageReference Include="SourceGeneratorUtils" Version="1.3.0" GeneratePathProperty="true" PrivateAssets="all" />
  2. Include two additional sections in the .csproj file: 
    <PropertyGroup>
    <GetTargetPathDependsOn>$(GetTargetPathDependsOn);GetDependencyTargetPaths</GetTargetPathDependsOn>
</PropertyGroup>
<Target Name="GetDependencyTargetPaths">
    <ItemGroup>
        <TargetPathWithTargetPlatformMoniker Include="$(PKGSourceGeneratorUtils)\lib\netstandard2.0\SourceGeneratorUtils.dll" IncludeRuntimeDependency="false" />
    </ItemGroup>
</Target>

By following these steps, you can properly set up any NuGet package within a source generator assembly, regardless of its registry (given that you replace the assembly name and version with your own). These modifications ensure that the package's dependencies are handled correctly within the source generator.

Alternatively, you could also use the source generator version that'll emit the library as well as all the polyfills required to use it directly into your source generator project.

NuGet Releases NuGet Badge NuGet Badge

Two packages can be found on nuget.org:

> dotnet add package SourceGeneratorUtils

> dotnet add package SourceGeneratorUtils.SourceGeneration

CI Builds CI status

For those who want to utilize builds from this repository's main branch, install them from the NuGet Github Package Registry using this repo's package feed. You'll need your own Github Personal Access Token (PAT) in order to access the registry. For information on obtaining your PAT, see the Working with the NuGet registry article.

  1. At the command line, navigate to your user profile directory and run the following command to add the package feed to your NuGet configuration, replacing the <GITHUB_USER_NAME> and <PERSONAL_ACCESS_TOKEN> placeholders with the relevant values: 
    > dotnet nuget add source -n GitHub -u <GITHUB_USER_NAME> -p <PERSONAL_ACCESS_TOKEN> https://nuget.pkg.github.com/thenameless314159/index.json
  2. You should now be able to add a reference to the package specifying a version from the repository packages feed
Edit this page