Skip to content

Commit af55190

Browse files
Sergio0694Sergio0694
committed
Refactor bundled .targets
1 parent 2fe303e commit af55190

File tree

4 files changed

+195
-148
lines changed

4 files changed

+195
-148
lines changed

‎src/CommunityToolkit.Mvvm/CommunityToolkit.Mvvm.FeatureSwitches.targets

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<Project>
2+
3+
</Project>

‎src/CommunityToolkit.Mvvm/CommunityToolkit.Mvvm.SourceGenerators.targets

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
<Project>
2+
3+
<!-- Get the analyzer from the CommunityToolkit.Mvvm NuGet package -->
4+
<Target Name="MVVMToolkitGatherAnalyzers">
5+
<ItemGroup>
6+
<MVVMToolkitAnalyzer Include="@(Analyzer)" Condition="'%(Analyzer.NuGetPackageId)' == 'CommunityToolkit.Mvvm'" />
7+
</ItemGroup>
8+
</Target>
9+
10+
<!-- Remove the analyzer if Roslyn is missing -->
11+
<Target Name="MVVMToolkitRemoveAnalyzersForRosynNotFound"
12+
Condition="'$(CSharpCoreTargetsPath)' == ''"
13+
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
14+
DependsOnTargets="MVVMToolkitGatherAnalyzers">
15+
16+
<!-- If no Roslyn assembly could be found, just remove the analyzer without emitting a warning -->
17+
<ItemGroup>
18+
<Analyzer Remove="@(MVVMToolkitAnalyzer)"/>
19+
</ItemGroup>
20+
</Target>
21+
22+
<!-- Remove the analyzer if using Roslyn 3.x (incremental generators require Roslyn 4.x) -->
23+
<Target Name="MVVMToolkitRemoveAnalyzersForRoslyn3"
24+
Condition="'$(CSharpCoreTargetsPath)' != ''"
25+
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
26+
DependsOnTargets="MVVMToolkitGatherAnalyzers">
27+
28+
<!--
29+
Use the CSharpCoreTargetsPath property to find the version of the compiler we are using. This is the same mechanism
30+
MSBuild uses to find the compiler. We could check the assembly version for any compiler assembly (since they all have
31+
the same version) but Microsoft.Build.Tasks.CodeAnalysis.dll is where MSBuild loads the compiler tasks from so if
32+
someone is getting creative with msbuild tasks/targets this is the "most correct" assembly to check.
33+
-->
34+
<GetAssemblyIdentity AssemblyFiles="$([System.IO.Path]::Combine(`$([System.IO.Path]::GetDirectoryName($(CSharpCoreTargetsPath)))`,`Microsoft.Build.Tasks.CodeAnalysis.dll`))">
35+
<Output TaskParameter="Assemblies" ItemName="MVVMToolkitCurrentCompilerAssemblyIdentity"/>
36+
</GetAssemblyIdentity>
37+
38+
<PropertyGroup>
39+
40+
<!-- Transform the resulting item from GetAssemblyIdentity into a property representing its assembly version -->
41+
<MVVMToolkitCurrentCompilerVersion>@(MVVMToolkitCurrentCompilerAssemblyIdentity->'%(Version)')</MVVMToolkitCurrentCompilerVersion>
42+
43+
<!-- The CurrentCompilerVersionIsNotNewEnough property can now be defined based on the Roslyn assembly version -->
44+
<MVVMToolkitCurrentCompilerVersionIsNotNewEnough Condition="$([MSBuild]::VersionLessThan($(MVVMToolkitCurrentCompilerVersion), 4.0))">true</MVVMToolkitCurrentCompilerVersionIsNotNewEnough>
45+
</PropertyGroup>
46+
47+
<!-- If the Roslyn version is < 4.0, disable the source generators -->
48+
<ItemGroup Condition ="'$(MVVMToolkitCurrentCompilerVersionIsNotNewEnough)' == 'true'">
49+
<Analyzer Remove="@(MVVMToolkitAnalyzer)"/>
50+
</ItemGroup>
51+
52+
<!--
53+
If the source generators are disabled, also emit a warning. This would've been produced by MSBuild itself as well, but
54+
emitting this manually lets us customize the message to inform developers as to why exactly the generators have been
55+
disabled, and that the rest of the MVVM Toolkit will still keep working as intended, just without additional features.
56+
-->
57+
<Warning Condition ="'$(MVVMToolkitCurrentCompilerVersionIsNotNewEnough)' == 'true'"
58+
Code="MVVMTKCFG0001"
59+
HelpLink="https://aka.ms/mvvmtoolkit/errors/mvvmtkcfg0001"
60+
Text="The MVVM Toolkit source generators have been disabled on the current configuration, as they need Roslyn 4.x in order to work. The MVVM Toolkit will work just fine, but features relying on the source generators will not be available."/>
61+
62+
<PropertyGroup>
63+
64+
<!--
65+
Setup the checks for the MVVMToolkitRemoveDuplicateAnalyzersWhenRoslynComponentVersioningIsNotSupported target below.
66+
These are done here so that the following target can run only if it's sure this one has run, which is a necessary
67+
condition to ensure all dependent MSBuild properties defined here will also be available there whenever needed.
68+
-->
69+
<MVVMToolkitIsManualRoslynMultiTargetingLogicNeeded Condition="'$(MVVMToolkitCurrentCompilerVersionIsNotNewEnough)' != 'true' AND '$(SupportsRoslynComponentVersioning)' != 'true'">true</MVVMToolkitIsManualRoslynMultiTargetingLogicNeeded>
70+
</PropertyGroup>
71+
</Target>
72+
73+
<!--
74+
Manually remove duplicate analyzers if Roslyn component versioning is not supported (ie. if a legacy .csproj project is used).
75+
This target is only run if Roslyn 4.0 or greater is present, as otherwise all analyzers would have already been removed anyway.
76+
Additionally, skip this target if MVVMToolkitRemoveAnalyzersForRoslyn3 has been skipped (ie. if $(CSharpCoreTargetsPath) is not
77+
defined, which will be the case on VB.NET projects). In these cases, MVVMToolkitRemoveAnalyzersForRosynNotFound will run at the
78+
end and will remove all source generators (as they're only supported in C# projects), so there's nothing left to do here.
79+
-->
80+
<Target Name="MVVMToolkitRemoveDuplicateAnalyzersWhenRoslynComponentVersioningIsNotSupported"
81+
Condition="'$(MVVMToolkitIsManualRoslynMultiTargetingLogicNeeded)' == 'true'"
82+
AfterTargets="MVVMToolkitRemoveAnalyzersForRoslyn3">
83+
84+
<!--
85+
This switch manually implements Roslyn component versioning. That is, it checks the current version of Roslyn and
86+
removes and removes all analyzers except the highest version that is supported. The fallback is just Roslyn 4.0.
87+
-->
88+
<PropertyGroup>
89+
<MVVMToolkitSelectedRoslynAnalyzerDirectoryName Condition="$([MSBuild]::VersionGreaterThanOrEquals($(MVVMToolkitCurrentCompilerVersion), 4.3))">roslyn4.3</MVVMToolkitSelectedRoslynAnalyzerDirectoryName>
90+
<MVVMToolkitSelectedRoslynAnalyzerDirectoryName Condition="'$(MVVMToolkitSelectedRoslynAnalyzerDirectoryName)' == ''">roslyn4.0</MVVMToolkitSelectedRoslynAnalyzerDirectoryName>
91+
</PropertyGroup>
92+
<ItemGroup>
93+
94+
<!--
95+
This condition is a bit convoluted, but it's essentially just selecting all analyzers from the NuGet package that don't have the target Roslyn directory name in their full path.
96+
For instance, if Roslyn 4.3 is the highest supported version, the target directory name will be "roslyn 4.3", and this condition will filter out all analyzers with a path such
97+
as: "C:\...\.nuget\...\CommunityToolkit.Mvvm\analyzers\roslyn4.0\cs\CommunityToolkit.Mvvm". The [System.String]::Concat trick is used to achieve two things: we can't directly
98+
invoke a property function (ie. Contains in this case) on a metadata item, so we need an intermediate string to invoke it on. We could also use [System.String]::new, but using
99+
Concat is more efficient as it'll just skip the allocation entirely if one of the two inputs is an empty string, which is the case here.
100+
-->
101+
<Analyzer Remove="@(MVVMToolkitAnalyzer)" Condition="!$([System.String]::Concat('', '%(MVVMToolkitAnalyzer.FullPath)').Contains('$(MVVMToolkitSelectedRoslynAnalyzerDirectoryName)'))"/>
102+
</ItemGroup>
103+
</Target>
104+
105+
<!--
106+
Inform the user if packages.config is used (as the analyzers and the source generators
107+
won't work at all). Since packages.config can only be used with legacy-style projects,
108+
the entire package can be skipped if an SDK-style project is used.
109+
-->
110+
<Target Name="MVVMToolkitWarnForPackagesConfigUse"
111+
AfterTargets="ResolvePackageDependenciesForBuild;ResolveNuGetPackageAssets"
112+
Condition="'$(UsingMicrosoftNetSDK)' != 'true'">
113+
114+
<!--
115+
Check whether packages are being restored via packages.config, by reading the associated MSBuild property.
116+
This happens when either the project style is using packages.config, or when explicitly requested.
117+
See https://learn.microsoft.com/nuget/reference/msbuild-targets#restoring-packagereference-and-packagesconfig-projects-with-msbuild.
118+
-->
119+
<PropertyGroup>
120+
<MVVMToolkitIsTargetProjectUsingPackagesConfig Condition ="'$(RestorePackagesConfig)' == 'true' OR '$(RestoreProjectStyle)' == 'PackagesConfig'">true</MVVMToolkitIsTargetProjectUsingPackagesConfig>
121+
</PropertyGroup>
122+
123+
<!--
124+
If no packages.config properties are set, also try to manually find the packages.config file.
125+
This will be in the @(None) elements, if present. Doing so makes sure this works in builds as
126+
well, since the implicit targets populating the properties above only run when restoring.
127+
Since the packages.config file will always be in the root of the project, if present, we will
128+
match with the full item spec (see https://learn.microsoft.com/nuget/reference/packages-config).
129+
-->
130+
<FindInList ItemSpecToFind="packages.config"
131+
List="@(None)"
132+
MatchFileNameOnly="false"
133+
Condition="'$(MVVMToolkitIsTargetProjectUsingPackagesConfig)' != 'true'">
134+
<Output TaskParameter="ItemFound" PropertyName="MVVMToolkitPackagesConfigFile"/>
135+
</FindInList>
136+
137+
<!-- Make sure to update the MSBuild property if the above task did find something -->
138+
<PropertyGroup>
139+
<MVVMToolkitIsTargetProjectUsingPackagesConfig Condition ="'$(MVVMToolkitPackagesConfigFile)' == 'packages.config'">true</MVVMToolkitIsTargetProjectUsingPackagesConfig>
140+
</PropertyGroup>
141+
142+
<!-- Emit a warning in case packages.config is used -->
143+
<Warning Condition ="'$(MVVMToolkitIsTargetProjectUsingPackagesConfig)' == 'true'"
144+
Code="MVVMTKCFG0002"
145+
HelpLink="https://aka.ms/mvvmtoolkit/errors/mvvmtkcfg0002"
146+
Text="The MVVM Toolkit source generators might not be loaded correctly, as the current project is using the packages.config setup to restore NuGet packages. Source generators require PackageReference to be used (either in a legacy-style or SDK-style .csproj project, both are supported as long as PackageReference is used)."/>
147+
</Target>
148+
149+
</Project>

‎src/CommunityToolkit.Mvvm/CommunityToolkit.Mvvm.csproj

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,11 +91,41 @@
9191

9292
<ItemGroup Label="Package">
9393

94-
<!-- Include the custom .targets file to check the source generator (.NET 6 and 8 are not needed as they guarantee Roslyn 4.x) -->
95-
<None Include="CommunityToolkit.Mvvm.targets" PackagePath="buildTransitive\netstandard2.0" Pack="true" />
96-
<None Include="CommunityToolkit.Mvvm.targets" PackagePath="buildTransitive\netstandard2.1" Pack="true" />
94+
<!-- .NET Standard 2.0 only needs the Roslyn validation .targets -->
95+
<None Include="CommunityToolkit.Mvvm.SourceGenerators.targets" PackagePath="buildTransitive\netstandard2.0" Pack="true" />
96+
<None Include="CommunityToolkit.Mvvm.targets" PackagePath="buildTransitive\netstandard2.0" Pack="true" />
97+
<None Include="CommunityToolkit.Mvvm.SourceGenerators.targets" PackagePath="build\netstandard2.0" Pack="true" />
9798
<None Include="CommunityToolkit.Mvvm.targets" PackagePath="build\netstandard2.0" Pack="true" />
99+
100+
<!-- .NET Standard 2.0 does the same -->
101+
<None Include="CommunityToolkit.Mvvm.SourceGenerators.targets" PackagePath="buildTransitive\netstandard2.1" Pack="true" />
102+
<None Include="CommunityToolkit.Mvvm.targets" PackagePath="buildTransitive\netstandard2.1" Pack="true" />
103+
<None Include="CommunityToolkit.Mvvm.SourceGenerators.targets" PackagePath="build\netstandard2.1" Pack="true" />
98104
<None Include="CommunityToolkit.Mvvm.targets" PackagePath="build\netstandard2.1" Pack="true" />
105+
106+
<!-- .NET 6 also supports feature switches -->
107+
<None Include="CommunityToolkit.Mvvm.FeatureSwitches.targets" PackagePath="buildTransitive\net6.0" Pack="true" />
108+
<None Include="CommunityToolkit.Mvvm.SourceGenerators.targets" PackagePath="buildTransitive\net6.0" Pack="true" />
109+
<None Include="CommunityToolkit.Mvvm.targets" PackagePath="buildTransitive\net6.0" Pack="true" />
110+
<None Include="CommunityToolkit.Mvvm.FeatureSwitches.targets" PackagePath="build\net6.0" Pack="true" />
111+
<None Include="CommunityToolkit.Mvvm.SourceGenerators.targets" PackagePath="build\net6.0" Pack="true" />
112+
<None Include="CommunityToolkit.Mvvm.targets" PackagePath="build\net6.0" Pack="true" />
113+
114+
<!-- .NET 8 does the same as .NET 6 -->
115+
<None Include="CommunityToolkit.Mvvm.FeatureSwitches.targets" PackagePath="buildTransitive\net8.0" Pack="true" />
116+
<None Include="CommunityToolkit.Mvvm.SourceGenerators.targets" PackagePath="buildTransitive\net8.0" Pack="true" />
117+
<None Include="CommunityToolkit.Mvvm.targets" PackagePath="buildTransitive\net8.0" Pack="true" />
118+
<None Include="CommunityToolkit.Mvvm.FeatureSwitches.targets" PackagePath="build\net8.0" Pack="true" />
119+
<None Include="CommunityToolkit.Mvvm.SourceGenerators.targets" PackagePath="build\net8.0" Pack="true" />
120+
<None Include="CommunityToolkit.Mvvm.targets" PackagePath="build\net8.0" Pack="true" />
121+
122+
<!-- .NET 8 on Windows is the same as .NET 8 with respect to .targets -->
123+
<None Include="CommunityToolkit.Mvvm.FeatureSwitches.targets" PackagePath="buildTransitive\net8.0-windows10.0.17763.0" Pack="true" />
124+
<None Include="CommunityToolkit.Mvvm.SourceGenerators.targets" PackagePath="buildTransitive\net8.0-windows10.0.17763.0" Pack="true" />
125+
<None Include="CommunityToolkit.Mvvm.targets" PackagePath="buildTransitive\net8.0-windows10.0.17763.0" Pack="true" />
126+
<None Include="CommunityToolkit.Mvvm.FeatureSwitches.targets" PackagePath="build\net8.0-windows10.0.17763.0" Pack="true" />
127+
<None Include="CommunityToolkit.Mvvm.SourceGenerators.targets" PackagePath="build\net8.0-windows10.0.17763.0" Pack="true" />
128+
<None Include="CommunityToolkit.Mvvm.targets" PackagePath="build\net8.0-windows10.0.17763.0" Pack="true" />
99129

100130
<!--
101131
Pack the source generator to the right package folders (each matching the target Roslyn version).
@@ -112,4 +142,5 @@
112142
<None Include="..\CommunityToolkit.Mvvm.CodeFixers\bin\$(Configuration)\netstandard2.0\CommunityToolkit.Mvvm.CodeFixers.dll" PackagePath="analyzers\dotnet\roslyn4.0\cs" Pack="true" Visible="false" />
113143
<None Include="..\CommunityToolkit.Mvvm.CodeFixers\bin\$(Configuration)\netstandard2.0\CommunityToolkit.Mvvm.CodeFixers.dll" PackagePath="analyzers\dotnet\roslyn4.3\cs" Pack="true" Visible="false" />
114144
</ItemGroup>
145+
115146
</Project>

0 commit comments

Comments
 (0)