Log msbuild warning for missing TargetFrameworks (#175)

SimonCropp · Apr 24, 2024 · 08bb8d5 · 08bb8d5
1 parent 54a7a0c
commit 08bb8d5
Show file tree

Hide file tree

Showing 14 changed files with 83 additions and 1 deletion.
diff --git a/readme.md b/readme.md
@@ -18,6 +18,27 @@ The package targets `netstandard2.0` and is designed to support the following ru
 **See [Milestones](../../milestones?state=closed) for release notes.**
 
 
+## TargetFrameworks
+
+Some polyfills are implemented in a way that will not have the equivalent performance to the actual implementations.
+
+For example the polyfill for `StringBuilder.Append(ReadOnlySpan<char>)` on netcore2 is:
+
+```
+public StringBuilder Append(ReadOnlySpan<char> value)
+    => target.Append(value.ToString());
+```
+
+Which will result in a string allocation.
+
+As Polyfill is implemented as a source only nuget, the implementation for each polyfill is compiled into the IL of the resulting assembly. As a side-effect that implementation will continue to be used even if that assembly is executed in a runtime that has a more efficient implementation available.
+
+As a result, in the context of a project producing nuget package, that project should target all frameworks from the lowest TargetFramework up to and including the current framework. This way the most performant implementation will be used for each runtime. Take the following examples:
+
+ * If a nuget's minimum target is net6, then the resulting TargetFrameworks should also include net7.0 and net8.0
+ * If a nuget's minimum target is net471, then the resulting TargetFrameworks should also include net472 and net48"
+
+
 ## Nuget
 
 https://nuget.org/packages/Polyfill/

diff --git a/src/Consume/Consume.csproj b/src/Consume/Consume.csproj
@@ -1,5 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
+    <NoWarn>$(NoWarn);PolyFillTargetsForNuget</NoWarn>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT'">net461;net462;net47;net471;net472;net48;net481;net6.0-windows</TargetFrameworks>
     <TargetFrameworks>$(TargetFrameworks);netstandard2.0;netstandard2.1;netcoreapp2.0;netcoreapp2.1;netcoreapp2.2;netcoreapp3.0;netcoreapp3.1;net5.0;net6.0;net7.0;net8.0;net9.0</TargetFrameworks>

diff --git a/src/ConsumeClassicReferences/ConsumeClassicReferences.csproj b/src/ConsumeClassicReferences/ConsumeClassicReferences.csproj
@@ -1,5 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
+    <NoWarn>$(NoWarn);PolyFillTargetsForNuget</NoWarn>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT'">net461;net462;net47;net471;net472;net48;net481;net6.0-windows</TargetFrameworks>
     <TargetFrameworks>$(TargetFrameworks);netstandard2.0;netstandard2.1;netcoreapp2.0;netcoreapp2.1;netcoreapp2.2;netcoreapp3.0;netcoreapp3.1;net5.0;net6.0;net7.0;net8.0;net9.0</TargetFrameworks>

diff --git a/src/ConsumeIndirect/ConsumeIndirect.csproj b/src/ConsumeIndirect/ConsumeIndirect.csproj
@@ -1,5 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
+    <NoWarn>$(NoWarn);PolyFillTargetsForNuget</NoWarn>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT'">net461;net462;net47;net471;net472;net48;net481;net6.0-windows</TargetFrameworks>
     <TargetFrameworks>$(TargetFrameworks);netstandard2.0;netstandard2.1;netcoreapp2.0;netcoreapp2.1;netcoreapp2.2;netcoreapp3.0;netcoreapp3.1;net5.0;net6.0;net7.0;net8.0;net9.0</TargetFrameworks>

diff --git a/src/ConsumeNoRefs/ConsumeNoRefs.csproj b/src/ConsumeNoRefs/ConsumeNoRefs.csproj
@@ -1,5 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
+    <NoWarn>$(NoWarn);PolyFillTargetsForNuget</NoWarn>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT'">net461;net462;net47;net471;net472;net48;net481;net6.0-windows</TargetFrameworks>
     <TargetFrameworks>$(TargetFrameworks);netstandard2.0;netstandard2.1;netcoreapp2.0;netcoreapp2.1;netcoreapp2.2;netcoreapp3.0;netcoreapp3.1;net5.0;net6.0;net7.0;net8.0;net9.0</TargetFrameworks>

diff --git a/src/ConsumeTasksWithNoMemory/ConsumeTasksWithNoMemory.csproj b/src/ConsumeTasksWithNoMemory/ConsumeTasksWithNoMemory.csproj
@@ -1,5 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
+    <NoWarn>$(NoWarn);PolyFillTargetsForNuget</NoWarn>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <TargetFrameworks>netstandard2.0</TargetFrameworks>
   </PropertyGroup>

diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Project>
   <PropertyGroup>
-    <Version>4.9.0</Version>
+    <Version>5.0.0</Version>
     <AssemblyVersion>1.0.0</AssemblyVersion>
     <PackageTags>Polyfill</PackageTags>
     <DisableImplicitNamespaceImports>true</DisableImplicitNamespaceImports>

diff --git a/src/NoRefsTests/NoRefsTests.csproj b/src/NoRefsTests/NoRefsTests.csproj
@@ -1,5 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
+    <NoWarn>$(NoWarn);PolyFillTargetsForNuget</NoWarn>
     <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT'">net462;net472;net48;net6.0-windows</TargetFrameworks>
     <TargetFrameworks>$(TargetFrameworks);netcoreapp3.1;net5.0;net6.0;net7.0;net8.0;net9.0</TargetFrameworks>
   </PropertyGroup>

diff --git a/src/Polyfill.sln b/src/Polyfill.sln
@@ -38,6 +38,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ConsumeNoRefs", "ConsumeNoR
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ConsumeTasksWithNoMemory", "ConsumeTasksWithNoMemory\ConsumeTasksWithNoMemory.csproj", "{96EF1E04-5862-4D9E-B800-A6402F1ADF7A}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TargetFrameowkUsage", "TargetFrameowkUsage\TargetFrameowkUsage.csproj", "{41CB5A0C-E0F5-4C5C-B2FC-9A289E8CFDF8}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -84,6 +86,10 @@ Global
 		{96EF1E04-5862-4D9E-B800-A6402F1ADF7A}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{96EF1E04-5862-4D9E-B800-A6402F1ADF7A}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{96EF1E04-5862-4D9E-B800-A6402F1ADF7A}.Release|Any CPU.Build.0 = Release|Any CPU
+		{41CB5A0C-E0F5-4C5C-B2FC-9A289E8CFDF8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{41CB5A0C-E0F5-4C5C-B2FC-9A289E8CFDF8}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{41CB5A0C-E0F5-4C5C-B2FC-9A289E8CFDF8}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{41CB5A0C-E0F5-4C5C-B2FC-9A289E8CFDF8}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

diff --git a/src/Polyfill/Polyfill.targets b/src/Polyfill/Polyfill.targets
@@ -2,6 +2,7 @@
   <PropertyGroup>
     <PrepareForBuildDependsOn>$(PrepareForBuildDependsOn);PreparePolyfill</PrepareForBuildDependsOn>
     <LowerFramework>$(TargetFramework.ToLower())</LowerFramework>
+    <LowerFrameworks>$(TargetFrameworks.ToLower())</LowerFrameworks>
   </PropertyGroup>
   <PropertyGroup Condition="$(AllowUnsafeBlocks) == 'true' ">
     <DefineConstants>$(DefineConstants);AllowUnsafeBlocks</DefineConstants>
@@ -31,6 +32,43 @@
                             $(LowerFramework.StartsWith('netcoreapp3'))">
     <DefineConstants>$(DefineConstants);NETCOREAPPX</DefineConstants>
   </PropertyGroup>
+  <PropertyGroup>
+    <MaxNetRequired>false</MaxNetRequired>
+    <MaxNetRequired
+      Condition="$(LowerFrameworks.Contains('net5')) OR
+                 $(LowerFrameworks.Contains('net6')) OR
+                 $(LowerFrameworks.Contains('net7')) OR
+                 $(LowerFrameworks.Contains('netstandard')) OR
+                 $(LowerFrameworks.Contains('netcore'))"
+      >true</MaxNetRequired>
+
+    <MaxNetClassicRequired>false</MaxNetClassicRequired>
+    <MaxNetClassicRequired
+      Condition="(
+                   $(LowerFrameworks.Contains('net4')) OR
+                   $(LowerFrameworks.Contains('netstandard'))
+                 )
+                 AND
+                 !$(LowerFramework.Contains('net48'))
+                 AND
+                 !$(LowerFrameworks.Contains('net48'))"
+      >true</MaxNetClassicRequired>
+  </PropertyGroup>
+  <Target
+      Name="PolyFillValidateNugetTargets"
+      AfterTargets="AfterBuild"
+      Condition="$(NoWarn.Contains('PolyFillTargetsForNuget')) != true">
+    <Warning
+        Code="PolyFillTargetsForNuget"
+        Text="Projects that produce a nuget and consume PolyFill:
+For best performance all frameworks from the lowest TargetFramework up to and including net48 should be targeted.
+For example:
+ * If a nuget's minimum target is net47, then the resulting TargetFrameworks should include net471, net472, and net48.
+ * If a nuget's minimum target net6, then the resulting TargetFrameworks should include net7.0 and net8.0."
+        HelpLink="https://github.com/SimonCropp/Polyfill#targetframeworks"
+        Condition="$(MaxNetClassicRequired) OR $(MaxNetRequired)" />
+  </Target>
+
   <Target Name="PreparePolyfill" DependsOnTargets="ResolvePackageAssets">
     <PropertyGroup>
       <DefineConstants

diff --git a/src/PublicTests/PublicTests.csproj b/src/PublicTests/PublicTests.csproj
@@ -1,5 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
+    <NoWarn>$(NoWarn);PolyFillTargetsForNuget</NoWarn>
     <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT'">net462;net472;net48</TargetFrameworks>
     <TargetFrameworks>$(TargetFrameworks);netcoreapp3.1;net5.0;net6.0;net7.0;net8.0;net9.0</TargetFrameworks>
     <PolyPublic>true</PolyPublic>

diff --git a/src/TargetFrameowkUsage/TargetFrameowkUsage.csproj b/src/TargetFrameowkUsage/TargetFrameowkUsage.csproj
@@ -0,0 +1,8 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <GeneratePackageOnBuild Condition="'$(Configuration)' == 'Debug'">true</GeneratePackageOnBuild>
+    <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT'">net461</TargetFrameworks>
+    <TargetFrameworks>$(TargetFrameworks);net5.0</TargetFrameworks>
+  </PropertyGroup>
+  <Import Project="$(SolutionDir)\Polyfill\Polyfill.targets" />
+</Project>
diff --git a/src/Tests/Tests.csproj b/src/Tests/Tests.csproj
@@ -1,5 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
+    <NoWarn>$(NoWarn);PolyFillTargetsForNuget</NoWarn>
     <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT'">net462;net472;net48;net6.0-windows</TargetFrameworks>
     <TargetFrameworks>$(TargetFrameworks);netcoreapp3.1;net5.0;net6.0;net7.0;net8.0;net9.0</TargetFrameworks>
   </PropertyGroup>

diff --git a/src/UnsafeTests/UnsafeTests.csproj b/src/UnsafeTests/UnsafeTests.csproj
@@ -1,5 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
+    <NoWarn>$(NoWarn);PolyFillTargetsForNuget</NoWarn>
     <TargetFrameworks Condition=" '$(OS)' == 'Windows_NT'">net462;net472;net48</TargetFrameworks>
     <TargetFrameworks>$(TargetFrameworks);netcoreapp3.1;net5.0;net6.0;net7.0;net8.0;net9.0</TargetFrameworks>
     <AllowUnsafeBlocks>True</AllowUnsafeBlocks>