Adding a static factory for the TerminalLogger

src/Build.UnitTests/ConsoleLogger_Tests.cs

@@ -134,6 +134,31 @@ public ConsoleLoggerTest(ITestOutputHelper output)
             _output = output;
         }
 
+        [Theory]
+        [InlineData(null, false, false, "", nameof(ConsoleLogger))]
+        [InlineData(null, true, false, "", nameof(ConsoleLogger))]
+        [InlineData(null, false, true, "", nameof(ConsoleLogger))]
+        [InlineData(null, true, true, "off", nameof(ConsoleLogger))]
+        [InlineData("--tl:off", true, true, "", nameof(ConsoleLogger))]
+        [InlineData(null, true, true, "", "TerminalLogger")]
+        public void CreateTerminalOrConsoleLogger_CreatesCorrectLoggerInstance(string argsString, bool supportsAnsi, bool outputIsScreen, string evnVariableValue, string expectedLoggerName)
+        {
+            string originalValue = Environment.GetEnvironmentVariable("MSBUILDTERMINALLOGGER");
+            Environment.SetEnvironmentVariable("MSBUILDTERMINALLOGGER", evnVariableValue);
+
+            try
+            {
+                string[] args = argsString?.Split(' ');
+                ILogger logger = ConsoleLogger.CreateTerminalOrConsoleLogger(default, args, supportsAnsi, outputIsScreen, default);
+
+                logger.ShouldNotBeNull();
+                logger.GetType().Name.ShouldBe(expectedLoggerName);
+            }
+            finally
+            {
+                Environment.SetEnvironmentVariable("MSBUILDTERMINALLOGGER", originalValue);
+            }
+        }
 
         /// <summary>
         /// Verify when the project has not been named that we correctly get the same placeholder

src/Build/Logging/ConsoleLogger.cs

@@ -2,6 +2,10 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using System;
+using System.Diagnostics.CodeAnalysis;
+using System.Linq;
+using System.Reflection;
+using System.Runtime.CompilerServices;
 using Microsoft.Build.BackEnd.Logging;
 using Microsoft.Build.Framework;
 using Microsoft.Build.Framework.Logging;
@@ -328,6 +332,40 @@ protected WriteHandler WriteHandler
 
         #region Methods
 
+        /// <summary>
+        /// Creates a Terminal logger if possible, or a Console logger.
+        /// </summary>
+        /// <param name="verbosity">Level of detail to show in the log.</param>
+        /// <param name="args">Command line arguments for the logger configuration. Currently, only '--tl:off' is supported to disable TerminalLogger.</param>
+        public static ILogger CreateTerminalOrConsoleLogger(LoggerVerbosity verbosity, string[] args)
+        {
+            (bool supportsAnsi, bool outputIsScreen, uint? originalConsoleMode) = NativeMethodsShared.QueryIsScreenAndTryEnableAnsiColorCodes();
+
+            return CreateTerminalOrConsoleLogger(verbosity, args, supportsAnsi, outputIsScreen, originalConsoleMode);
+        }
+
+        internal static ILogger CreateTerminalOrConsoleLogger(LoggerVerbosity verbosity, string[] args, bool supportsAnsi, bool outputIsScreen, uint? originalConsoleMode)
+        {
+            string tlArg = args?.LastOrDefault(a => a.StartsWith("--tl:", StringComparison.InvariantCultureIgnoreCase)) ?? string.Empty;
+
+            bool isDisabled =
+                tlArg.Equals("--tl:off", StringComparison.InvariantCultureIgnoreCase) ||
+                (Environment.GetEnvironmentVariable("MSBUILDTERMINALLOGGER") ?? string.Empty).Equals("off", StringComparison.InvariantCultureIgnoreCase);
+
+            if (isDisabled || !supportsAnsi || !outputIsScreen)
+            {
+                NativeMethodsShared.RestoreConsoleMode(originalConsoleMode);
+                return new ConsoleLogger(verbosity);
+            }
+
+            // TODO: Move TerminalLogger to this project, use InternalsVisibleTo attribute and resolve type conflicts errors caused by shared files.
+            // This logic is tested to ensure that the TerminalLogger is available in the MSBuild assembly and we can create an instance of it.
+            Type tlType = Assembly.Load("MSBuild").GetType("Microsoft.Build.Logging.TerminalLogger.TerminalLogger");
+            ILogger terminalLogger = Activator.CreateInstance(tlType, BindingFlags.Instance | BindingFlags.NonPublic, null, [verbosity, originalConsoleMode], null) as ILogger;
+
+            return terminalLogger;
+        }
+
         /// <summary>
         /// Apply a parameter.
         /// NOTE: This method was public by accident in Whidbey, so it cannot be made internal now. It has

src/MSBuild.UnitTests/Snapshots/TerminalLogger_Tests.PrintBuildSummaryQuietVerbosity_FailedWithErrors.Linux.verified.txt

@@ -1,8 +1,7 @@
-]9;4;3;\directory/file(1,2,3,4): warning AA0000: Warning!
+directory/file(1,2,3,4): warning AA0000: Warning!
 directory/file(1,2,3,4): warning AA0000: 
   A
   Multi
   Line
   Warning!
 directory/file(1,2,3,4): error AA0000: Error!
-]9;4;0;\

src/MSBuild.UnitTests/Snapshots/TerminalLogger_Tests.PrintBuildSummaryQuietVerbosity_FailedWithErrors.Windows.verified.txt

@@ -1,8 +1,7 @@
-]9;4;3;\directory/file(1,2,3,4): warning AA0000: Warning!
+directory/file(1,2,3,4): warning AA0000: Warning!
 directory/file(1,2,3,4): warning AA0000: 
   A
   Multi
   Line
   Warning!
 directory/file(1,2,3,4): error AA0000: Error!
-]9;4;0;\

src/MSBuild.UnitTests/Snapshots/TerminalLogger_Tests.PrintTestSummaryQuietVerbosity_Succeeded.Linux.verified.txt

@@ -1 +1 @@
-]9;4;3;\]9;4;0;\
+emptyString

src/MSBuild.UnitTests/Snapshots/TerminalLogger_Tests.PrintTestSummaryQuietVerbosity_Succeeded.Windows.verified.txt

@@ -1 +1 @@
-]9;4;3;\]9;4;0;\
+emptyString

src/MSBuild/MSBuild.csproj

@@ -136,7 +136,6 @@
     <Compile Include="CommandLineSwitchException.cs" />
     <Compile Include="..\Shared\CoreCLRAssemblyLoader.cs" Condition="'$(TargetFrameworkIdentifier)' != '.NETFramework'" />
     <Compile Include="DistributedLoggerRecord.cs" />
-    <Compile Include="TerminalLogger\*.cs" />
     <Compile Include="InitializationException.cs" />
     <Compile Include="MSBuildClientApp.cs" />
     <Compile Include="NodeEndpointOutOfProcTaskHost.cs" />
@@ -147,6 +146,17 @@
     <Compile Include="OutOfProcTaskAppDomainWrapper.cs" />
     <Compile Include="PerformanceLogEventListener.cs" />
     <Compile Include="JsonOutputFormatter.cs" />
+    <Compile Include="TerminalLogger\BuildMessage.cs" />
+    <Compile Include="TerminalLogger\ITerminal.cs" />
+    <Compile Include="TerminalLogger\MessageSeverity.cs" />
+    <Compile Include="TerminalLogger\NodesFrame.cs" />
+    <Compile Include="TerminalLogger\NodeStatus.cs" />
+    <Compile Include="TerminalLogger\Project.cs" />
+    <Compile Include="TerminalLogger\StopwatchAbstraction.cs" />
+    <Compile Include="TerminalLogger\SystemStopwatch.cs" />
+    <Compile Include="TerminalLogger\Terminal.cs" />
+    <Compile Include="TerminalLogger\TerminalLogger.cs" />
+    <Compile Include="TerminalLogger\TestSummary.cs" />
     <Compile Include="XMake.cs" />
     <!-- This is to enable CodeMarkers in MSBuild.exe -->
     <!-- Win32 RC Files -->

src/MSBuild/TerminalLogger/Project.cs

@@ -18,7 +18,9 @@ internal sealed class Project
     /// <summary>
     /// Initialized a new <see cref="Project"/> with the given <paramref name="targetFramework"/>.
     /// </summary>
+    /// <param name="projectFile">The full path to the project file.</param>
     /// <param name="targetFramework">The target framework of the project or null if not multi-targeting.</param>
+    /// <param name="stopwatch">A stopwatch to time the build of the project.</param>
     public Project(string projectFile, string? targetFramework, StopwatchAbstraction? stopwatch)
     {
         File = projectFile;
@@ -58,7 +60,7 @@ public Project(string projectFile, string? targetFramework, StopwatchAbstraction
     public bool IsTestProject { get; set; }
 
     /// <summary>
-    /// True when the project has run target with name "_CachePluginRunStart" defined in <see cref="TerminalLogger._cachePluginStartTarget"/>.
+    /// True when the project has run target with name "_CachePluginRunStart".
     /// </summary>
     public bool IsCachePluginProject { get; set; }
 

src/MSBuild/TerminalLogger/TerminalLogger.cs

@@ -250,6 +250,15 @@ internal TerminalLogger(ITerminal terminal)
         _manualRefresh = true;
     }
 
+    /// <summary>
+    /// Private constructor invoked by static factory.
+    /// </summary>
+    internal TerminalLogger(LoggerVerbosity verbosity, uint? originalConsoleMode) : this()
+    {
+        Verbosity = verbosity;
+        _originalConsoleMode = originalConsoleMode;
+    }
+
     #region INodeLogger implementation
 
     /// <inheritdoc/>
@@ -270,8 +279,6 @@ public void Initialize(IEventSource eventSource, int nodeCount)
     /// <inheritdoc/>
     public void Initialize(IEventSource eventSource)
     {
-        (_, _, _originalConsoleMode) = NativeMethodsShared.QueryIsScreenAndTryEnableAnsiColorCodes();
-
         ParseParameters();
 
         eventSource.BuildStarted += BuildStarted;
@@ -396,7 +403,7 @@ private void BuildStarted(object sender, BuildStartedEventArgs e)
 
         _buildStartTime = e.Timestamp;
 
-        if (Terminal.SupportsProgressReporting)
+        if (Terminal.SupportsProgressReporting && Verbosity != LoggerVerbosity.Quiet)
         {
             Terminal.Write(AnsiCodes.SetProgressIndeterminate);
         }
@@ -465,7 +472,7 @@ private void BuildFinished(object sender, BuildFinishedEventArgs e)
         }
         finally
         {
-            if (Terminal.SupportsProgressReporting)
+            if (Terminal.SupportsProgressReporting && Verbosity != LoggerVerbosity.Quiet)
             {
                 Terminal.Write(AnsiCodes.RemoveProgress);
             }
@@ -1077,8 +1084,9 @@ private void EraseNodes()
     /// Construct a build result summary string.
     /// </summary>
     /// <param name="succeeded">True if the build completed with success.</param>
-    /// <param name="hasError">True if the build has logged at least one error.</param>
-    /// <param name="hasWarning">True if the build has logged at least one warning.</param>
+    /// <param name="countErrors">The number of errors encountered during the build.</param>
+    /// <param name="countWarnings">The number of warnings encountered during the build.</param>
+    /// <returns>A string representing the build result summary.</returns>
     private static string GetBuildResultString(bool succeeded, int countErrors, int countWarnings)
     {
         if (!succeeded)

src/MSBuild/XMake.cs

@@ -4019,7 +4019,6 @@ private static void ProcessTerminalLogger(bool noConsoleLogger,
         {
             if (!noConsoleLogger)
             {
-                // A central logger will be created for both single proc and multiproc.
                 TerminalLogger logger = new TerminalLogger(verbosity)
                 {
                     Parameters = aggregatedLoggerParameters