Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Use .NET source generators to generate strongly-typed overloads #2015

Merged
merged 13 commits into from
May 16, 2024
Merged

Use .NET source generators to generate strongly-typed overloads #2015

merged 13 commits into from
May 16, 2024

Conversation

blairconrad
Copy link
Member

Closes #1804.

@blairconrad blairconrad marked this pull request as draft April 21, 2024 12:18
@blairconrad
Copy link
Member Author

Hey, @thomaslevesque. For your consideration. Of course there are more classes to convert, but I thought I'd give you a peek before I invested more hours. I am content with the changes relative using T4, but am also open to leaving T4 in the mix and/or exploring a proper templating solution.
Tell me what you think!

thomaslevesque
thomaslevesque reviewed Apr 21, 2024
View reviewed changes
Copy link
Member

@thomaslevesque thomaslevesque left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks @blairconrad!

Two remarks:

  • I see you used the original source generator model, rather than the newer "incremental" generators. In this case, I think it doesn't matter, because you don't have any syntax receiver that would trigger a regeneration on every keystroke.
  • I don't see the generated code in your PR. By default it's generated in the obj folder, which is excluded from source control. If we want to include the generated code in source control, we can specify the path where it's emitted with CompilerGeneratedFilesOutputPath.

tools/FakeItEasy.SourceGenerators/StronglyTypedExtensionsGenerator.cs Outdated Show resolved Hide resolved
@blairconrad
Copy link
Member Author

blairconrad commented Apr 21, 2024 •
edited
Loading

I see you used the original source generator model, rather than the newer "incremental" generators. In this case, I think it doesn't matter, because you don't have any syntax receiver that would trigger a regeneration on every keystroke.

Ah! I can look at the incremental one. I just used the first guidance I found.

I don't see the generated code in your PR. By default it's generated in the obj folder, which is excluded from source control. If we want to include the generated code in source control, we can specify the path where it's emitted with CompilerGeneratedFilesOutputPath.

I will explore this!

@blairconrad
Copy link
Member Author

Sorry @thomaslevesque. I rebased. I even put some commits in before the originals.

blairconrad
blairconrad commented May 13, 2024
View reviewed changes
.globalconfig Outdated Show resolved Hide resolved
src/FakeItEasy.Extensions.ValueTask/FakeItEasy.Extensions.ValueTask.csproj Outdated Show resolved Hide resolved
src/FakeItEasy/FakeItEasy.csproj Outdated Show resolved Hide resolved
...nConfigurationExtensionsGenerator/ArgumentValidationConfigurationExtensions.StronglyTyped.cs Outdated Show resolved Hide resolved
...lueConfigurationExtensionsGenerator/AsyncReturnValueConfigurationExtensions.StronglyTyped.cs Outdated Show resolved Hide resolved
...en.CallbackConfigurationExtensionsGenerator/CallbackConfigurationExtensions.StronglyTyped.cs Outdated Show resolved Hide resolved
src/FakeItEasy/FakeItEasy.csproj Show resolved Hide resolved
tools/CodeGen/StronglyTypedOverloadsGenerator.cs Show resolved Hide resolved
thomaslevesque
thomaslevesque reviewed May 14, 2024
View reviewed changes
Copy link
Member

@thomaslevesque thomaslevesque left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @blairconrad! Looks good in general. I do have a few comments.
To be honest, after the first 2 "Use source generator" commits, I only gave the next ones a very cursory review, but I like the approach you took.

src/FakeItEasy/ArgumentValidationConfigurationExtensions.StronglyTyped.cs Outdated Show resolved Hide resolved
Directory.Build.props Outdated Show resolved Hide resolved
src/FakeItEasy/FakeItEasy.csproj Outdated Show resolved Hide resolved
src/FakeItEasy/FakeItEasy.csproj Outdated Show resolved Hide resolved
tools/CodeGen/ExceptionThrowerGenerator.cs Outdated Show resolved Hide resolved
tools/CodeGen/StronglyTypedOverloadsGenerator.cs Show resolved Hide resolved
src/FakeItEasy.Extensions.ValueTask/FakeItEasy.Extensions.ValueTask.csproj Outdated Show resolved Hide resolved
@blairconrad blairconrad marked this pull request as ready for review May 15, 2024 01:59
thomaslevesque
thomaslevesque previously approved these changes May 16, 2024
View reviewed changes
Copy link
Member

@thomaslevesque thomaslevesque left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @blairconrad, looks good to me! Just squash the fixups, and I'll merge

@blairconrad
Extract .globalconfig from section of .editorconfig
7fcd28e 
Generated source files don't pay attention to the .editorconfig file,
as described in [.editorconfig diagnostic suppressions don't apply to
source-generated files](dotnet/roslyn#47384),
but they do respect a .globalconfig file.
@blairconrad
Suppress SA0001 in .globalconfig
75e5db0 
If we add a new project in a surprise subdirectory, as we recently did
for recipes, and will soon add a source generator to tools, then we
won't have to manually suppress the warning.
@blairconrad
Use source generator to create ExceptionThrower.StronglyTyped.cs
32c4adb
@blairconrad
Use source generator to create OutAndRefParameters.StronglyTyped.cs
cbaa25f
@blairconrad
Use source generator to create ArgumentValidationConfigurationExtensi…
2bad368 
…ons.StronglyTyped.cs
@blairconrad
Use source generator to create AsyncReturnValueConfigurationExtension…
d4d7b96 
…s.StronglyTyped.cs
@blairconrad
Use source generator to create CallbackConfigurationExtensions.Strong…
5135360 
…lyTyped.cs
@blairconrad
Use source generator to create ReturnValueConfigurationExtensions.Str…
b6d30ef 
…onglyTyped.cs
@blairconrad
Generate strongly-typed overloads only when base type exists
7ac2841 
ValueTask-related overloads (coming soon) will not always apply
@blairconrad
Use source generator to create ValueTaskAsyncReturnValueConfiguration…
e1291db 
…Extensions.StronglyTyped.cs
@blairconrad
Use source generator to create ValueTaskReturnValueConfigurationExten…
4f93dd8 
…sions.StronglyTyped.cs
@blairconrad
Remove T4 support from FakeItEasy project
433d20e
@blairconrad
Use .g segment as generated file indicator
f1ecb3f
@blairconrad
Copy link
Member Author

blairconrad commented May 16, 2024 •
edited
Loading

@thomaslevesque, I squashed. While I was there I dropped c0e6a1c "Define constant LACKS_VALUETASK to exclude ValueTask-related functionality", as we discussed. With that removal, 445e88c "Use pre-.NET Standard 2.1 framework detection for FakeItEasy" didn't do anything for us, so I dropped that commit as well.

While I was at it, I distributed

472c236 "Use source generator to create strongly-typed overload for FakeItEasy.Extensions.ValueTask" amongst 3 other commits:

  • 7ac2841 "Generate strongly-typed overloads only when base type exists" (which is effectively a new (or shifted back in time) commit)
  • e1291db "Use source generator to create ValueTaskAsyncReturnValueConfigurationExtensions.StronglyTyped.cs" (pre-existing)
  • 4f93dd8 "Use source generator to create ValueTaskReturnValueConfigurationExtensions.StronglyTyped.cs" (pre-existing)

I think this clears stuff up. Thanks for the great suggestions. I had a ball working on this PR!

thomaslevesque
thomaslevesque approved these changes May 16, 2024
View reviewed changes
Copy link
Member

@thomaslevesque thomaslevesque left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, thanks!

@thomaslevesque thomaslevesque merged commit d78c11f into FakeItEasy:master May 16, 2024
4 checks passed
@blairconrad
Copy link
Member Author

Thank you, @thomaslevesque!

@blairconrad blairconrad deleted the 1804-source-generators branch May 16, 2024 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thomaslevesque thomaslevesque thomaslevesque approved these changes

Assignees
No one assigned
Labels
🏗️ build
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Consider using .NET 5.0 source generators to generate strongly-typed overloads
2 participants
@blairconrad @thomaslevesque