Sharprompt

Sharprompt 项目介绍

Sharprompt 是一个用于构建互动式命令行应用的框架，专为 C# 开发者设计。它通过简单且功能丰富的命令行接口，帮助开发者轻松地创建用户交互系统。这个项目在支持多平台操作的同时，还包含丰富的特性和灵活的配置选项。

特性

• 跨平台支持：Sharprompt 支持多种操作系统，包括 Windows、Linux 和 macOS。
• 多种提示类型：提供多种流行的提示类型，如 Input、Password、Select 等。
• 模型驱动的提示：支持基于模型的提示系统，便于与用户交互。
• 输入值验证：可以为用户输入的值设置验证规则。
• 自动数据源生成：可以通过 Enum 类型自动生成数据源，简化数据管理。
• 自定义符号与配色方案：用户可以根据需求自定义提示符号和配色。
• Unicode 支持：完全支持多字节字符和 Emoji，确保文本显示的多样性和生动性。

安装方法

若要在项目中使用 Sharprompt，只需通过 NuGet 包管理安装即可：

Install-Package Sharprompt

dotnet add package Sharprompt

使用示例

以下是一些简单的使用示例：

• 输入示例

  var name = Prompt.Input<string>("What's your name?");
  Console.WriteLine($"Hello, {name}!");
  

• 密码输入

  var secret = Prompt.Password("Type new password");
  Console.WriteLine("Password OK");
  

• 确认提示

  var answer = Prompt.Confirm("Are you ready?", defaultValue: true);
  Console.WriteLine($"Your answer is {answer}");
  

• 选择菜单

  var city = Prompt.Select("Select your city", new[] { "Seattle", "London", "Tokyo" });
  Console.WriteLine($"Hello, {city}!");
  

提示类型

Sharprompt 支持多种类型的命令行提示，满足不同的交互需求：

• Input：用于获取字符串或特定类型的用户输入。
• Confirm：用于确认用户操作的布尔型提示。
• Password：安全的密码输入提示，输入内容不可见。
• Select：提供预定义列表供用户选择。
• MultiSelect：可以一次选择多个选项的提示（复选框样式）。
• List：允许用户动态添加多个项目。
• Bind（模型提示）：基于数据模型来进行用户交互，支持数据绑定与显示。

配置与自定义

Sharprompt 允许用户根据自己的需求进行多种配置：

• 符号自定义：用户可以自定义提示符号，如提示开始、完成或错误。

  Prompt.Symbols.Prompt = new Symbol("🤔", "?");
  Prompt.Symbols.Done = new Symbol("😎", "V");
  Prompt.Symbols.Error = new Symbol("😱", ">>");
  

• 配色方案：支持自定义回答与选择项的颜色。

  Prompt.ColorSchema.Answer = ConsoleColor.DarkRed;
  Prompt.ColorSchema.Select = ConsoleColor.DarkCyan;
  

• 取消操作支持：如果用户按下 Ctrl-C，选项可以抛出异常进行处理。

平台支持

Sharprompt 在以下平台和环境中支持良好：

• Windows：包括命令提示符、PowerShell 及 Windows Terminal。
• Linux：尤其是在 Windows Subsystem for Linux 2 上的 Windows Terminal。
• macOS：在 Terminal.app 中运行。

许可

Sharprompt 项目基于 MIT 许可证进行授权，保障用户自由地使用和修改代码。

通过这些功能和易用性，Sharprompt 是构建互动命令行应用的强大工具，为开发者提供了极大的便利和灵活性。