Add option to configure the style of the choices list and the default value in TextPrompt (#681)

* Allow setting the style of the default value in TextPrompt

Add property "DefaultValueStyle" to TextPrompt which allows setting the style in which the default value is rendered.
When no style is set, the value is displayed as green text, keeping the existing behavior.

* Allow setting the style in which a TextPrompt's choices are displayed

Add property "ChoicesStyle" to TextPrompt which allows setting the style in the prompt's choices are rendered.
When no style is set, choices are displayed as blue text, keeping the existing behavior.
This commit is contained in:
Andreas Grünwald 2022-03-27 19:38:01 +02:00 committed by GitHub
parent 7998ece6b6
commit 38d9386e00
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 158 additions and 2 deletions

View File

@ -63,6 +63,16 @@ public sealed class TextPrompt<T> : IPrompt<T>
/// </summary>
public Func<T, ValidationResult>? Validator { get; set; }
/// <summary>
/// Gets or sets the style in which the default value is displayed.
/// </summary>
public Style? DefaultValueStyle { get; set; }
/// <summary>
/// Gets or sets the style in which the list of choices is displayed.
/// </summary>
public Style? ChoicesStyle { get; set; }
/// <summary>
/// Gets or sets the default value.
/// </summary>
@ -183,16 +193,20 @@ public sealed class TextPrompt<T> : IPrompt<T>
appendSuffix = true;
var converter = Converter ?? TypeConverterHelper.ConvertToString;
var choices = string.Join("/", Choices.Select(choice => converter(choice)));
builder.AppendFormat(CultureInfo.InvariantCulture, " [blue][[{0}]][/]", choices);
var choicesStyle = ChoicesStyle?.ToMarkup() ?? "blue";
builder.AppendFormat(CultureInfo.InvariantCulture, " [{0}][[{1}]][/]", choicesStyle, choices);
}
if (ShowDefaultValue && DefaultValue != null)
{
appendSuffix = true;
var converter = Converter ?? TypeConverterHelper.ConvertToString;
var defaultValueStyle = DefaultValueStyle?.ToMarkup() ?? "green";
builder.AppendFormat(
CultureInfo.InvariantCulture,
" [green]({0})[/]",
" [{0}]({1})[/]",
defaultValueStyle,
IsSecret ? "******" : converter(DefaultValue.Value));
}

View File

@ -305,4 +305,50 @@ public static class TextPromptExtensions
obj.Converter = displaySelector;
return obj;
}
/// <summary>
/// Sets the style in which the default value is displayed.
/// </summary>
/// <typeparam name="T">The prompt result type.</typeparam>
/// <param name="obj">The prompt.</param>
/// <param name="style">The default value style.</param>
/// <returns>The same instance so that multiple calls can be chained.</returns>
public static TextPrompt<T> DefaultValueStyle<T>(this TextPrompt<T> obj, Style style)
{
if (obj is null)
{
throw new ArgumentNullException(nameof(obj));
}
if (style is null)
{
throw new ArgumentNullException(nameof(style));
}
obj.DefaultValueStyle = style;
return obj;
}
/// <summary>
/// Sets the style in which the list of choices is displayed.
/// </summary>
/// <typeparam name="T">The prompt result type.</typeparam>
/// <param name="obj">The prompt.</param>
/// <param name="style">The style to use for displaying the choices.</param>
/// <returns>The same instance so that multiple calls can be chained.</returns>
public static TextPrompt<T> ChoicesStyle<T>(this TextPrompt<T> obj, Style style)
{
if (obj is null)
{
throw new ArgumentNullException(nameof(obj));
}
if (style is null)
{
throw new ArgumentNullException(nameof(style));
}
obj.ChoicesStyle = style;
return obj;
}
}

View File

@ -0,0 +1 @@
Enter Value: [Choice 1/Choice 2]: Choice 2

View File

@ -0,0 +1 @@
Enter Value: [Choice 1/Choice 2]: Choice 2

View File

@ -0,0 +1 @@
Enter Value: (default): Input

View File

@ -0,0 +1 @@
Enter Value: (default): Input

View File

@ -241,4 +241,96 @@ public sealed class TextPromptTests
// Then
return Verifier.Verify(console.Output);
}
[Fact]
[Expectation("DefaultValueStyleNotSet")]
public Task Uses_default_style_for_default_value_if_no_style_is_set()
{
// Given
var console = new TestConsole
{
EmitAnsiSequences = true,
};
console.Input.PushTextWithEnter("Input");
var prompt = new TextPrompt<string>("Enter Value:")
.ShowDefaultValue()
.DefaultValue("default");
// When
console.Prompt(prompt);
// Then
return Verifier.Verify(console.Output);
}
[Fact]
[Expectation("DefaultValueStyleSet")]
public Task Uses_specified_default_value_style()
{
// Given
var console = new TestConsole
{
EmitAnsiSequences = true,
};
console.Input.PushTextWithEnter("Input");
var prompt = new TextPrompt<string>("Enter Value:")
.ShowDefaultValue()
.DefaultValue("default")
.DefaultValueStyle(new Style(foreground: Color.Red));
// When
console.Prompt(prompt);
// Then
return Verifier.Verify(console.Output);
}
[Fact]
[Expectation("ChoicesStyleNotSet")]
public Task Uses_default_style_for_choices_if_no_style_is_set()
{
// Given
var console = new TestConsole
{
EmitAnsiSequences = true,
};
console.Input.PushTextWithEnter("Choice 2");
var prompt = new TextPrompt<string>("Enter Value:")
.ShowChoices()
.AddChoice("Choice 1")
.AddChoice("Choice 2");
// When
console.Prompt(prompt);
// Then
return Verifier.Verify(console.Output);
}
[Fact]
[Expectation("ChoicesStyleSet")]
public Task Uses_the_specified_choices_style()
{
// Given
var console = new TestConsole
{
EmitAnsiSequences = true,
};
console.Input.PushTextWithEnter("Choice 2");
var prompt = new TextPrompt<string>("Enter Value:")
.ShowChoices()
.AddChoice("Choice 1")
.AddChoice("Choice 2")
.ChoicesStyle(new Style(foreground: Color.Red));
// When
console.Prompt(prompt);
// Then
return Verifier.Verify(console.Output);
}
}