Merge pull request #187 from unity/version-2.0.22

2.0.22

Author: sailro

Packages/com.unity.ide.visualstudio.tests/Tests/Editor/AssemblyNameProviderTests.cs

@@ -30,14 +30,14 @@ public void SetUp()
 			m_AssemblyNameProvider.ResetProjectGenerationFlag();
 		}
 
-		[TestCase(@"Temp\Bin\Debug\", "AssemblyName", "AssemblyName")]
-		[TestCase(@"Temp\Bin\Debug\", "My.Player.AssemblyName", "My.Player.AssemblyName")]
-		[TestCase(@"Temp\Bin\Debug\", "AssemblyName.Player", "AssemblyName.Player")]
-		[TestCase(@"Temp\Bin\Debug\Player\", "AssemblyName", "AssemblyName.Player")]
-		[TestCase(@"Temp\Bin\Debug\Player\", "AssemblyName.Player", "AssemblyName.Player.Player")]
+		[TestCase(@"Temp\bin\Debug\", "AssemblyName", "AssemblyName")]
+		[TestCase(@"Temp\bin\Debug\", "My.Player.AssemblyName", "My.Player.AssemblyName")]
+		[TestCase(@"Temp\bin\Debug\", "AssemblyName.Player", "AssemblyName.Player")]
+		[TestCase(@"Temp\bin\Debug\Player\", "AssemblyName", "AssemblyName.Player")]
+		[TestCase(@"Temp\bin\Debug\Player\", "AssemblyName.Player", "AssemblyName.Player.Player")]
 		public void GetOutputPath_ReturnsPlayerAndeditorOutputPath(string assemblyOutputPath, string assemblyName, string expectedAssemblyName)
 		{
-			Assert.AreEqual(expectedAssemblyName, m_AssemblyNameProvider.GetAssemblyName(assemblyOutputPath, assemblyName));
+			Assert.AreEqual(expectedAssemblyName, m_AssemblyNameProvider.GetAssemblyName(assemblyOutputPath.NormalizePathSeparators(), assemblyName));
 		}
 
 		[Test]
@@ -49,7 +49,7 @@ public void AllEditorAssemblies_AreCollected()
 
 			foreach (Assembly editorAssembly in editorAssemblies)
 			{
-				Assert.IsTrue(collectedAssemblies.Any(assembly => assembly.name == editorAssembly.name && assembly.outputPath == @"Temp\Bin\Debug\"), $"{editorAssembly.name}: was not found in collection.");
+				Assert.IsTrue(collectedAssemblies.Any(assembly => assembly.name == editorAssembly.name && assembly.outputPath == AssemblyNameProvider.AssemblyOutput), $"{editorAssembly.name}: was not found in collection.");
 			}
 		}
 
@@ -91,7 +91,7 @@ public void PlayerAssemblies_AreNotCollected_BeforeToggling()
 
 			foreach (Assembly playerAssembly in playerAssemblies)
 			{
-				Assert.IsFalse(collectedAssemblies.Any(assembly => assembly.name == playerAssembly.name && assembly.outputPath == @"Temp\Bin\Debug\Player\"), $"{playerAssembly.name}: was found in collection.");
+				Assert.IsFalse(collectedAssemblies.Any(assembly => assembly.name == playerAssembly.name && assembly.outputPath == AssemblyNameProvider.PlayerAssemblyOutput), $"{playerAssembly.name}: was found in collection.");
 			}
 		}
 
@@ -106,7 +106,7 @@ public void AllPlayerAssemblies_AreCollected_AfterToggling()
 
 			foreach (Assembly playerAssembly in playerAssemblies)
 			{
-				Assert.IsTrue(collectedAssemblies.Any(assembly => assembly.name == playerAssembly.name && assembly.outputPath == @"Temp\Bin\Debug\Player\"), $"{playerAssembly.name}: was not found in collection.");
+				Assert.IsTrue(collectedAssemblies.Any(assembly => assembly.name == playerAssembly.name && assembly.outputPath == AssemblyNameProvider.PlayerAssemblyOutput), $"{playerAssembly.name}: was not found in collection.");
 			}
 		}
 

Packages/com.unity.ide.visualstudio.tests/Tests/Editor/CSProjectTests.cs

@@ -150,16 +150,16 @@ public void DefaultSyncSettings_WhenSynced_CreatesProjectFileFromDefaultTemplate
 					$"    <DefineConstants></DefineConstants>",
 					"    <ErrorReport>prompt</ErrorReport>",
 					"    <WarningLevel>4</WarningLevel>",
-					"    <NoWarn>0169</NoWarn>",
+					"    <NoWarn>0169;USG0001</NoWarn>",
 					"    <AllowUnsafeBlocks>False</AllowUnsafeBlocks>",
 					"  </PropertyGroup>",
 					"  <PropertyGroup Condition=\" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' \">",
 					"    <DebugType>pdbonly</DebugType>",
 					"    <Optimize>true</Optimize>",
-					"    <OutputPath>Temp\\bin\\Release\\</OutputPath>",
+					$"    <OutputPath>{@"Temp\bin\Release\".NormalizePathSeparators()}</OutputPath>",
 					"    <ErrorReport>prompt</ErrorReport>",
 					"    <WarningLevel>4</WarningLevel>",
-					"    <NoWarn>0169</NoWarn>",
+					"    <NoWarn>0169;USG0001</NoWarn>",
 					"    <AllowUnsafeBlocks>False</AllowUnsafeBlocks>",
 					"  </PropertyGroup>",
 					"  <PropertyGroup>",
@@ -173,6 +173,7 @@ public void DefaultSyncSettings_WhenSynced_CreatesProjectFileFromDefaultTemplate
 					"    <ProjectTypeGuids>{E097FAD1-6243-4DAD-9C02-E9B9EFC3FFC1};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}</ProjectTypeGuids>",
 					"    <UnityProjectGenerator>Package</UnityProjectGenerator>",
 					$"    <UnityProjectGeneratorVersion>{packageVersion}</UnityProjectGeneratorVersion>",
+					"    <UnityProjectGeneratorStyle>Legacy</UnityProjectGeneratorStyle>",
 					$"    <UnityProjectType>{buildTarget}</UnityProjectType>",
 					$"    <UnityBuildTarget>{EditorUserBuildSettings.activeBuildTarget + ":" + (int)EditorUserBuildSettings.activeBuildTarget}</UnityBuildTarget>",
 					$"    <UnityVersion>{unityVersion}</UnityVersion>",
@@ -182,7 +183,7 @@ public void DefaultSyncSettings_WhenSynced_CreatesProjectFileFromDefaultTemplate
 					"  </ItemGroup>",
 					"  <ItemGroup>",
 					"  </ItemGroup>",
-					"  <Import Project=\"$(MSBuildToolsPath)\\Microsoft.CSharp.targets\" />",
+					$"  <Import Project=\"{@"$(MSBuildToolsPath)\Microsoft.CSharp.targets".NormalizePathSeparators()}\" />",
 					"  <Target Name=\"GenerateTargetFrameworkMonikerAttribute\" />",
 					"  <!-- To modify your build process, add your task inside one of the targets below and uncomment it.",
 					"       Other similar extension points exist, see Microsoft.Common.targets.",
@@ -906,7 +907,7 @@ public void DllInSourceFiles_WillBeAddedAsReference()
 				XmlDocument scriptProject = XMLUtilities.FromText(csprojFileContents);
 				XMLUtilities.AssertCompileItemsMatchExactly(scriptProject, new[] { "file.cs" });
 				XMLUtilities.AssertNonCompileItemsMatchExactly(scriptProject, new string[0]);
-				Assert.IsTrue(csprojFileContents.MatchesRegex($"<Reference Include=\"reference\">\\W*<HintPath>{referenceDll}\\W*</HintPath>\\W*</Reference>"));
+				Assert.IsTrue(csprojFileContents.MatchesRegex($"<Reference Include=\"reference\">\\W*<HintPath>{referenceDll}\\W*</HintPath>\\W*<Private>False</Private>\\W*</Reference>"));
 			}
 
 			[Test]
@@ -921,7 +922,7 @@ public void Containing_PathWithSpaces_IsParsedCorrectly()
 				synchronizer.Sync();
 
 				var csprojFileContents = m_Builder.ReadProjectFile(m_Builder.Assembly);
-				Assert.IsTrue(csprojFileContents.MatchesRegex($"<Reference Include=\"Goodbye\">\\W*<HintPath>{Regex.Escape(fullPathReferences[0].ReplaceDirectorySeparators())}\\W*</HintPath>\\W*</Reference>"));
+				Assert.IsTrue(csprojFileContents.MatchesRegex($"<Reference Include=\"Goodbye\">\\W*<HintPath>{Regex.Escape(fullPathReferences[0].ReplaceDirectorySeparators())}\\W*</HintPath>\\W*<Private>False</Private>\\W*</Reference>"));
 			}
 
 			[Test]
@@ -950,8 +951,8 @@ public void Multiple_AreAdded()
 
 				var csprojFileContents = m_Builder.ReadProjectFile(m_Builder.Assembly);
 
-				Assert.IsTrue(csprojFileContents.MatchesRegex("<Reference Include=\"Hello\">\\W*<HintPath>Hello.dll</HintPath>\\W*</Reference>"));
-				Assert.IsTrue(csprojFileContents.MatchesRegex("<Reference Include=\"MyPlugin\">\\W*<HintPath>MyPlugin.dll</HintPath>\\W*</Reference>"));
+				Assert.IsTrue(csprojFileContents.MatchesRegex("<Reference Include=\"Hello\">\\W*<HintPath>Hello.dll</HintPath>\\W*<Private>False</Private>\\W*</Reference>"));
+				Assert.IsTrue(csprojFileContents.MatchesRegex("<Reference Include=\"MyPlugin\">\\W*<HintPath>MyPlugin.dll</HintPath>\\W*<Private>False</Private>\\W*</Reference>"));
 			}
 
 			[Test]
@@ -988,8 +989,8 @@ public void AssemblyReferenceFromInternalizedPackage_IsAddedAsReference()
 				var csprojFileContents = m_Builder.ReadProjectFile(m_Builder.Assembly);
 				Assert.That(csprojFileContents, Does.Not.Match($@"<ProjectReference Include=""{assemblyReferences[0].name}\.csproj"">[\S\s]*?</ProjectReference>"));
 				Assert.That(csprojFileContents, Does.Not.Match($@"<ProjectReference Include=""{assemblyReferences[1].name}\.csproj"">[\S\s]*?</ProjectReference>"));
-				Assert.That(csprojFileContents, Does.Match($"<Reference Include=\"{assemblyReferences[0].name}\">\\W*<HintPath>{Regex.Escape(assemblyReferences[0].outputPath.ReplaceDirectorySeparators())}</HintPath>\\W*</Reference>"));
-				Assert.That(csprojFileContents, Does.Match($"<Reference Include=\"{assemblyReferences[1].name}\">\\W*<HintPath>{Regex.Escape(assemblyReferences[1].outputPath.ReplaceDirectorySeparators())}</HintPath>\\W*</Reference>"));
+				Assert.That(csprojFileContents, Does.Match($"<Reference Include=\"{assemblyReferences[0].name}\">\\W*<HintPath>{Regex.Escape(assemblyReferences[0].outputPath.ReplaceDirectorySeparators())}</HintPath>\\W*<Private>False</Private>\\W*</Reference>"));
+				Assert.That(csprojFileContents, Does.Match($"<Reference Include=\"{assemblyReferences[1].name}\">\\W*<HintPath>{Regex.Escape(assemblyReferences[1].outputPath.ReplaceDirectorySeparators())}</HintPath>\\W*<Private>False</Private>\\W*</Reference>"));
 			}
 
 			[Test]
@@ -1005,8 +1006,8 @@ public void CompiledAssemblyReference_IsAdded()
 				synchronizer.Sync();
 
 				var csprojFileContents = m_Builder.ReadProjectFile(m_Builder.Assembly);
-				Assert.IsTrue(csprojFileContents.MatchesRegex($"<Reference Include=\"Hello\">\\W*<HintPath>{Regex.Escape(compiledAssemblyReferences[0])}</HintPath>\\W*</Reference>"));
-				Assert.IsTrue(csprojFileContents.MatchesRegex($"<Reference Include=\"MyPlugin\">\\W*<HintPath>{Regex.Escape(compiledAssemblyReferences[1])}</HintPath>\\W*</Reference>"));
+				Assert.IsTrue(csprojFileContents.MatchesRegex($"<Reference Include=\"Hello\">\\W*<HintPath>{Regex.Escape(compiledAssemblyReferences[0])}</HintPath>\\W*<Private>False</Private>\\W*</Reference>"));
+				Assert.IsTrue(csprojFileContents.MatchesRegex($"<Reference Include=\"MyPlugin\">\\W*<HintPath>{Regex.Escape(compiledAssemblyReferences[1])}</HintPath>\\W*<Private>False</Private>\\W*</Reference>"));
 			}
 
 			[Test]
@@ -1018,7 +1019,7 @@ public void ProjectReference_FromLibraryReferences_IsAdded()
 				synchronizer.Sync();
 
 				var csprojFileContents = m_Builder.ReadProjectFile(m_Builder.Assembly);
-				Assert.IsFalse(csprojFileContents.MatchesRegex($"<Reference Include=\"{projectAssembly.name}\">\\W*<HintPath>{Regex.Escape(projectAssembly.outputPath.ReplaceDirectorySeparators())}</HintPath>\\W*</Reference>"));
+				Assert.IsFalse(csprojFileContents.MatchesRegex($"<Reference Include=\"{projectAssembly.name}\">\\W*<HintPath>{Regex.Escape(projectAssembly.outputPath.ReplaceDirectorySeparators())}</HintPath>\\W*<Private>False</Private>\\W*</Reference>"));
 			}
 
 			[Test]

Packages/com.unity.ide.visualstudio.tests/package.json

@@ -3,7 +3,7 @@
   "name": "com.unity.ide.visualstudio.tests",
   "displayName": "Visual Studio Editor",
   "description": "Code editor integration for supporting Visual Studio as code editor for unity. Adds support for generating csproj files for intellisense purposes, auto discovery of installations, etc.",
-  "version": "2.0.20",
+  "version": "2.0.21",
   "unity": "2019.4",
   "unityRelease": "25f1",
   "dependencies": {

Packages/com.unity.ide.visualstudio/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Code Editor Package for Visual Studio
 
+## [2.0.21] - 2023-09-05
+
+Integration:
+
+- Only disable the legacy `com.unity.ide.vscode` package going forward.
+- Fix json parsing issues with specific non-UTF code pages.
+
+Project generation:
+
+- Target `netstandard2.1` instead of `netstandard2.0`.
+- Set `defaultSolution` in `settings.json`.
+- Remove `files.exclude` entries for root `csproj` and `sln` files in `settings.json` when needed.
+- Add `vstuc` launch configuration to `launch.json` when needed.
+- Add `visualstudiotoolsforunity.vstuc` entry to `extensions.json` when needed.
+- You can prevent the package from patching those configuration files by creating a `.vscode/.vstupatchdisable` file.
+
 ## [2.0.20] - 2023-06-27
 
 Integration:
@@ -131,7 +147,7 @@ Documentation:
 
 Integration:
 
-- Remove com.unity.nuget.newtonsoft-json dependency in favor of the built-in JsonUtility for the VS Test Runner.
+- Remove `com.unity.nuget.newtonsoft-json` dependency in favor of the built-in JsonUtility for the VS Test Runner.
 
 ## [2.0.6] - 2021-01-20
 
@@ -169,7 +185,7 @@ Integration:
 Project generation:
 
 - Added C#8 language support.
-- Added UnityProjectGeneratorVersion property.
+- Added `UnityProjectGeneratorVersion` property.
 - Local and Embedded packages are now selected by default for generation.
 - Added support for asmdef root namespace.
 
@@ -191,7 +207,7 @@ Integration:
 ## [2.0.1] - 2020-03-19
 
 - When Visual Studio installation is compatible with C# 8.0, setup the language version to not prompt the user with unsupported constructs. (So far Unity only supports C# 7.3).
-- Use Unity's TypeCache to improve project generation speed.
+- Use Unity's `TypeCache` to improve project generation speed.
 - Properly check for a managed assembly before displaying a warning regarding legacy PDB usage.
 - Add support for selective project generation (embedded, local, registry, git, builtin, player).
 
@@ -241,8 +257,8 @@ Integration:
 
 ## [1.0.4] - 2019-04-12
 
-- Fixing null reference issue for callbacks to AssetPostProcessor.
-- Ensure Path.GetFullPath does not get an empty string.
+- Fixing null reference issue for callbacks to `AssetPostProcessor`.
+- Ensure `Path.GetFullPath` does not get an empty string.
 
 ## [1.0.3] - 2019-01-01
 

Packages/com.unity.ide.visualstudio/Editor/Discovery.cs

@@ -13,11 +13,13 @@ internal static class Discovery
 	{
 		public static IEnumerable<IVisualStudioInstallation> GetVisualStudioInstallations()
 		{
+#if UNITY_EDITOR_WIN
 			foreach (var installation in VisualStudioForWindowsInstallation.GetVisualStudioInstallations())
 				yield return installation;
-
+#elif UNITY_EDITOR_OSX
 			foreach (var installation in VisualStudioForMacInstallation.GetVisualStudioInstallations())
 				yield return installation;
+#endif
 
 			foreach (var installation in VisualStudioCodeInstallation.GetVisualStudioInstallations())
 				yield return installation;
@@ -27,12 +29,13 @@ public static bool TryDiscoverInstallation(string editorPath, out IVisualStudioI
 		{
 			try
 			{
+#if UNITY_EDITOR_WIN
 				if (VisualStudioForWindowsInstallation.TryDiscoverInstallation(editorPath, out installation))
 					return true;
-
+#elif UNITY_EDITOR_OSX
 				if (VisualStudioForMacInstallation.TryDiscoverInstallation(editorPath, out installation))
 					return true;
-
+#endif
 				if (VisualStudioCodeInstallation.TryDiscoverInstallation(editorPath, out installation))
 					return true;
 			}
@@ -46,8 +49,11 @@ public static bool TryDiscoverInstallation(string editorPath, out IVisualStudioI
 
 		public static void Initialize()
 		{
+#if UNITY_EDITOR_WIN
 			VisualStudioForWindowsInstallation.Initialize();
+#elif UNITY_EDITOR_OSX
 			VisualStudioForMacInstallation.Initialize();
+#endif
 			VisualStudioCodeInstallation.Initialize();
 		}
 	}

Packages/com.unity.ide.visualstudio/Editor/Messaging/UdpSocket.cs

@@ -27,9 +27,7 @@ public void Bind(IPAddress address, int port = 0)
 
 		private void SetIOControl()
 		{
-			if (!VisualStudioEditor.IsWindows)
-				return;
-
+#if UNITY_EDITOR_WIN
 			try
 			{
 				const int SIO_UDP_CONNRESET = -1744830452;
@@ -40,6 +38,7 @@ private void SetIOControl()
 			{
 				// fallback
 			}
+#endif
 		}
 
 		public static byte[] BufferFor(IAsyncResult result)

Packages/com.unity.ide.visualstudio/Editor/ProjectGeneration/AssemblyNameProvider.cs

@@ -61,15 +61,18 @@ public string GetAssemblyNameFromScriptPath(string path)
 			return CompilationPipeline.GetAssemblyNameFromScriptPath(path);
 		}
 
+		internal static readonly string AssemblyOutput = @"Temp\bin\Debug\".NormalizePathSeparators();
+		internal static readonly string PlayerAssemblyOutput = @"Temp\bin\Debug\Player\".NormalizePathSeparators();
+
 		public IEnumerable<Assembly> GetAssemblies(Func<string, bool> shouldFileBePartOfSolution)
 		{
-			IEnumerable<Assembly> assemblies = GetAssembliesByType(AssembliesType.Editor, shouldFileBePartOfSolution, @"Temp\Bin\Debug\");
+			IEnumerable<Assembly> assemblies = GetAssembliesByType(AssembliesType.Editor, shouldFileBePartOfSolution, AssemblyOutput);
 
 			if (!ProjectGenerationFlag.HasFlag(ProjectGenerationFlag.PlayerAssemblies))
 			{
 				return assemblies;
 			}
-			var playerAssemblies = GetAssembliesByType(AssembliesType.Player, shouldFileBePartOfSolution, @"Temp\Bin\Debug\Player\");
+			var playerAssemblies = GetAssembliesByType(AssembliesType.Player, shouldFileBePartOfSolution, PlayerAssemblyOutput);
 			return assemblies.Concat(playerAssemblies);
 		}
 
@@ -98,7 +101,8 @@ private static IEnumerable<Assembly> GetAssembliesByType(AssembliesType type, Fu
 
 		public string GetCompileOutputPath(string assemblyName)
 		{
-			return assemblyName.EndsWith(".Player", StringComparison.Ordinal) ? @"Temp\Bin\Debug\Player\" : @"Temp\Bin\Debug\";
+			// We need to keep this one for API surface check (AssemblyNameProvider is public), but not used anymore
+			throw new NotImplementedException();
 		}
 
 		public IEnumerable<string> GetAllAssetPaths()
@@ -207,7 +211,10 @@ public void ResetProjectGenerationFlag()
 
 		public string GetAssemblyName(string assemblyOutputPath, string assemblyName)
 		{
-			return assemblyOutputPath.EndsWith(@"\Player\", StringComparison.Ordinal) ? assemblyName + ".Player" : assemblyName;
+			if (assemblyOutputPath == PlayerAssemblyOutput)
+				return assemblyName + ".Player";
+
+			return assemblyName;
 		}
 	}
 }

Packages/com.unity.ide.visualstudio/Editor/ProjectGeneration/LegacyStyleProjectGeneration.cs

@@ -12,6 +12,8 @@ namespace Microsoft.Unity.VisualStudio.Editor
 
 	internal class LegacyStyleProjectGeneration : ProjectGeneration
 	{
+		internal override string StyleName => "Legacy";
+
 		public LegacyStyleProjectGeneration(string tempDirectory, IAssemblyNameProvider assemblyNameProvider, IFileIO fileIoProvider, IGUIDGenerator guidGenerator) : base(tempDirectory, assemblyNameProvider, fileIoProvider, guidGenerator)
 		{
 		}
@@ -82,7 +84,7 @@ internal override void AppendProjectReference(Assembly assembly, Assembly refere
 		internal override void GetProjectFooter(StringBuilder footerBuilder)
 		{
 			footerBuilder.Append(string.Join(k_WindowsNewline,
-				@"  <Import Project=""$(MSBuildToolsPath)\Microsoft.CSharp.targets"" />",
+				$"  <Import Project=\"{@"$(MSBuildToolsPath)\Microsoft.CSharp.targets".NormalizePathSeparators()}\" />",
 				@"  <Target Name=""GenerateTargetFrameworkMonikerAttribute"" />",
 				@"  <!-- To modify your build process, add your task inside one of the targets below and uncomment it.",
 				@"       Other similar extension points exist, see Microsoft.Common.targets.",