Add why and config commands to dotnet nuget help (#5931)

* Add commands Why and Config to dotnet nuget help
NuGet · Jul 26, 2024 · 5485ea6 · 5485ea6
1 parent 46f80a3
commit 5485ea6
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 1 deletion.
diff --git a/src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/ConfigCommands/ConfigCommand.cs b/src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/ConfigCommands/ConfigCommand.cs
@@ -7,6 +7,7 @@
 using System.CommandLine.Parsing;
 using System.Linq;
 using System.Threading.Tasks;
+using Microsoft.Extensions.CommandLineUtils;
 using NuGet.Common;
 
 namespace NuGet.CommandLine.XPlat
@@ -84,6 +85,14 @@ internal static void ShowHelp(ParseResult parseResult, CliCommand cmd)
             cmd.Parse(tokenList).Invoke();
         }
 
+        internal static void Register(CommandLineApplication app)
+        {
+            app.Command("config", configCmd =>
+            {
+                configCmd.Description = Strings.Config_Description;
+            });
+        }
+
         internal static CliCommand Register(CliCommand app, Func<ILogger> getLogger)
         {
             var ConfigCmd = new CliCommand(name: "config", description: Strings.Config_Description);

diff --git a/src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/WhyCommand/WhyCommand.cs b/src/NuGet.Core/NuGet.CommandLine.XPlat/Commands/WhyCommand/WhyCommand.cs
@@ -5,6 +5,7 @@
 using System.Collections.Generic;
 using System.CommandLine;
 using System.CommandLine.Help;
+using Microsoft.Extensions.CommandLineUtils;
 
 namespace NuGet.CommandLine.XPlat
 {
@@ -33,6 +34,14 @@ internal static class WhyCommand
             Arity = ArgumentArity.Zero
         };
 
+        internal static void Register(CommandLineApplication app)
+        {
+            app.Command("why", whyCmd =>
+            {
+                whyCmd.Description = Strings.WhyCommand_Description;
+            });
+        }
+
         internal static void Register(CliCommand rootCommand, Func<ILoggerWithColor> getLogger)
         {
             var whyCommand = new CliCommand("why", Strings.WhyCommand_Description);

diff --git a/src/NuGet.Core/NuGet.CommandLine.XPlat/Program.cs b/src/NuGet.Core/NuGet.CommandLine.XPlat/Program.cs
@@ -6,7 +6,6 @@
 using System.Diagnostics;
 using System.Globalization;
 using System.Linq;
-using System.Reflection;
 using Microsoft.Extensions.CommandLineUtils;
 using NuGet.Commands;
 using NuGet.Common;
@@ -276,6 +275,9 @@ private static CommandLineApplication InitializeApp(string[] args, CommandOutput
                 VerifyCommand.Register(app, getHidePrefixLogger, setLogLevel, () => new VerifyCommandRunner());
                 TrustedSignersCommand.Register(app, getHidePrefixLogger, setLogLevel);
                 SignCommand.Register(app, getHidePrefixLogger, setLogLevel, () => new SignCommandRunner());
+                // The commands below are implemented with System.CommandLine, and are here only for `dotnet nuget --help`
+                ConfigCommand.Register(app);
+                WhyCommand.Register(app);
             }
 
             app.FullName = Strings.App_FullName;

diff --git a/test/NuGet.Core.FuncTests/NuGet.XPlat.FuncTest/XPlatHelpOutputTests.cs b/test/NuGet.Core.FuncTests/NuGet.XPlat.FuncTest/XPlatHelpOutputTests.cs
@@ -8,6 +8,7 @@
 using NuGet.CommandLine.XPlat;
 using Xunit;
 using Xunit.Abstractions;
+using System.Text.RegularExpressions;
 
 namespace NuGet.XPlat.FuncTest
 {
@@ -43,6 +44,24 @@ public static IEnumerable<object[]> FailParsing
             }
         }
 
+        public static IEnumerable<string> HelpCommands => new List<string>
+        {
+            "add",
+            "config",
+            "delete",
+            "disable",
+            "enable",
+            "list",
+            "locals",
+            "push",
+            "remove",
+            "sign",
+            "trust",
+            "update",
+            "verify",
+            "why"
+        };
+
         [Theory]
         [MemberData(nameof(FailParsing))]
         public void MainInternal_OnParsingError_ShowsHelp(string[] args)
@@ -82,5 +101,28 @@ public void MainInternal_OnParsingSuccess_DoesNotShowsHelp(string[] args)
             Assert.DoesNotContain("Usage", output);
             Assert.Equal(1, exitCode);
         }
+
+        [Fact]
+        public void MainInternal_ShowsHelp()
+        {
+            // Arrange
+            var originalConsoleOut = Console.Out;
+            using var consoleOutput = new StringWriter();
+            Console.SetOut(consoleOutput);
+            var log = new TestCommandOutputLogger(_testOutputHelper);
+
+            // Act
+            var exitCode = Program.MainInternal(Array.Empty<string>(), log);
+            Console.SetOut(originalConsoleOut);
+
+            // Assert
+            var output = consoleOutput.ToString();
+
+            var commandPattern = @"^\s{2}(\w+)\s{2,}"; // Matches lines starting with two spaces, a word (command), followed by at least two spaces
+            IEnumerable<string> matches = Regex.Matches(output, commandPattern, RegexOptions.Multiline).Select(m => m.ToString().Trim());
+
+            Assert.Equal(HelpCommands, matches);
+            Assert.Equal(0, exitCode);
+        }
     }
 }