Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uproid/capp
This tool is ideal for creating console applications, with widgets for necessary Console elements, user input handling, Help generation, event handling for arguments, and option configuration.
https://github.com/uproid/capp
console dart terminal
Last synced: 4 days ago
JSON representation
This tool is ideal for creating console applications, with widgets for necessary Console elements, user input handling, Help generation, event handling for arguments, and option configuration.
- Host: GitHub
- URL: https://github.com/uproid/capp
- Owner: uproid
- License: mit
- Created: 2024-10-28T11:06:09.000Z (3 months ago)
- Default Branch: master
- Last Pushed: 2024-12-24T10:12:29.000Z (about 1 month ago)
- Last Synced: 2024-12-24T11:40:10.676Z (about 1 month ago)
- Topics: console, dart, terminal
- Language: Dart
- Homepage: https://webapp.uproid.com
- Size: 23.4 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Capp - Console Application Package
[](https://pub.dev/packages/capp)
[](https://pub.dev/packages/capp)
[](https://buymeacoffee.com/fardziao)
`Capp` is a powerful Dart package designed to simplify the development of interactive console applications with features for handling user inputs, generating help information, managing arguments, and creating visually structured outputs like tables and progress indicators.
## Elements
- **Progress indicators**
- **Yes/No input fields**
- **Text/Number input fields**
- **Multiple-choice input fields**
- **Multi-option selectors**
- **Table views**
- **Json viewer**
## Features
- **Argument and Option Management**: Define and manage command-line arguments and options easily.
- **User Input Handling**: Supports reading user inputs with prompts and selection options.
- **Structured Output**: Display tables, messages in color, and various progress indicators in the console.
- **Help Generation**: Automatically generate a help guide for your console commands and options.
## Getting Started
1. Add `capp` to your `pubspec.yaml`.
2. Import `package:capp/capp.dart`.
3. Create commands, options, and user inputs to build your interactive console application.
## Example Usage
```dart
import "package:capp/capp.dart";
void main([
List 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 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.warnnig,
);
}
// 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.warnnig,
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);
}
```
## Example Output
```shell
$ 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
──────────────────────────────
```