C# Source Generators

A list of C# Source Generators (not necessarily awesome), because I haven't found a good list yet.

C# Source Generators is a Roslyn compiler feature introduced in C#9/.NET 5. It lets C# developers inspect user code and generate new C# source files that can be added to a compilation.

Add GitHub topic csharp-sourcegenerator to your generator repo - let's get it started!

Documentation and samples

• dotnet/roslyn feature design document describing the compiler feature.
• dotnet/roslyn cookbook to help with generator creation.
• dotnet/roslyn-sdk samples show how to implement a source generator and use features like external package references (inside generators).
• sourcegen.dev - an online Source Generator Playground to play with generator ideas 💡 without any setup noise. Source repo.
• davidwengier/SourceGeneratorTemplate - A basic template for writing a C# source generator, from the Roslyn dev.

Source Generators

• AutoInterface - interface-to-member source generator.
• avatar - A modern compile-time generated interception/proxy library.
• Cloneable - auto-generate Clone method.
• JsonSrcGen - - compile time JSON serializer generation.
• MemberAccessGenerator - generates GetMember(int) and/or GetMember(string) methods that return property value for a given property name or index (e.g. in positional records).
• net_automatic_interface - .Net Core Source Generator for Automatic Interfaces.
• PrimaryConstructor - Generate primary constructor from readonly fields.
• PrintMembersGenerator - helps re-defining C# record's PrintMembers method to force include/exclude certain members.
• SmallSharp - Create, edit and run multiple C# 9.0 top-level programs in the same project by just selecting the startup program from the start button.
• StringLiteralGenerator - for optimizing UTF-8 binaries.
• StrongInject - - compile time dependency injection for .NET.
• StructPacker - binary serializer that auto-generates C# serialization code to achieve peak runtime performance and efficiency.
• Svg to C# Source Generators - SVGC compiles SVG drawing markup to C# using SkiaSharp as rendering engine. SVGC can be also used as codegen for upcoming C# 9 Source Generator feature.
• ThisAssembly - Exposes project and assembly level information as constants in the ThisAssembly class.
• ValueObjectGenerator - C# source generator is for ValueObjects (ie.Wrapper classes).
• WrapperValueObject - - for creating simple value objects wrapping primitive types.

Tips & Tricks

Collection of tips and tricks (simple and brief to fit in Tweet):

Tweeted by @raboof on Nov 16 2020 at 20:57:

See files emitted by #SourceGenerators by adding these properties to your (*.csproj) project file:

<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
<CompilerGeneratedFilesOutputPath>$(BaseIntermediateOutputPath)Generated</CompilerGeneratedFilesOutputPath>

Tweeted by @Chiser99 on Sep 02 2020 at 06:41:

I made a thing: https://github.com/chsienki/Kittitas

If you're building Roslyn Source Generators or Analyzers check it out, it makes debugging them inside the compiler easier. #roslyn #csharp #dotnetcore #sourcegenerators #analyzers

Articles

• Source Generators in .NET 5 with ReSharper (2020-11-20) introduces source generators and briefly mentions how they are being worked into the ReSharper product
• Source Generators - real world example (2020-11-09) contains a rich and deep dive into a real world generator with lots of useful tips.
• How to Debug C# 9 Source Code Generators (2020-10-09)
• .NET Blog 'New C# Source Generator Samples' post (2020-08-25) that shows some simple samples.
• .NET Blog 'Introducing C# Source Generators' post (2020-04-29) that announces the feature.

Videos

• .NET Languages and Runtime Community Standup - Source Generators (2020-10-08) shows how Generators work and how they can be tested.
• Channel 9 'Source Generators in C#' (2020-08-12) has Roslyn PMs discussing the feature.

Demo, PoC and excercise projects

Maybe they can inspire you too!

• RyanAlameddine/SourceGeneratorDemo - contains 3 demos: hello world, INPC and OpCode class.
• TMC-CSharp/CodeExerciseLibrary - Library to help creating C# exercises. Generates missing methods and classes inside tests on the fly by using Source Generators.
• DpdtInject - DI container based on C# Source Generators. Its goal is to remove everything possible from runtime and make resolving process as faster as we can. This is achieved by transferring huge piece of resolving logic to the compilation stage into the source generator.
• jakubsturc/talk-csharp-source-generators - contains 4 generators: AutoNotify, ConsoleWritelineHijack, HelloWorld and SettingsXml, plus nice presentation slides.
• Compile Time Method Execution Generator - proof of concept that allows executing a method during compilation, so that it can be really fast during runtime.

Projects using custom Source Generators "internally"

• NetFabric.Hyperlinq - generates overloads for its extension methods.
• RestEase - uses Source Generator to generate interface implementations on compile time instead of in runtime via Reflection.Emit.
• WarHub/wham - generates code for immutable tree object graph based on red-green node approach used in Roslyn; generates custom XmlSerializer that supports C#9 records and ImmutableArray.