Lazy initialize Spectre.Console in XPlat command registration (#7063)

Author: zivkan

src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/Why/WhyCommand.cs

@@ -25,7 +25,7 @@ internal static void Register(CommandLineApplication app)
             });
         }
 
-        internal static void Register(Command rootCommand, IAnsiConsole console)
+        internal static void Register(Command rootCommand, Lazy<IAnsiConsole> console)
         {
             Register(rootCommand, console, WhyCommandRunner.ExecuteCommand);
         }
@@ -38,11 +38,13 @@ internal static void Register(Command rootCommand, IAnsiConsole console)
         public static void GetWhyCommand(Command rootCommand)
         {
             Register(rootCommand,
-                Spectre.Console.AnsiConsole.Console,
+                new Lazy<IAnsiConsole>(() => Spectre.Console.AnsiConsole.Console),
                 WhyCommandRunner.ExecuteCommand);
         }
 
-        internal static void Register(Command rootCommand, IAnsiConsole console, Func<WhyCommandArgs, Task<int>> action)
+        // console must be lazy, because Spectre.Console's AnsiConsole will send VT sequences to the output
+        // as soon as it's created, which causes problems with the dotnet CLI's C++ output, like dotnet --info
+        internal static void Register(Command rootCommand, Lazy<IAnsiConsole> console, Func<WhyCommandArgs, Task<int>> action)
         {
             var whyCommand = new DocumentedCommand("why", Strings.WhyCommand_Description, "https://aka.ms/dotnet/nuget/why");
 
@@ -111,15 +113,15 @@ bool HasPathArgument(ArgumentResult ar)
                         parseResult.GetValue(path)!,
                         parseResult.GetValue(package)!,
                         parseResult.GetValue(frameworks)!,
-                        console,
+                        console.Value,
                         cancellationToken);
 
                     int exitCode = await action(whyCommandArgs);
                     return exitCode;
                 }
                 catch (ArgumentException ex)
                 {
-                    console.Markup($"[red]{ex.Message}[/]");
+                    console.Value.Markup($"[red]{ex.Message}[/]");
                     return ExitCodes.InvalidArguments;
                 }
             });

src/NuGet.Core/NuGet.CommandLine.XPlat/Program.cs

@@ -115,10 +115,12 @@ public static int MainInternal(string[] args, CommandOutputLogger log, IEnvironm
                     var nugetCommand = new Command("nuget");
                     rootCommand.Subcommands.Add(nugetCommand);
 
+                    var lazyConsole = new Lazy<Spectre.Console.IAnsiConsole>(() => Spectre.Console.AnsiConsole.Console);
+
                     ConfigCommand.Register(nugetCommand, getHidePrefixLogger);
                     ConfigCommand.Register(rootCommand, getHidePrefixLogger);
-                    Commands.Why.WhyCommand.Register(nugetCommand, Spectre.Console.AnsiConsole.Console);
-                    Commands.Why.WhyCommand.Register(rootCommand, Spectre.Console.AnsiConsole.Console);
+                    Commands.Why.WhyCommand.Register(nugetCommand, lazyConsole);
+                    Commands.Why.WhyCommand.Register(rootCommand, lazyConsole);
                 }
 
                 CancellationTokenSource tokenSource = new CancellationTokenSource();

test/NuGet.Core.Tests/NuGet.CommandLine.Xplat.Tests/Commands/Why/WhyCommandLineParsingTests.cs

@@ -7,6 +7,7 @@
 using FluentAssertions;
 using NuGet.CommandLine.XPlat.Commands;
 using NuGet.CommandLine.XPlat.Commands.Why;
+using Spectre.Console;
 using Spectre.Console.Testing;
 using Xunit;
 
@@ -19,9 +20,10 @@ public void WhyCommand_HasHelpUrl()
         {
             // Arrange
             Command rootCommand = new("nuget");
+            var console = new Lazy<IAnsiConsole>(() => new TestConsole());
 
             // Act
-            WhyCommand.Register(rootCommand, new TestConsole());
+            WhyCommand.Register(rootCommand, console);
 
             // Assert
             rootCommand.Subcommands[0].Should().BeAssignableTo<DocumentedCommand>();
@@ -33,8 +35,10 @@ public void WithTwoArguments_PathAndPackageAreSet()
         {
             // Arrange
             Command rootCommand = new("nuget");
+            var console = new Lazy<IAnsiConsole>(() => new TestConsole());
 
-            WhyCommand.Register(rootCommand, new TestConsole(), whyCommandArgs =>
+
+            WhyCommand.Register(rootCommand, console, whyCommandArgs =>
             {
                 // Assert
                 whyCommandArgs.Path.Should().Be(@"path\to\my.proj");
@@ -54,8 +58,9 @@ public void WithOneArguments_PackageIsSet()
         {
             // Arrange
             Command rootCommand = new("nuget");
+            var console = new Lazy<IAnsiConsole>(() => new TestConsole());
 
-            WhyCommand.Register(rootCommand, new TestConsole(), whyCommandArgs =>
+            WhyCommand.Register(rootCommand, console, whyCommandArgs =>
             {
                 // Assert
                 whyCommandArgs.Path.Should().NotBeNull();
@@ -75,8 +80,9 @@ public void WithZeroArguments_HasParseError()
         {
             // Arrange
             Command rootCommand = new("nuget");
+            var console = new Lazy<IAnsiConsole>(() => new TestConsole());
 
-            WhyCommand.Register(rootCommand, new TestConsole(), whyCommandArgs =>
+            WhyCommand.Register(rootCommand, console, whyCommandArgs =>
             {
                 // Assert
                 throw new Exception("Should not get here");
@@ -92,8 +98,9 @@ public void WithThreeArguments_HasParseError()
         {
             // Arrange
             Command rootCommand = new("nuget");
+            var console = new Lazy<IAnsiConsole>(() => new TestConsole());
 
-            WhyCommand.Register(rootCommand, new TestConsole(), whyCommandArgs =>
+            WhyCommand.Register(rootCommand, console, whyCommandArgs =>
             {
                 // Assert
                 throw new Exception("Should not get here");
@@ -112,8 +119,9 @@ public void FrameworkOption_CanBeAtAnyPosition(string args)
         {
             // Arrange
             Command rootCommand = new("nuget");
+            var console = new Lazy<IAnsiConsole>(() => new TestConsole());
 
-            WhyCommand.Register(rootCommand, new TestConsole(), whyCommandArgs =>
+            WhyCommand.Register(rootCommand, console, whyCommandArgs =>
             {
                 // Assert
                 whyCommandArgs.Path.Should().Be("my.proj");
@@ -135,8 +143,9 @@ public void FrameworkOption_CanBeLongOrShortForm(string arg)
         {
             // Arrange
             Command rootCommand = new("nuget");
+            var console = new Lazy<IAnsiConsole>(() => new TestConsole());
 
-            WhyCommand.Register(rootCommand, new TestConsole(), whyCommandArgs =>
+            WhyCommand.Register(rootCommand, console, whyCommandArgs =>
             {
                 // Assert
                 whyCommandArgs.Path.Should().Be("my.proj");
@@ -156,8 +165,9 @@ public void FrameworkOption_AcceptsMultipleValues()
         {
             // Arrange
             Command rootCommand = new("nuget");
+            var console = new Lazy<IAnsiConsole>(() => new TestConsole());
 
-            WhyCommand.Register(rootCommand, new TestConsole(), whyCommandArgs =>
+            WhyCommand.Register(rootCommand, console, whyCommandArgs =>
             {
                 // Assert
                 whyCommandArgs.Path.Should().Be("my.proj");
@@ -177,8 +187,9 @@ public void HelpOption_ShowsHelp()
         {
             // Arrange
             Command rootCommand = new("nuget");
+            var console = new Lazy<IAnsiConsole>(() => new TestConsole());
 
-            WhyCommand.Register(rootCommand, new TestConsole(), whyCommandArgs =>
+            WhyCommand.Register(rootCommand, console, whyCommandArgs =>
             {
                 // Assert
                 whyCommandArgs.Path.Should().Be("my.proj");