Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change help structure in dotnet test #47288

Merged
merged 11 commits into from
Mar 6, 2025
Merged

Change help structure in dotnet test #47288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
2d8224f
Change help structure
mariam-abdulla Mar 5, 2025
a57b202
Undo comment change in TerminalTestReporter
mariam-abdulla Mar 5, 2025
f4253d5
Update src/Cli/dotnet/commands/dotnet-test/Terminal/TerminalTestRepor…
mariam-abdulla Mar 5, 2025
82d2102
Fix not cancelling when writing the help option
mariam-abdulla Mar 6, 2025
7e699ff
Merge branch 'dev/mabdullah/change-help-option-structure-in-dotnet-te…
mariam-abdulla Mar 6, 2025
22db669
Undo some comment
mariam-abdulla Mar 6, 2025
0c884b4
Remove aborted word when cancelling
mariam-abdulla Mar 6, 2025
c33e500
Merge branch 'main' into dev/mabdullah/change-help-option-structure-i…
mariam-abdulla Mar 6, 2025
2696f43
Undo comment
mariam-abdulla Mar 6, 2025
71cbe04
Merge branch 'dev/mabdullah/change-help-option-structure-in-dotnet-te…
mariam-abdulla Mar 6, 2025
2b9ce13
remove debugger.launch
mariam-abdulla Mar 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 47 additions & 1 deletion src/Cli/dotnet/commands/dotnet-test/Terminal/TerminalTestReporter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

using System.Collections.Concurrent;
using System.CommandLine.Help;
using System.Globalization;
using System.Text.RegularExpressions;
using Microsoft.DotNet.Cli;
using Microsoft.Testing.Platform.Helpers;
using LocalizableStrings = Microsoft.DotNet.Tools.Test.LocalizableStrings;

Expand Down Expand Up @@ -1037,7 +1039,51 @@ public void TestInProgress(
_terminalWithProgress.UpdateWorker(asm.SlotIndex);
}

public void WriteHeading(string? heading, string? description)
public void WritePlatformAndExtensionOptions(HelpContext context,
IEnumerable<CommandLineOption> builtInOptions,
IEnumerable<CommandLineOption> nonBuiltInOptions,
Dictionary<bool, List<(string[], string[])>> moduleToMissingOptions)
{
if (_wasCancelled)
{
return;
}

if (builtInOptions.Any())
{
WriteOtherOptionsSection(context, LocalizableStrings.HelpPlatformOptions, builtInOptions);
context.Output.WriteLine();
}

if (nonBuiltInOptions.Any())
{
WriteOtherOptionsSection(context, LocalizableStrings.HelpExtensionOptions, nonBuiltInOptions);
context.Output.WriteLine();
}
WriteModulesToMissingOptionsToConsole(moduleToMissingOptions);
}

private void WriteOtherOptionsSection(HelpContext context, string title, IEnumerable<CommandLineOption> options)
{
List<TwoColumnHelpRow> optionRows = [];

foreach (var option in options)
{
if (option.IsHidden != true)
{
optionRows.Add(new TwoColumnHelpRow($"--{option.Name}", option.Description));
}
}

if (optionRows.Count > 0)
{
WriteHeading(title, null);
context.HelpBuilder.WriteColumns(optionRows, context);
}
}


private void WriteHeading(string? heading, string? description)
{
if (!string.IsNullOrWhiteSpace(heading))
{
Expand Down
53 changes: 8 additions & 45 deletions src/Cli/dotnet/commands/dotnet-test/TestingPlatformCommand.Help.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ public IEnumerable<Action<HelpContext>> CustomHelpLayout()
{
yield return (context) =>
{
WriteHelpOptions(context);
Console.WriteLine(LocalizableStrings.HelpWaitingForOptionsAndExtensions);

Run(context.ParseResult);
Expand All @@ -27,43 +28,24 @@ public IEnumerable<Action<HelpContext>> CustomHelpLayout()
return;
}

WriteCustomHelp(context);
};
}
Dictionary<bool, List<CommandLineOption>> allOptions = GetAllOptions();
allOptions.TryGetValue(true, out List<CommandLineOption> builtInOptions);
allOptions.TryGetValue(false, out List<CommandLineOption> nonBuiltInOptions);

private void WriteCustomHelp(HelpContext context)
{
var allOptions = GetAllOptions();
var builtInOptions = GetOptionNames(allOptions, isBuiltIn: true);
var nonBuiltInOptions = GetOptionNames(allOptions, isBuiltIn: false);
var moduleToMissingOptions = GetModulesToMissingOptions(_moduleNamesToCommandLineOptions, builtInOptions, nonBuiltInOptions);
Dictionary<bool, List<(string[], string[])>> moduleToMissingOptions = GetModulesToMissingOptions(_moduleNamesToCommandLineOptions, builtInOptions.Select(option => option.Name), nonBuiltInOptions.Select(option => option.Name));

WriteHelpSections(context, allOptions, moduleToMissingOptions);
_output.WritePlatformAndExtensionOptions(context, builtInOptions, nonBuiltInOptions, moduleToMissingOptions);
};
}

private static IEnumerable<string> GetOptionNames(Dictionary<bool, List<CommandLineOption>> allOptions, bool isBuiltIn) => allOptions.TryGetValue(isBuiltIn, out var options) ? options.Select(option => option.Name) : [];

private void WriteHelpSections(HelpContext context, Dictionary<bool, List<CommandLineOption>> allOptions, Dictionary<bool, List<(string[], string[])>> moduleToMissingOptions)
private void WriteHelpOptions(HelpContext context)
{
HelpBuilder.Default.SynopsisSection()(context);
context.Output.WriteLine();
WriteUsageSection(context);
context.Output.WriteLine();
HelpBuilder.Default.OptionsSection()(context);
context.Output.WriteLine();

if (allOptions.TryGetValue(true, out var builtInOptions) && builtInOptions.Count > 0)
{
WriteOtherOptionsSection(context, LocalizableStrings.HelpPlatformOptions, builtInOptions);
context.Output.WriteLine();
}

if (allOptions.TryGetValue(false, out var extensionOptions) && extensionOptions.Count > 0)
{
WriteOtherOptionsSection(context, LocalizableStrings.HelpExtensionOptions, extensionOptions);
context.Output.WriteLine();
}
_output.WriteModulesToMissingOptionsToConsole(moduleToMissingOptions);
}

private static void WriteUsageSection(HelpContext context)
Expand Down Expand Up @@ -109,25 +91,6 @@ private static string FormatHelpOption(string option)
return $"[{option.Trim(':').ToLower()}]";
}

private void WriteOtherOptionsSection(HelpContext context, string title, List<CommandLineOption> options)
{
List<TwoColumnHelpRow> optionRows = [];

foreach (var option in options)
{
if ((bool)!option.IsHidden)
{
optionRows.Add(new TwoColumnHelpRow($"--{option.Name}", option.Description));
}
}

if (optionRows.Count > 0)
{
_output.WriteHeading(title, null);
context.HelpBuilder.WriteColumns(optionRows, context);
}
}

private void OnHelpRequested(object sender, HelpEventArgs args)
{
CommandLineOption[] commandLineOptionMessages = args.CommandLineOptions;
Expand Down