Capp - 控制台应用程序包
Capp 是一个功能强大的 Dart 包，旨在简化交互式控制台应用程序的开发，具有处理用户输入、生成帮助信息、管理参数以及创建视觉结构化输出（如表格和进度指示器）的功能。
元素
- 进度指示器
- 是/否输入字段
- 文本/数字输入字段
- 多选输入字段
- 多选项选择器
- 表格视图
- Json 查看器
功能特性
- 参数和选项管理：轻松定义和管理命令行参数和选项。
- 用户输入处理：支持通过提示和选择选项读取用户输入。
- 结构化输出：在控制台中显示表格、彩色消息和各种进度指示器。
- 帮助生成：自动为控制台命令和选项生成帮助指南。
入门指南
- 将
capp添加到您的pubspec.yaml中。 - 导入
package:capp/capp.dart。 - 创建命令、选项和用户输入以构建您的交互式控制台应用程序。
使用示例
import "package:capp/capp.dart";
void main([
List<String> args = const [],
]) {
var app = CappManager(
main: CappController(
'',
options: [
CappOption(
name: 'help',
shortName: 'h',
description: 'Show help',
),
],
run: (c) async {
if (c.existsOption('help')) {
return CappConsole(c.manager.getHelp());
} else {
return test(c);
}
},
),
args: args,
controllers: [
CappController(
'test',
options: [],
run: test,
),
],
);
app.process();
}
Future<CappConsole> test(c) async {
const options = [
'Progress circle',
'Progress bar',
'Progress spinner',
'Yes/No questions',
'Input text',
'Make a table',
'Clear screen',
'Help',
'Exit',
];
var select = CappConsole.select(
'Select an option to test Widgets of console:',
options,
);
CappConsole.write('Your selection is: $select', CappColors.success);
// Progress circle
if (select == options[0]) {
await CappConsole.progress(
'I am waiting here for 5 secounds!',
() async => Future.delayed(Duration(seconds: 5)),
type: CappProgressType.circle,
);
}
// Progress bar
else if (select == options[1]) {
await CappConsole.progress(
'I am waiting here for 5 secounds!',
() async => Future.delayed(Duration(seconds: 5)),
type: CappProgressType.bar,
);
}
// Progress spinner
else if (select == options[2]) {
await CappConsole.progress(
'I am waiting here for 5 secounds!',
() async => Future.delayed(Duration(seconds: 5)),
type: CappProgressType.spinner,
);
}
// Yes/No Questions
else if (select == options[3]) {
final res = await CappConsole.yesNo('Do you agree? ');
CappConsole.write(
"Your answer is ${res ? 'YES' : 'NO'}",
CappColors.warning,
);
}
// Input text
else if (select == options[4]) {
var age = CappConsole.read(
'What is your age?',
isRequired: true,
isNumber: true,
);
CappConsole.write(
"Your age is: $age",
CappColors.success,
);
}
// Make a table
else if (select == options[5]) {
const table = [
['#', 'Name', 'Age', 'City', 'Job'],
['1', 'Farhad', '38', 'Amsterdam', 'Engineer'],
['2', 'Adrian', '25', 'Berlin', 'Teacher'],
['3', 'Arian', '33', 'Frankfort', 'Taxi driver']
];
CappConsole.writeTable(table);
CappConsole.writeTable(
table,
color: CappColors.warning,
dubleBorder: true,
);
}
// Clear Screen
else if (select == options[6]) {
CappConsole.clear();
}
// Help
else if (select == options[7]) {
CappConsole.write(c.manager.getHelp());
} else if (select == options.last) {
return CappConsole('Exit!');
}
return test(c);
}
示例输出
$ dart ./example/example.dart
Select an option to test Widgets of console:
[1]. Progress circle
[2]. Progress bar
[3]. Progress spinner
[4]. Yes/No questions
[5]. Input text
[6]. Make a table
[7]. Clear screen
[8]. Help
[9]. Exit
Enter the number of the option: 1
Your selection is: Progress circle
I am waiting here for 5 secounds! ⢿
Select an option to test Widgets of console:
[1]. Progress circle
[2]. Progress bar
[3]. Progress spinner
[4]. Yes/No questions
[5]. Input text
[6]. Make a table
[7]. Clear screen
[8]. Help
[9]. Exit
Enter the number of the option: 2
Your selection is: Progress bar
I am waiting here for 5 secounds! █████░████████
Select an option to test Widgets of console:
[1]. Progress circle
[2]. Progress bar
[3]. Progress spinner
[4]. Yes/No questions
[5]. Input text
[6]. Make a table
[7]. Clear screen
[8]. Help
[9]. Exit
Enter the number of the option: 3
Your selection is: Progress spinner
I am waiting here for 5 secounds! |----->-------|
Select an option to test Widgets of console:
[1]. Progress circle
[2]. Progress bar
[3]. Progress spinner
[4]. Yes/No questions
[5]. Input text
[6]. Make a table
[7]. Clear screen
[8]. Help
[9]. Exit
Enter the number of the option: 4
Your selection is: Yes/No questions
Do you agree? (y/n): N
Your answer is NO
Select an option to test Widgets of console:
[1]. Progress circle
[2]. Progress bar
[3]. Progress spinner
[4]. Yes/No questions
[5]. Input text
[6]. Make a table
[7]. Clear screen
[8]. Help
[9]. Exit
Enter the number of the option: 5
Your selection is: Input text
What is your age? 33
Your age is: 33
Select an option to test Widgets of console:
[1]. Progress circle
[2]. Progress bar
[3]. Progress spinner
[4]. Yes/No questions
[5]. Input text
[6]. Make a table
[7]. Clear screen
[8]. Help
[9]. Exit
Enter the number of the option: 5
Your selection is: Input text
What is your age? 33
Your age is: 33
Select an option to test Widgets of console:
[1]. Progress circle
[2]. Progress bar
[3]. Progress spinner
[4]. Yes/No questions
[5]. Input text
[6]. Make a table
[7]. Clear screen
[8]. Help
[9]. Exit
Enter the number of the option: 6
Your selection is: Make a table
┌───┬────────┬─────┬────────────┬─────────────┐
│ # │ Name │ Age │ City │ Job │
├───┼────────┼─────┼────────────┼─────────────┤
│ 1 │ Farhad │ 38 │ Amsterdam │ Engineer │
├───┼────────┼─────┼────────────┼─────────────┤
│ 2 │ Adrian │ 25 │ Berlin │ Teacher │
├───┼────────┼─────┼────────────┼─────────────┤
│ 3 │ Arian │ 33 │ Frankfort │ Taxi driver │
└───┴────────┴─────┴────────────┴─────────────┘
╔═══╦════════╦═════╦════════════╦═════════════╗
║ # ║ Name ║ Age ║ City ║ Job ║
╠═══╬════════╬═════╬════════════╬═════════════╣
║ 1 ║ Farhad ║ 38 ║ Amsterdam ║ Engineer ║
╠═══╬════════╬═════╬════════════╬═════════════╣
║ 2 ║ Adrian ║ 25 ║ Berlin ║ Teacher ║
╠═══╬════════╬═════╬════════════╬═════════════╣
║ 3 ║ Arian ║ 33 ║ Frankfort ║ Taxi driver ║
╚═══╩════════╩═════╩════════════╩═════════════╝
Select an option to test Widgets of console:
[1]. Progress circle
[2]. Progress bar
[3]. Progress spinner
[4]. Yes/No questions
[5]. Input text
[6]. Make a table
[7]. Clear screen
[8]. Help
[9]. Exit
Enter the number of the option: 8
Your selection is: Help
Available commands:
1) test:
──────────────────────────────
--help Show help
-h
──────────────────────────────