Remove the use of MSBuildLocator from dotnet-format (#48658)

dotnet-format uses the Roslyn MSBuildWorkspace for loading projects. Since Roslyn 4.9.0, the MSBuildWorkspace has used a separate BuildHost process for project loading which handles loading MSBuild.

Author: JoeRobich

src/BuiltInTools/dotnet-format/Commands/FormatCommandCommon.cs

@@ -100,14 +100,6 @@ internal static async Task<int> FormatAsync(FormatOptions formatOptions, ILogger
             {
                 var runtimeVersion = GetRuntimeVersion();
                 logger.LogDebug(Resources.The_dotnet_runtime_version_is_0, runtimeVersion);
-
-                if (!TryLoadMSBuild(out var msBuildPath))
-                {
-                    logger.LogError(Resources.Unable_to_locate_MSBuild_Ensure_the_NET_SDK_was_installed_with_the_official_installer);
-                    return UnableToLocateMSBuildExitCode;
-                }
-
-                logger.LogTrace(Resources.Using_msbuildexe_located_in_0, msBuildPath);
             }
 
             var formatResult = await CodeFormatter.FormatWorkspaceAsync(
@@ -345,34 +337,6 @@ private static string EnsureTrailingSlash(string path)
                 ?.InformationalVersion;
         }
 
-        internal static bool TryLoadMSBuild([NotNullWhen(returnValue: true)] out string? msBuildPath)
-        {
-            try
-            {
-                // Get the global.json pinned SDK or latest instance.
-                var msBuildInstance = Build.Locator.MSBuildLocator.QueryVisualStudioInstances()
-                    .Where(instance => instance.Version.Major >= 6)
-                    .FirstOrDefault();
-                if (msBuildInstance is null)
-                {
-                    msBuildPath = null;
-                    return false;
-                }
-
-                msBuildPath = Path.EndsInDirectorySeparator(msBuildInstance.MSBuildPath)
-                    ? msBuildInstance.MSBuildPath
-                    : msBuildInstance.MSBuildPath + Path.DirectorySeparatorChar;
-
-                Build.Locator.MSBuildLocator.RegisterMSBuildPath(msBuildPath);
-                return true;
-            }
-            catch
-            {
-                msBuildPath = null;
-                return false;
-            }
-        }
-
         internal static string GetRuntimeVersion()
         {
             var pathParts = typeof(string).Assembly.Location.Split('\\', '/');

src/BuiltInTools/dotnet-format/dotnet-format.csproj

@@ -30,10 +30,6 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Build" ExcludeAssets="Runtime" PrivateAssets="All" />
-    <PackageReference Include="Microsoft.Build.Framework" ExcludeAssets="Runtime" PrivateAssets="All" />
-    <PackageReference Include="Microsoft.Build.Locator" />
-
     <PackageReference Include="Microsoft.CodeAnalysis" />
     <PackageReference Include="Microsoft.CodeAnalysis.CSharp" />
     <PackageReference Include="Microsoft.CodeAnalysis.VisualBasic" />

test/dotnet-format.UnitTests/Analyzers/ThirdPartyAnalyzerFormatterTests.cs

@@ -37,8 +37,6 @@ public async Task InitializeAsync()
 
                 // Load the analyzer_project into a MSBuildWorkspace.
                 var workspacePath = Path.Combine(TestProjectsPathHelper.GetProjectsDirectory(), s_analyzerProjectFilePath);
-
-                MSBuildRegistrar.RegisterInstance();
                 var analyzerWorkspace = await MSBuildWorkspaceLoader.LoadAsync(workspacePath, WorkspaceType.Project, binaryLogPath: null, logWorkspaceWarnings: true, logger, CancellationToken.None);
 
                 TestOutputHelper.WriteLine(logger.GetLog());

test/dotnet-format.UnitTests/CodeFormatterTests.cs

@@ -660,9 +660,6 @@ internal async Task<string> TestFormatWorkspaceAsync(
             }
 
             var logger = new TestLogger();
-            var msBuildPath = MSBuildRegistrar.RegisterInstance();
-
-            logger.LogTrace(Resources.Using_msbuildexe_located_in_0, msBuildPath);
 
             var fileMatcher = SourceFileMatcher.CreateMatcher(include, exclude);
             var formatOptions = new FormatOptions(

test/dotnet-format.UnitTests/MSBuild/MSBuildWorkspaceLoaderTests.cs

@@ -133,7 +133,6 @@ private static async Task AssertProjectLoadsCleanlyAsync(string projectFilePath,
         {
             var binaryLogPath = Path.ChangeExtension(projectFilePath, ".binlog");
 
-            MSBuildRegistrar.RegisterInstance();
             using var workspace = (MSBuildWorkspace)await MSBuildWorkspaceLoader.LoadAsync(projectFilePath, WorkspaceType.Project, binaryLogPath, logWorkspaceWarnings: true, logger, CancellationToken.None);
 
             Assert.Empty(workspace.Diagnostics);