[release/5.0] Support Source Generators in WPF projects #3846

ryalanms · 2020-11-23T23:24:11Z

[release/5.0] Support Source Generators in WPF projects

This feature requires applications to opt-in by explicitly setting a property in their project file. Otherwise, the existing GenerateTemporaryTargetAssembly code is executed.

This PR brings the changes from master to release/5.0:

https://github.com/dotnet/roslyn/blob/master/docs/features/source-generators.md

Original PR:

#3585

Include generated NuGet props and targets from outer WPF parent project in generated temp project

Add condition and cleanup generated NuGet props and targets after compilation of temp project

Move BuildEngine global properties to project properties

The source generator samples now work in WPF applications:

https://github.com/dotnet/roslyn-sdk/tree/master/samples/CSharp/SourceGenerators

A single property turns on the new PackageReference support (IncludePackageReferencesDuringMarkupCompilation = true) and enables the new behavior. By default, the unmodified GenerateTemporaryTargetAssembly code is called, the old path.

There was an incomplete change previously committed and reverted. The new change includes:

Relative path fixes from previous commit: .NET Core WPF Build error on custom BaseIntermediateOutputPath #1718 #3120

Addition of ResolveProjectReferences target when IncludePackageReferencesDuringMarkupCompilation is not false

Replacement of BuildEngine global properties with project properties that caused build failures in referenced projects and various other scenarios (e.g. AssemblyName)

* Include generated NuGet props and targets from outer WPF parent project in generated temp project * Add condition and cleanup generated NuGet props and targets after compilation of temp project * Move BuildEngine global properties to project properties

src/Microsoft.DotNet.Wpf/src/PresentationBuildTasks/MS/Internal/MarkupCompiler/PathInternal.cs

src/Microsoft.DotNet.Wpf/src/PresentationBuildTasks/Microsoft.WinFX.targets

lindexi · 2020-11-24T01:15:04Z

Can this fix #811 ?

Looks like it can fix the source code nuget packages that package by SourceYard: https://github.com/dotnet-campus/SourceYard

Thank you

vatsan-madhavan

I seem to recall that this PR was merged, then reverted, and is now being brought back. If this recollection is correct, then perhaps an explanation about what went wrong, and how the problem has been remedied in this version (besides providing an opt-out) would be a helpful to incorporate in the description.

src/Microsoft.DotNet.Wpf/src/PresentationBuildTasks/Microsoft.WinFX.targets

…ncesDuringMarkupCompilation'

ryalanms · 2020-11-24T17:28:03Z

The description has been updated to include the differences between this and the previous PR. Thanks.

src/Microsoft.DotNet.Wpf/src/PresentationBuildTasks/Microsoft.WinFX.targets

src/Microsoft.DotNet.Wpf/src/PresentationBuildTasks/MS/Internal/MarkupCompiler/PathInternal.cs

vatsan-madhavan

The question about the glob-pattern looks interesting and should be resolved before merging - maybe it's nothing; and a few maintainability nits best taken care of now. otherwise looks good.

src/Microsoft.DotNet.Wpf/src/PresentationBuildTasks/Microsoft.WinFX.targets

...PresentationBuildTasks/Microsoft/Build/Tasks/Windows/CreateTemporaryTargetAssemblyProject.cs

src/Microsoft.DotNet.Wpf/src/PresentationBuildTasks/Microsoft.WinFX.targets

…WinFX.targets Co-authored-by: Rainer Sigwald <raines@microsoft.com>

Co-authored-by: Rainer Sigwald <raines@microsoft.com>

…kupCompilation. Rename GenerateTemporaryTargetAssembly task. Add comment on porting source for GetRelativePath implementation.

…d new temporary assembly compilation paths in to a single task

ryalanms · 2020-12-10T17:54:48Z

@rainersigwald: Thank you for reviewing. I believe all the design suggestions were accommodated here. Everything has been consolidated in to a single task and target.

…around, and make implicit SDK imports explicit.

…udePackageReferencesDuringMarkupCompilation.

ryalanms · 2020-12-11T23:19:29Z

This was approved by .NET Tactics today for 5.0.2. Thanks.

[release/5.0] Support source generators in WPF projects (#3846) [5.0.2 servicing]

ryalanms requested a review from a team as a code owner November 23, 2020 23:24

ghost added the PR metadata: Label to tag PRs, to facilitate with triage label Nov 23, 2020

ghost requested review from fabiant3 and SamBent November 23, 2020 23:24

fabiant3 reviewed Nov 23, 2020

View reviewed changes

src/Microsoft.DotNet.Wpf/src/PresentationBuildTasks/MS/Internal/MarkupCompiler/PathInternal.cs Outdated Show resolved Hide resolved

fabiant3 approved these changes Nov 24, 2020

View reviewed changes

lindexi reviewed Nov 24, 2020

View reviewed changes

src/Microsoft.DotNet.Wpf/src/PresentationBuildTasks/Microsoft.WinFX.targets Outdated Show resolved Hide resolved

SamBent approved these changes Nov 24, 2020

View reviewed changes

vatsan-madhavan reviewed Nov 24, 2020

View reviewed changes

src/Microsoft.DotNet.Wpf/src/PresentationBuildTasks/Microsoft.WinFX.targets Outdated Show resolved Hide resolved

Use a better name for PackageReference support: 'IncludePackageRefere…

0bfa982

…ncesDuringMarkupCompilation'

vatsan-madhavan reviewed Nov 24, 2020

View reviewed changes

src/Microsoft.DotNet.Wpf/src/PresentationBuildTasks/Microsoft.WinFX.targets Outdated Show resolved Hide resolved

ryalanms added the Servicing-consider label Nov 24, 2020

Narrow globbed props/targets to *.nuget.g.*

870f199

vatsan-madhavan reviewed Nov 24, 2020

View reviewed changes

src/Microsoft.DotNet.Wpf/src/PresentationBuildTasks/MS/Internal/MarkupCompiler/PathInternal.cs Outdated Show resolved Hide resolved

vatsan-madhavan reviewed Nov 24, 2020

View reviewed changes

ericstj requested review from dsplaisted and rainersigwald November 24, 2020 18:32

leecow added this to the 5.0.2 milestone Nov 24, 2020

YairHalberstadt mentioned this pull request Nov 25, 2020

Add wpf sample project YairHalberstadt/stronginject#82

Merged

rainersigwald reviewed Nov 25, 2020

View reviewed changes

leecow removed the Servicing-consider label Dec 3, 2020

ryalanms and others added 3 commits December 6, 2020 11:45

Update src/Microsoft.DotNet.Wpf/src/PresentationBuildTasks/Microsoft.…

bec19c8

…WinFX.targets Co-authored-by: Rainer Sigwald <raines@microsoft.com>

Apply rainersigwald's suggestions from code review

3e1aa9c

Co-authored-by: Rainer Sigwald <raines@microsoft.com>

PR feedback: Use negative tests for IncludePackageReferencesDuringMar…

563463d

…kupCompilation. Rename GenerateTemporaryTargetAssembly task. Add comment on porting source for GetRelativePath implementation.

ryalanms force-pushed the SourceGenerators branch from 42c75cf to 563463d Compare December 6, 2020 22:29

ryalanms added 2 commits December 8, 2020 00:13

Support PackageReferences in WPF projects (#3585): Consolidate old an…

bc1e643

…d new temporary assembly compilation paths in to a single task

Merge branch 'SourceGenerators2': Proposal for consolidated target/task

bde2905

ryalanms added the Servicing-consider label Dec 10, 2020

Clean up single task/target implementation, disable Arcade NuGet work…

ee91876

…around, and make implicit SDK imports explicit.

ryalanms force-pushed the SourceGenerators branch from d6f0eea to ee91876 Compare December 10, 2020 19:37

Make new behavior opt-in: require applications to explicitly set Incl…

c55043d

…udePackageReferencesDuringMarkupCompilation.

ryalanms force-pushed the SourceGenerators branch from ee90c5e to c55043d Compare December 11, 2020 01:40

Further narrow change for 5.0.2

a23664d

ryalanms force-pushed the SourceGenerators branch from ec3228e to a23664d Compare December 11, 2020 21:05

ryalanms removed the Servicing-consider label Dec 11, 2020

ryalanms merged commit 06e0d92 into release/5.0 Dec 11, 2020

ryalanms added a commit that referenced this pull request Dec 11, 2020

[release/5.0] Support Source Generators in WPF projects (#3846)

9ffd31f

[release/5.0] Support source generators in WPF projects (#3846) [5.0.2 servicing]

mmitche deleted the SourceGenerators branch December 30, 2020 17:03

ryalanms added a commit that referenced this pull request Jan 6, 2021

[release/5.0] Support Source Generators in WPF projects (#3846)

a3d4b81

[release/5.0] Support source generators in WPF projects (#3846) [5.0.2 servicing]

ryalanms mentioned this pull request Jan 6, 2021

Move remaining release/5.0 change to master: [release/5.0] Support source generators in WPF projects (#3846) [5.0.2 servicing] #3951

Merged

ryalanms added a commit that referenced this pull request Jan 6, 2021

[release/5.0] Support Source Generators in WPF projects (#3846) (#3951)

005950c

[release/5.0] Support source generators in WPF projects (#3846) [5.0.2 servicing]

This was referenced Jan 9, 2021

WPF project build breaks because Roslyn Source Generators do not run in WPF inner-build #3963

Closed

WPF source generator support should be on by default for .NET 6.0 #3974

Closed

Source Generator support for WPF project blocked? #3404

Closed

clairernovotny mentioned this pull request Jan 19, 2021

Enable Source Link, Generators, and custom props/targets to work with WPF in 5.x dotnet/sdk#15395

Closed

lindexi mentioned this pull request Mar 22, 2021

IncludePackageReferencesDuringMarkupCompilation causes excluded NuGet targets/props files to be executed #4311

Open

rainersigwald mentioned this pull request Oct 5, 2021

Overbuild caused by PackageReference support #5448

Closed

ghost locked as resolved and limited conversation to collaborators Apr 10, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[release/5.0] Support Source Generators in WPF projects #3846

[release/5.0] Support Source Generators in WPF projects #3846

ryalanms commented Nov 23, 2020 •

edited

Loading

lindexi commented Nov 24, 2020 •

edited

Loading

vatsan-madhavan left a comment

ryalanms commented Nov 24, 2020

vatsan-madhavan left a comment

ryalanms commented Dec 10, 2020

ryalanms commented Dec 11, 2020

[release/5.0] Support Source Generators in WPF projects #3846

[release/5.0] Support Source Generators in WPF projects #3846

Conversation

ryalanms commented Nov 23, 2020 • edited Loading