feat(core): rework all components with the new commander core

Author: LeadcodeDev

CHANGELOG.md

@@ -1,9 +1,16 @@
+## 2.0.0
+- Rework the whole library
+- Change `input` to `ask` component
+- Change `delayed` to `task` component
+- Implement `swap` component
+- Implement logger methods
+
 ## 1.8.0
 
 - Hide internal component methods
 - Implement `onExit` property on components
 
-## 1.7.0
+## 1.7.0[CHANGELOG.md](CHANGELOG.md)
 
 - Implement `alternative screen` component
 - Add `Table` component in public export

README.md

@@ -10,144 +10,139 @@ user input.
 To use Commander in your Dart project, add this to your `pubspec.yaml` file :
 ```yaml
 dependencies:
-  commander_ui: ^1.8.0
+  commander_ui: ^2.0.0
 ```
 
 Then run `pub get` to install the dependencies.
 
 ## Usage
 
-### Input component
+### Ask component
 
-A simple example of using Commander to create an input component :
+A simple example of using Commander to create an ask component :
 
-- ✅ Placeholder
+- ✅ Secure
 - ✅ Validator with error message as callback 
 - ✅ Default value
 
 ```dart
 Future<void> main() async {
-  final input = Input(
-      answer: 'Please give us your name',
-      placeholder: 'firstname lastname',
-      validate: (value) =>
-      switch(value) {
-        String value when value
-            .trim()
-            .isNotEmpty => Ok(null),
-        _ => Err('Please provide a valid name')
-      }
-  );
-  
-  print(await input.handle());
+  final commander = Commander(level: Level.verbose);
+
+  final value = await commander.ask('What is your name ?',
+      defaultValue: 'John Doe',
+      validate: (value) {
+        return switch (value) {
+          String(:final isEmpty) when isEmpty => 'Name cannot be empty',
+          _ => null,
+        };
+      });
+
+  print(value);
 }
 ```
 
 ### Select component
 A simple example of using Commander to create an option selection component :
 
 - ✅ Placeholder
+- ✅ Default selected
 - ✅ Searchable values
-- ✅ Selected line custom style
-- ✅ Unselected line custom style
 - ✅ Display transformer
 - ✅ Max display count (default as 5)
 
 ```dart
 Future<void> main() async {
-  final select = Select(
-      answer: "Please select your best hello",
-      options: List.generate(20, (index) => Item('${index + 1}. Hello World', index + 1)),
-      placeholder: 'Type to filter',
-      selectedLineStyle: (line) => '${AsciiColors.green('❯')} ${AsciiColors.lightCyan(line)}',
-      unselectedLineStyle: (line) => '  $line',
-      onDisplay: (item) => item.name,
-      displayCount: 4
-  );
+  final commander = Commander(level: Level.verbose);
 
-  final selected = switch(await select.handle()) {
-    Ok(:final value) => 'My value is ${value.value}',
-    Err(:final error) => Exception('Error: $error'),
-    _ => 'Unknown',
-  };
+  final value = await commander.select('What is your name ?',
+      onDisplay: (value) => value,
+      placeholder: 'Type to search',
+      defaultValue: 'Charlie',
+      options: ['Alice', 'Bob', 'Charlie', 'David', 'Eve', 'Frank', 'John']);
 
-  print(selected);
+  print(value);
 }
 ```
 
-### Switching component
-A simple example of using Commander to create a switch component :
+### Swap component
+A simple example of using Commander to create a swap component :
+
+- ✅ Select value with directional arrows
 
 ```dart
 Future<void> main() async {
-  final component = Switch(
-    answer: 'Do you love cat ?',
-    defaultValue: false,
+  final commander = Commander(level: Level.verbose);
+
+  final value = await commander.swap('Do you love cats', 
+    defaultValue: true, 
+    placeholder: '🐈'
   );
   
-  final value = await component.handle();
-  
-  final result = switch(value) {
-    Ok(:final value) => value.value 
-      ? 'I love cat 😍' 
-      : 'I hate cat 😕',
-    Err(:final error) => Exception('Error: $error'),
-    _ => 'Unknown',
+  final str = switch (value) {
+    true => 'I love cats 😍',
+    false => 'I prefer dogs 😕',
   };
+
+  print(str);
 }
 ```
-### Delayed component
-A simple example of using Commander to create a delayed component :
+
+### Task component
+A simple example of using Commander to create a task component :
+
+- ✅ Multiple steps per task
+- ✅ Success, warn and error results
+- ✅ Sync and async action supports
 
 ```dart
-Future<void> main() async {
-  final delayed = Delayed();
-  
-  delayed.step('Fetching data from remote api...');
-  await wait();
-  delayed.step('Find remote location...');
-  await wait();
-  delayed.step('Extract data...');
-  await wait();
-  delayed.success('Data are available !');
-}
+Future<void> sleep() => Future.delayed(Duration(seconds: 1));
 
-Future<void> wait() =>
-    Future.delayed(Duration(seconds: Random().nextInt(3) + 1));
-```
+Future<String> sleepWithValue() =>
+    Future.delayed(Duration(seconds: 1), () => 'Hello World !');
 
-### Progress component
-A simple example of using Commander to create a progress component :
+Future<void> main() async {
+  final commander = Commander(level: Level.verbose);
+  print('Hello World !');
 
-```dart
-void main() async {
-  final progress = Progress(max: 50);
-
-  for (int i = 0; i < 50; i++) {
-    progress.next(message: [Print('Downloading file ${i + 1}/50...')]);
-    await Future.delayed(Duration(milliseconds: 50));
-  }
-
-  progress.done(message: [
-    SetStyles(Style.foreground(Color.green)),
-    Print('✔'),
-    SetStyles.reset,
-    Print(' Download complete!')
-  ]);
+  final successTask =
+  await commander.task('I am an success task', colored: true);
+  await successTask.step('Success step 1', callback: sleepWithValue);
+  await successTask.step('Success step 2', callback: sleep);
+  successTask.success('Success task data are available !');
+
+  final warnTask = await commander.task('I am an warn task');
+  await warnTask.step('Warn step 1', callback: sleepWithValue);
+  await warnTask.step('Warn step 2', callback: sleep);
+  await warnTask.step('Warn step 3', callback: sleep);
+  warnTask.warn('Warn task !');
+
+  final errorTask = await commander.task('I am an error task');
+  await errorTask.step('Error step 1', callback: sleepWithValue);
+  await errorTask.step('Error step 2', callback: sleep);
+  await errorTask.step('Error step 3', callback: sleep);
+  errorTask.error('Error task !');
 }
 ```
 
 ### Checkbox component
 A simple example of using Commander to create a checkbox component :
 
+- ✅ Placeholder
+- ✅ Default checked
+- ✅ Single or multiple selection
+- ✅ Display transforme
+
 ```dart
 Future<void> main() async {
-  final checkbox = Checkbox(
-    answer: 'What is your favorite pet ?',
+  final commander = Commander(level: Level.verbose);
+
+  final value = await commander.checkbox(
+    'What is your favorite pet ?',
+    defaultValue: 'Charlie',
     options: ['cat', 'dog', 'bird'],
   );
 
-  final value = await checkbox.handle();
   print(value);
 }
 ```
@@ -162,7 +157,8 @@ A simple example of using Commander to create a table component :
 
 ```dart
 Future<void> main() async {
-  Table(
+  final commander = Commander(level: Level.verbose);
+  commander.table(
     columns: ['Name', 'Age', 'Country', 'City'],
     lineSeparator: false,
     columnSeparator: false,
@@ -188,13 +184,18 @@ A simple example of using Commander to create an alternative screen component :
 
 ```dart
 Future<void> main() async {
-  final screen = AlternateScreen(title: 'Hello World !');
-  screen.start();
+  final commander = Commander(level: Level.verbose);
 
-  print('Hello World !');
+  final screen = commander.screen(title: 'First screen');
+  screen.enter();
+
+  await sleep();
+  print('Hello screen !');
+  await sleep();
+
+  screen.leave();
 
-  await wait();
-  screen.stop();
+  print('Goodbye screen !');
 }
 
 

example/ask.dart

@@ -1,11 +1,8 @@
 import 'package:commander_ui/src/commander.dart';
 import 'package:commander_ui/src/level.dart';
 
-enum Shape { square, circle, triangle }
-
 Future<void> main() async {
   final commander = Commander(level: Level.verbose);
-  print('Hello World !');
 
   final value = await commander.ask('What is your name ?',
       // defaultValue: 'John Doe',

example/checkbox.dart

@@ -1,15 +1,13 @@
 import 'package:commander_ui/src/commander.dart';
 import 'package:commander_ui/src/level.dart';
 
-enum Shape { square, circle, triangle }
-
 Future<void> main() async {
   final commander = Commander(level: Level.verbose);
-  print('Hello World !');
 
-  final value = await commander.checkbox('What is your name ?',
-      defaultValue: 'Charlie',
-      options: ['Alice', 'Bob', 'Charlie', 'David', 'Eve', 'Frank', 'John'],
+  final value = await commander.checkbox(
+    'What is your name ?',
+    defaultValue: 'Charlie',
+    options: ['Alice', 'Bob', 'Charlie', 'David', 'Eve', 'Frank', 'John'],
   );
 
   print(value);

example/select.dart

@@ -1,16 +1,13 @@
 import 'package:commander_ui/src/commander.dart';
 import 'package:commander_ui/src/level.dart';
 
-enum Shape { square, circle, triangle }
-
 Future<void> main() async {
   final commander = Commander(level: Level.verbose);
   print('Hello World !');
 
   final value = await commander.select('What is your name ?',
       defaultValue: 'Charlie',
-      options: ['Alice', 'Bob', 'Charlie', 'David', 'Eve', 'Frank', 'John']
-  );
+      options: ['Alice', 'Bob', 'Charlie', 'David', 'Eve', 'Frank', 'John']);
 
   print(value);
 }

example/swap.dart

@@ -1,16 +1,11 @@
 import 'package:commander_ui/src/commander.dart';
 import 'package:commander_ui/src/level.dart';
 
-enum Shape { square, circle, triangle }
-
 Future<void> main() async {
   final commander = Commander(level: Level.verbose);
-  print('Hello World !');
 
-  final value = await commander.swap(
-    'What is your name ?',
-    defaultValue: true,placeholder: 'ff'
-  );
+  final value = await commander.swap('What is your name ?',
+      defaultValue: true, placeholder: 'ff');
 
   print(value);
 }

example/task.dart

@@ -1,17 +1,16 @@
 import 'package:commander_ui/src/commander.dart';
 import 'package:commander_ui/src/level.dart';
 
-enum Shape { square, circle, triangle }
-
 Future<void> sleep() => Future.delayed(Duration(seconds: 1));
 
-Future<String> sleepWithValue() => Future.delayed(Duration(seconds: 1), () => 'Hello World !');
+Future<String> sleepWithValue() =>
+    Future.delayed(Duration(seconds: 1), () => 'Hello World !');
 
 Future<void> main() async {
   final commander = Commander(level: Level.verbose);
-  print('Hello World !');
 
-  final successTask = await commander.task('I am an success task', colored: true);
+  final successTask =
+      await commander.task('I am an success task', colored: true);
   await successTask.step('Success step 1', callback: sleepWithValue);
   await successTask.step('Success step 2', callback: sleep);
   successTask.success('Success task data are available !');

lib/commander_ui.dart

@@ -1 +1,7 @@
+export 'package:commander_ui/src/commander.dart';
+export 'package:commander_ui/src/level.dart';
+export 'package:commander_ui/src/application/utils/terminal_tools.dart';
+export 'package:commander_ui/src/domains/models/commander_theme.dart';
+export 'package:commander_ui/src/domains/models/component.dart';
 
+export 'package:mansion/mansion.dart';

lib/src/application/components/ask.dart

@@ -54,7 +54,8 @@ final class Ask with TerminalTools implements Component<Future<String?>> {
 
   void _waitResponse() {
     final input = _hidden ? readLineHiddenSync() : readLineSync();
-    final response = input == null || input.isEmpty ? resolvedDefaultValue : input;
+    final response =
+        input == null || input.isEmpty ? resolvedDefaultValue : input;
 
     if (_validate != null) {
       final result = _validate!(response);