C# source generators are a really pretty amazing and under-appreciated platform tooling on .NET. I suppose with the shift towards AOT, folks should get familiar with it.
I found the DX with it to be quite tricky (at least in Visual Studio Code) as it was difficult to log or trace through the code what was happening and what was going wrong. Microsoft's documentation is also quite lacking.
Do you have any write up or tips on the DX? It's a pretty impressive project and I'm really interested in how to improve my own workflow with respect to source generators since my experience has been that they are clumsy to work with.
Thanks. Personally, I found that most efficient way to develop source generators was by utilizing in memory compilation in unit tests. That way, I was able to use debugger to understand AST provided by Roslyn and quickly iterate. Not sure how it works within VSCode but in Rider it was really fine. Also, sometimes Visual Studio and Rider doesn't regenerate code (likely because internally msbuild decides that dlls are up-to-date). Unit test + in memory compilation way described above assured that latest code was really used in test.
`QueryGeneratorTestUtil.GenerateCompileAndAssert` internally uses
`Microsoft.CodeAnalysis.CSharp.CSharpCompilation.Create()` and `Microsoft.CodeAnalysis.MSBuild.MSBuildWorkspace.Create()`. I get an interactive, debuggable source generator development environment this way.
Same as you, initially I used "comments as debugging" hacks but above way is way more efficient.
I found the DX with it to be quite tricky (at least in Visual Studio Code) as it was difficult to log or trace through the code what was happening and what was going wrong. Microsoft's documentation is also quite lacking.
Do you have any write up or tips on the DX? It's a pretty impressive project and I'm really interested in how to improve my own workflow with respect to source generators since my experience has been that they are clumsy to work with.