❔ Can't get the source generators tutorial to work

nalka · 2023-10-04T14:29:31.168Z

As the title says, I'm following the source generators tutorial that's here : https://learn.microsoft.com/en-us/dotnet/csharp/roslyn-sdk/source-generators-overview But when I launch my console app (.net 7) nothing is displayed, I'm most likely stuck with step 7 (linking the source generator with my console app) but at this point I really don't see what could be wrong given I have no errors nor warnings... Like displayed on step 9, I have SourceGenerator in my console app's analyzers but there's nothing below it (so no SourceGenerator.HelloSourceGenerator and Program.cs that appear on the tutorial's screenshot)

T

Thinker•10/4/23, 2:30 PM

Can you show your generator code and csproj(s)?

T

Thinker•10/4/23, 2:30 PM

Also that tutorial is severely outdated,

ISourceGenerator

ISourceGenerator

ISourceGenerator

ISourceGenerator is depricated

N

nalkaOP•10/4/23, 2:31 PM

By depreciated, do you mean it is marked with ObsoleteAttribute?

N

nalkaOP•10/4/23, 2:32 PM

My generator's code is just a copy paste of the tutorial's generator, about the csproj gimme a minute

T

Thinker•10/4/23, 2:32 PM

It's not but you should pretend it is.

T

Thinker•10/4/23, 2:34 PM

context.Compilation.GetEntryPoint(context.CancellationToken)
context.Compilation.GetEntryPoint(context.CancellationToken)
context.Compilation.GetEntryPoint(context.CancellationToken)
context.Compilation.GetEntryPoint(context.CancellationToken)

This isn't something you should be writing in real source generators.

T

Thinker•10/4/23, 2:34 PM

Unfortunately there's a real lack of proper documentation around source generators, although the thing you should be using is

IIncrementalGenerator

IIncrementalGenerator

IIncrementalGenerator

IIncrementalGenerator.

T

Thinker•10/4/23, 2:35 PM

Difference is essentially that

ISourceGenerator

ISourceGenerator

ISourceGenerator

ISourceGenerator will try to regenerate the code for each keystroke and/or change in the code, while with

IIncrementalGenerator

IIncrementalGenerator

IIncrementalGenerator

IIncrementalGenerator you build up an incremental pipeline so the compiler can efficiently cache relevant data and only regenerate the code when something relevant has changed.

N

nalkaOP•10/4/23, 2:36 PM

IIncrementalGenerator only has Initialize?

T

Thinker•10/4/23, 2:36 PM

yep

T

Thinker•10/4/23, 2:37 PM

And using the context it gives you, you register several actions, eventually ending with

RegisterSourceOutput

RegisterSourceOutput

RegisterSourceOutput

RegisterSourceOutput

T

Thinker•10/4/23, 2:37 PM

$ig

TThinker $ig

M

MODiX•10/4/23, 2:37 PM

https://github.com/dotnet/roslyn/blob/main/docs/features/incremental-generators.md

N

nalkaOP•10/4/23, 2:37 PM

Alright so the tutorial is definitely 100% irrelevant at least for the source generator's code

T

Thinker•10/4/23, 2:37 PM

yeahhh

T

Thinker•10/4/23, 2:37 PM

Although I don't know why it isn't working for you, iirc the csproj setup the tutorial demonstrates should be fine.

N

nalkaOP•10/4/23, 2:38 PM

Well I'll try using the "normal" way first, hopefuly it works better this way

T

Thinker•10/4/23, 2:39 PM

Also feel free to come by #roslyn and ask any other questions about SGs, it's a great resource

N

nalkaOP•10/5/23, 7:40 AM

Generators csproj looks like that :

<Project Sdk="Microsoft.NET.Sdk">
    <PropertyGroup>
        <TargetFramework>netstandard2.0</TargetFramework>
        <EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
    </PropertyGroup>
    <ItemGroup>
        <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.7.0" PrivateAssets="all"/>
        <PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.4" PrivateAssets="all" />
    </ItemGroup>
</Project>

<Project Sdk="Microsoft.NET.Sdk">
    <PropertyGroup>
        <TargetFramework>netstandard2.0</TargetFramework>
        <EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
    </PropertyGroup>
    <ItemGroup>
        <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.7.0" PrivateAssets="all"/>
        <PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.4" PrivateAssets="all" />
    </ItemGroup>
</Project>

<Project Sdk="Microsoft.NET.Sdk">
    <PropertyGroup>
        <TargetFramework>netstandard2.0</TargetFramework>
        <EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
    </PropertyGroup>
    <ItemGroup>
        <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.7.0" PrivateAssets="all"/>
        <PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.4" PrivateAssets="all" />
    </ItemGroup>
</Project>

<Project Sdk="Microsoft.NET.Sdk">
    <PropertyGroup>
        <TargetFramework>netstandard2.0</TargetFramework>
        <EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
    </PropertyGroup>
    <ItemGroup>
        <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.7.0" PrivateAssets="all"/>
        <PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.4" PrivateAssets="all" />
    </ItemGroup>
</Project>

And the console app csproj looks like that

<Project Sdk="Microsoft.NET.Sdk">
    <PropertyGroup>
        <OutputType>Exe</OutputType>
        <TargetFramework>net6.0</TargetFramework>
        <ImplicitUsings>enable</ImplicitUsings>
        <Nullable>disable</Nullable>
        <Platforms>AnyCPU;x86</Platforms>
    </PropertyGroup>
    <ItemGroup>
        <ProjectReference Include="..\SourceGenerators\SourceGenerators.csproj" ReferenceOutputAssembly="false" />
    </ItemGroup>
</Project>

<Project Sdk="Microsoft.NET.Sdk">
    <PropertyGroup>
        <OutputType>Exe</OutputType>
        <TargetFramework>net6.0</TargetFramework>
        <ImplicitUsings>enable</ImplicitUsings>
        <Nullable>disable</Nullable>
        <Platforms>AnyCPU;x86</Platforms>
    </PropertyGroup>
    <ItemGroup>
        <ProjectReference Include="..\SourceGenerators\SourceGenerators.csproj" ReferenceOutputAssembly="false" />
    </ItemGroup>
</Project>

<Project Sdk="Microsoft.NET.Sdk">
    <PropertyGroup>
        <OutputType>Exe</OutputType>
        <TargetFramework>net6.0</TargetFramework>
        <ImplicitUsings>enable</ImplicitUsings>
        <Nullable>disable</Nullable>
        <Platforms>AnyCPU;x86</Platforms>
    </PropertyGroup>
    <ItemGroup>
        <ProjectReference Include="..\SourceGenerators\SourceGenerators.csproj" ReferenceOutputAssembly="false" />
    </ItemGroup>
</Project>

<Project Sdk="Microsoft.NET.Sdk">
    <PropertyGroup>
        <OutputType>Exe</OutputType>
        <TargetFramework>net6.0</TargetFramework>
        <ImplicitUsings>enable</ImplicitUsings>
        <Nullable>disable</Nullable>
        <Platforms>AnyCPU;x86</Platforms>
    </PropertyGroup>
    <ItemGroup>
        <ProjectReference Include="..\SourceGenerators\SourceGenerators.csproj" ReferenceOutputAssembly="false" />
    </ItemGroup>
</Project>

N

nalkaOP•10/5/23, 7:43 AM

And after switching to the IIncrementalGenerator way, i still have the same issue (now my source generators project appears referenced as a project reference in my console app's dependencies)

A

Accord•10/6/23, 7:52 AM

Was this issue resolved? If so, run

/close

/close

otherwise I will mark this as stale and this post will be archived until there is new activity.

❔ Can't get the source generators tutorial to work

Similar Threads

Similar Threads

Similar Threads