Skip to content

add option OrderCommandsByNameInHelpText #148

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

Merged
natemcmaster merged 3 commits into from
Oct 2, 2018
Merged

add option OrderCommandsByNameInHelpText #148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
05d878a
add option OrderCommandsByNameInHelpText
lvermeulen Sep 5, 2018
f8a8cba
move OrderCommandsByNameInHelpText to DefaultHelpTextGenerator
lvermeulen Sep 28, 2018
26c4a60
rename OrderCommandsByNameInHelpText to SortCommandsByName
lvermeulen Oct 1, 2018
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
10 changes: 9 additions & 1 deletion src/CommandLineUtils/HelpText/DefaultHelpTextGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@ public class DefaultHelpTextGenerator : IHelpTextGenerator
/// </summary>
protected DefaultHelpTextGenerator() { }

/// <summary>
/// Determines if commands are ordered by name in generated help text
/// </summary>
public bool SortCommandsByName { get; set; } = true;

/// <inheritdoc />
public virtual void Generate(CommandLineApplication application, TextWriter output)
{
Expand Down Expand Up @@ -215,7 +220,10 @@ protected virtual void GenerateCommands(

var newLineWithMessagePadding = Environment.NewLine + new string(' ', firstColumnWidth + 2);

foreach (var cmd in visibleCommands.OrderBy(c => c.Name))
var orderedCommands = SortCommandsByName
? visibleCommands.OrderBy(c => c.Name).ToList()
: visibleCommands;
foreach (var cmd in orderedCommands)
{
var message = string.Format(outputFormat, cmd.Name, cmd.Description);
message = message.Replace(Environment.NewLine, newLineWithMessagePadding);
Expand Down
36 changes: 36 additions & 0 deletions test/CommandLineUtils.Tests/DefaultHelpTextGeneratorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// Copyright (c) Nate McMaster.
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.

using System;
using System.IO;
using System.Text;
using McMaster.Extensions.CommandLineUtils.HelpText;
Expand Down Expand Up @@ -37,5 +38,40 @@ public void ItListOptions()
Assert.Contains("--option <OPTION>", helpText);
Assert.DoesNotContain("-|--option <OPTION>", helpText);
}

[Fact]
public void OrderCommandsByName()
{
var app = new CommandLineApplication<EmptyShortName>();
app.Conventions.UseDefaultConventions();
app.Command("b", null);
app.Command("a", null);
var sb = new StringBuilder();
DefaultHelpTextGenerator.Singleton.Generate(app, new StringWriter(sb));
var helpText = sb.ToString();
_output.WriteLine(helpText);

int indexOfA = helpText.IndexOf(" a", StringComparison.InvariantCulture);
int indexOfB = helpText.IndexOf(" b", StringComparison.InvariantCulture);
Assert.True(indexOfA < indexOfB);
}

[Fact]
public void DontOrderCommandsByName()
{
DefaultHelpTextGenerator.Singleton.SortCommandsByName = false;
var app = new CommandLineApplication<EmptyShortName>();
app.Conventions.UseDefaultConventions();
app.Command("b", null);
app.Command("a", null);
var sb = new StringBuilder();
DefaultHelpTextGenerator.Singleton.Generate(app, new StringWriter(sb));
var helpText = sb.ToString();
_output.WriteLine(helpText);

int indexOfA = helpText.IndexOf(" a", StringComparison.InvariantCulture);
int indexOfB = helpText.IndexOf(" b", StringComparison.InvariantCulture);
Assert.True(indexOfA > indexOfB);
}
}
}