SourceGeneratorTestHelpers 8.1.0

dotnet add package SourceGeneratorTestHelpers --version 8.1.0                
NuGet\Install-Package SourceGeneratorTestHelpers -Version 8.1.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="SourceGeneratorTestHelpers" Version="8.1.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add SourceGeneratorTestHelpers --version 8.1.0                
#r "nuget: SourceGeneratorTestHelpers, 8.1.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install SourceGeneratorTestHelpers as a Cake Addin
#addin nuget:?package=SourceGeneratorTestHelpers&version=8.1.0

// Install SourceGeneratorTestHelpers as a Cake Tool
#tool nuget:?package=SourceGeneratorTestHelpers&version=8.1.0                

Source Generator Test Helpers

Test helpers and extension methods to simplify testing of .NET source generators.

main nuget downloads

Testing a source generator

var result = SourceGenerator.Run<YourSourceGenerator>("your source");

Testing an incremental source generator

var result = IncrementalGenerator.Run<YourSourceGenerator>("your source");

Obtaining the generated source

Getting all generated sources

var generatedSources =  result.GetSources();

A single source that ends with a specific file path

var generatedSource =  result.GetSource("TestId.g.cs");

Compare the generated source with the expected source

You can produce a diff between the generated source and the expected source. The result will contain a boolean hasDifferences and a line by line diff in differences.

var (hasDifferences, differences) = Diff.Compare(generatedSource, expectedSource);

Assert the difference

Using one of the testing framework packages below, you can also assert the difference between the generated source and the expected source.

XUnit NUnit MSTest

var result = IncrementalGenerator.Run<YourSourceGenerator>("your source");

result.ShouldProduce("TestId.g.cs", "expected source");

Note: If you do not wish to assert on errors produced during diagnostics of the source generator run, you can simply disable them as such.

var result = IncrementalGenerator.Run<YourSourceGenerator>("your source");

result.ShouldProduce("TestId.g.cs", "expected source", false);

Verify the difference

Support for Verify is built-in using the VerifyAsync method.

XUnit
public class SourceGeneratorTests
{
    [Fact]
    public Task ShouldProductTestId()
    {
        var result = IncrementalGenerator.Run<YourSourceGenerator>("your source");
        return result.VerifyAsync("TestId.g.cs");
    }
}
NUnit
[TestFixture]
public class SourceGeneratorTests
{
    [Test]
    public Task ShouldProductTestId()
    {
        var result = IncrementalGenerator.Run<YourSourceGenerator>("your source");
        return result.VerifyAsync("TestId.g.cs");
    }
}
MSTest
[TestClass]
public class SourceGeneratorTests :
    GeneratorDriverTestBase
{
    [TestMethod]
    public Task ShouldProductTestId()
    {
        var result = IncrementalGenerator.Run<YourSourceGenerator>("your source");
        return VerifyAsync("TestId.g.cs");
    }
}
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on SourceGeneratorTestHelpers:

Package Downloads
SourceGeneratorTestHelpers.XUnit

Test helpers and extension methods to simplify testing of .NET source generators.

SourceGeneratorTestHelpers.MSTest

Test helpers and extension methods to simplify testing of .NET source generators.

SourceGeneratorTestHelpers.NUnit

Test helpers and extension methods to simplify testing of .NET source generators.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
8.1.0 836 3/26/2024
8.0.14 226 3/26/2024
8.0.13 218 3/26/2024
8.0.12 240 3/25/2024
8.0.11 231 3/25/2024
8.0.10 234 3/25/2024
8.0.9 223 3/25/2024
8.0.8 268 3/18/2024
8.0.7 246 3/5/2024
8.0.6 290 2/23/2024
8.0.5 232 2/23/2024
8.0.4 134 2/23/2024
8.0.3 120 2/23/2024
8.0.2 122 2/22/2024
8.0.1 120 2/21/2024
8.0.0 127 2/21/2024