项目介绍:Inquire
Inquire是一个用于创建交互式终端提示库。通过使用Inquire,开发者可以在命令行界面(CLI)中与用户进行交互,收集信息。这个库支持多种类型的提示,包括文本输入、日期选择、搞长文本编辑、选项选择、多选、确认、定制类型解析以及密码输入。
功能概览
- 跨平台支持:Inquire支持UNIX和Windows终端,采用默认的Crossterm库实现。
- 多种提示类型:提供丰富的提示类型,以适应不同需求。
- 标准化的错误处理:依托Thiserror库实现。
- 灵活配置:针对每种提示类型,允许用户进行配置,如渲染配置、默认值、占位符、输入验证、自动完成功能及自定义解析和格式化。
提示类型介绍
文本输入(Text)
用于接收用户文本输入,支持自动完成功能。用户可以定制提示消息、帮助信息、默认值、占位符以及验证和格式化。
let name = Text::new("What is your name?").prompt();
日期选择(DateSelect)
用户可以通过交互式日历选择日期。可以设置默认日期、最小/最大日期、周起始日等。
let date = DateSelect::new("When do you want to travel?")
.with_default(chrono::NaiveDate::from_ymd(2021, 8, 1))
.prompt();
选项选择(Select)
让用户从给定的列表中选择一个选项,支持自定义显示格式和评分函数。
let options: Vec<&str> = vec!["Banana", "Apple", "Strawberry"];
let ans = Select::new("What's your favorite fruit?", options).prompt();
多选(MultiSelect)
让用户选择多个选项,支持默认选择、分页等。
编辑器(Editor)
打开文本编辑器接收长文本输入,可设置自定义编辑器、文件扩展名及预设文本。
密码(Password)
用于接收敏感信息输入,支持隐藏、掩盖或完全显示输入方式。
let password = Password::new("Enter your password:").prompt();
自定义类型(CustomType)
接受用户输入并解析为指定类型,适合需要解析为f64类型或UUID的输入。
let amount = CustomType::<f64>::new("How much do you want to donate?").prompt();
确认(Confirm)
询问用户简单的是/否问题,默认接受 "y" 和 "n" 作为输入。
let confirmation = Confirm::new("Do you accept the terms?").prompt();
配置与使用
用户可以通过配置项对每种提示的行为进行细化的控制,例如设置颜色主题、键设置、默认值和格式化规则等。可以将Inquire添加到Rust项目的Cargo.toml
中进行使用。
inquire = "0.7.5"
Inquire使开发者能够轻松配置并在CLI中实现交互式用户输入,同时通过丰富的功能和配置选项满足各种开发需求。