Merge pull request #377 from twsouthwick/ImportWindowsDesktopTargets

Add ImportWindowsDesktopTargets=true for desktop .NET Framework apps
dotnet · Feb 18, 2021 · 93294d4 · 93294d4
2 parents 3118d1e + eaed0db
commit 93294d4
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 1 deletion.
diff --git a/src/MSBuild.Abstractions/MSBuildConversionWorkspace.cs b/src/MSBuild.Abstractions/MSBuildConversionWorkspace.cs
@@ -100,7 +100,7 @@ public ImmutableDictionary<string, ImmutableDictionary<string, string>> Determin
         private void RemoveTargetsNotLoadableByNETSDKMSBuild(string path)
         {
             var projectFile = File.ReadAllText(path);
-            if (projectFile is { Length:>0 })
+            if (projectFile is { Length: > 0 })
             {
                 var replacement =
                     projectFile
@@ -178,6 +178,11 @@ private bool TryCreateSdkBaselineProject(string projectFilePath, IProject projec
                 {
                     MSBuildHelpers.AddUseWinForms(propGroup);
                 }
+
+                if (MSBuildHelpers.HasWPFOrWinForms(propGroup) && tfm.ContainsIgnoreCase(MSBuildFacts.Net5))
+                {
+                    MSBuildHelpers.AddImportWindowsDesktopTargets(propGroup);
+                }
             }
 
             // Create a new collection because a project with this name has already been loaded into the global collection.

diff --git a/src/MSBuild.Abstractions/MSBuildHelpers.cs b/src/MSBuild.Abstractions/MSBuildHelpers.cs
@@ -281,6 +281,12 @@ public static ProjectItemElement GetPackagesConfigItem(ProjectItemGroupElement p
         /// </summary>
         public static void AddUseWPF(ProjectPropertyGroupElement propGroup) => propGroup.AddProperty(DesktopFacts.UseWPFPropertyName, "true");
 
+        /// <summary>
+        /// Adds the ImportWindowsDesktopTargets=true property to ensure builds targeting .NET Framework will succeed.
+        /// </summary>
+        /// <param name="propGroup"></param>
+        public static void AddImportWindowsDesktopTargets(ProjectPropertyGroupElement propGroup) => propGroup.AddProperty(DesktopFacts.ImportWindowsDesktopTargetsName, "true");
+
         /// <summary>
         /// Finds the property group with the TFM specified, which is normally the top-level property group.
         /// </summary>

diff --git a/src/MSBuild.Conversion.Facts/DesktopFacts.cs b/src/MSBuild.Conversion.Facts/DesktopFacts.cs
@@ -54,6 +54,7 @@ public static class DesktopFacts
         public const string WinSDKAttribute = "Microsoft.NET.Sdk.WindowsDesktop";
         public const string UseWPFPropertyName = "UseWPF";
         public const string UseWinFormsPropertyName = "UseWindowsForms";
+        public const string ImportWindowsDesktopTargetsName = "ImportWindowsDesktopTargets";
         public const string DesignerSuffix = ".Designer.cs";
         public const string XamlFileExtension = ".xaml";
         public const string SettingsDesignerFileName = "Settings.Designer.cs";

diff --git a/src/MSBuild.Conversion.Project/ProjectRootElementExtensionsForConversion.cs b/src/MSBuild.Conversion.Project/ProjectRootElementExtensionsForConversion.cs
@@ -409,6 +409,13 @@ public static IProjectRootElement AddDesktopProperties(this IProjectRootElement
                 MSBuildHelpers.AddUseWPF(propGroup);
             }
 
+            if (!baselineProject.GlobalProperties.Contains(DesktopFacts.ImportWindowsDesktopTargetsName, StringComparer.OrdinalIgnoreCase)
+             && !projectRootElement.Sdk.Equals(DesktopFacts.WinSDKAttribute)
+             && (MSBuildHelpers.IsWPF(projectRootElement) || MSBuildHelpers.IsWinForms(projectRootElement)))
+            {
+                MSBuildHelpers.AddImportWindowsDesktopTargets(propGroup);
+            }
+
             return projectRootElement;
         }
 

diff --git a/tests/TestData/SmokeTests.WinformsNet5Baseline/SmokeTests.WinformsNet5Baseline.csproj b/tests/TestData/SmokeTests.WinformsNet5Baseline/SmokeTests.WinformsNet5Baseline.csproj
@@ -5,6 +5,7 @@
     <OutputType>WinExe</OutputType>
     <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
     <UseWindowsForms>true</UseWindowsForms>
+    <ImportWindowsDesktopTargets>true</ImportWindowsDesktopTargets>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/tests/TestData/SmokeTests.WpfNet5Baseline/SmokeTests.WpfNet5Baseline.csproj b/tests/TestData/SmokeTests.WpfNet5Baseline/SmokeTests.WpfNet5Baseline.csproj
@@ -5,6 +5,7 @@
     <OutputType>WinExe</OutputType>
     <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
     <UseWPF>true</UseWPF>
+    <ImportWindowsDesktopTargets>true</ImportWindowsDesktopTargets>
   </PropertyGroup>
 
   <ItemGroup>