[I]AnsiConsole: add async overloads for Prompt/Ask/Confirm.

spectreconsole · Mar 9, 2023 · cba299e · cba299e
1 parent a6af9a6
commit cba299e
Show file tree

Hide file tree

Showing 2 changed files with 128 additions and 0 deletions.
diff --git a/src/Spectre.Console/AnsiConsole.Prompt.cs b/src/Spectre.Console/AnsiConsole.Prompt.cs
@@ -1,3 +1,5 @@
+using System.Threading.Tasks;
+
 namespace Spectre.Console;
 
 /// <summary>
@@ -60,4 +62,64 @@ public static bool Confirm(string prompt, bool defaultValue = true)
         }
         .Show(Console);
     }
+
+    /// <summary>
+    /// Displays a prompt to the user.
+    /// </summary>
+    /// <typeparam name="T">The prompt result type.</typeparam>
+    /// <param name="prompt">The prompt to display.</param>
+    /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
+    /// <returns>The prompt input result.</returns>
+    public static Task<T> PromptAsync<T>(IPrompt<T> prompt, CancellationToken cancellationToken = default)
+    {
+        if (prompt is null)
+        {
+            throw new ArgumentNullException(nameof(prompt));
+        }
+
+        return prompt.ShowAsync(Console, cancellationToken);
+    }
+
+    /// <summary>
+    /// Displays a prompt to the user.
+    /// </summary>
+    /// <typeparam name="T">The prompt result type.</typeparam>
+    /// <param name="prompt">The prompt markup text.</param>
+    /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
+    /// <returns>The prompt input result.</returns>
+    public static Task<T> AskAsync<T>(string prompt, CancellationToken cancellationToken = default)
+    {
+        return new TextPrompt<T>(prompt).ShowAsync(Console, cancellationToken);
+    }
+
+    /// <summary>
+    /// Displays a prompt to the user with a given default.
+    /// </summary>
+    /// <typeparam name="T">The prompt result type.</typeparam>
+    /// <param name="prompt">The prompt markup text.</param>
+    /// <param name="defaultValue">The default value.</param>
+    /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
+    /// <returns>The prompt input result.</returns>
+    public static Task<T> AskAsync<T>(string prompt, T defaultValue, CancellationToken cancellationToken = default)
+    {
+        return new TextPrompt<T>(prompt)
+            .DefaultValue(defaultValue)
+            .ShowAsync(Console, cancellationToken);
+    }
+
+    /// <summary>
+    /// Displays a prompt with two choices, yes or no.
+    /// </summary>
+    /// <param name="prompt">The prompt markup text.</param>
+    /// <param name="defaultValue">Specifies the default answer.</param>
+    /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
+    /// <returns><c>true</c> if the user selected "yes", otherwise <c>false</c>.</returns>
+    public static Task<bool> ConfirmAsync(string prompt, bool defaultValue = true, CancellationToken cancellationToken = default)
+    {
+        return new ConfirmationPrompt(prompt)
+        {
+            DefaultValue = defaultValue,
+        }
+        .ShowAsync(Console, cancellationToken);
+    }
 }
diff --git a/src/Spectre.Console/Extensions/AnsiConsoleExtensions.Prompt.cs b/src/Spectre.Console/Extensions/AnsiConsoleExtensions.Prompt.cs
@@ -1,3 +1,5 @@
+using System.Threading.Tasks;
+
 namespace Spectre.Console;
 
 /// <summary>
@@ -64,4 +66,68 @@ public static bool Confirm(this IAnsiConsole console, string prompt, bool defaul
         }
         .Show(console);
     }
+
+    /// <summary>
+    /// Displays a prompt to the user.
+    /// </summary>
+    /// <typeparam name="T">The prompt result type.</typeparam>
+    /// <param name="console">The console.</param>
+    /// <param name="prompt">The prompt to display.</param>
+    /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
+    /// <returns>The prompt input result.</returns>
+    public static Task<T> PromptAsync<T>(this IAnsiConsole console, IPrompt<T> prompt, CancellationToken cancellationToken = default)
+    {
+        if (prompt is null)
+        {
+            throw new ArgumentNullException(nameof(prompt));
+        }
+
+        return prompt.ShowAsync(console, cancellationToken);
+    }
+
+    /// <summary>
+    /// Displays a prompt to the user.
+    /// </summary>
+    /// <typeparam name="T">The prompt result type.</typeparam>
+    /// <param name="console">The console.</param>
+    /// <param name="prompt">The prompt markup text.</param>
+    /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
+    /// <returns>The prompt input result.</returns>
+    public static Task<T> AskAsync<T>(this IAnsiConsole console, string prompt, CancellationToken cancellationToken = default)
+    {
+        return new TextPrompt<T>(prompt).ShowAsync(console, cancellationToken);
+    }
+
+    /// <summary>
+    /// Displays a prompt to the user.
+    /// </summary>
+    /// <typeparam name="T">The prompt result type.</typeparam>
+    /// <param name="console">The console.</param>
+    /// <param name="prompt">The prompt markup text.</param>
+    /// <param name="culture">Specific CultureInfo to use when converting input.</param>
+    /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
+    /// <returns>The prompt input result.</returns>
+    public static Task<T> AskAsync<T>(this IAnsiConsole console, string prompt, CultureInfo? culture, CancellationToken cancellationToken = default)
+    {
+        var textPrompt = new TextPrompt<T>(prompt);
+        textPrompt.Culture = culture;
+        return textPrompt.ShowAsync(console, cancellationToken);
+    }
+
+    /// <summary>
+    /// Displays a prompt with two choices, yes or no.
+    /// </summary>
+    /// <param name="console">The console.</param>
+    /// <param name="prompt">The prompt markup text.</param>
+    /// <param name="defaultValue">Specifies the default answer.</param>
+    /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
+    /// <returns><c>true</c> if the user selected "yes", otherwise <c>false</c>.</returns>
+    public static Task<bool> ConfirmAsync(this IAnsiConsole console, string prompt, bool defaultValue = true, CancellationToken cancellationToken = default)
+    {
+        return new ConfirmationPrompt(prompt)
+        {
+            DefaultValue = defaultValue,
+        }
+        .ShowAsync(console, cancellationToken);
+    }
 }