docs(components): add docs

Author: LeadcodeDev

lib/src/application/components/ask.dart

@@ -6,6 +6,7 @@ import 'package:commander_ui/src/application/utils/terminal_tools.dart';
 import 'package:commander_ui/src/domains/models/component.dart';
 import 'package:mansion/mansion.dart';
 
+/// A component that asks the user for input.
 final class Ask with TerminalTools implements Component<Future<String?>> {
   final _completer = Completer<String?>();
 
@@ -16,11 +17,12 @@ final class Ask with TerminalTools implements Component<Future<String?>> {
   late final bool _hidden;
   late final String? Function(String value)? _validate;
 
-  bool get hasDefault => _defaultValue != null && '$_defaultValue'.isNotEmpty;
+  /// Creates a new instance of [Ask].
+  bool get _hasDefault => _defaultValue != null && '$_defaultValue'.isNotEmpty;
 
-  String get resolvedDefaultValue => hasDefault ? '$_defaultValue' : '';
+  String get _resolvedDefaultValue => _hasDefault ? '$_defaultValue' : '';
 
-  List<Sequence> get baseDefaultSequence {
+  List<Sequence> get _baseDefaultSequence {
     return [
       SetStyles(Style.foreground(Color.brightBlack)),
       Print(' ($_defaultValue)'),
@@ -55,7 +57,7 @@ final class Ask with TerminalTools implements Component<Future<String?>> {
   void _waitResponse() {
     final input = _hidden ? readLineHiddenSync() : readLineSync();
     final response =
-        input == null || input.isEmpty ? resolvedDefaultValue : input;
+        input == null || input.isEmpty ? _resolvedDefaultValue : input;
 
     if (_validate != null) {
       final result = _validate!(response);
@@ -81,7 +83,7 @@ final class Ask with TerminalTools implements Component<Future<String?>> {
     buffer.writeAnsiAll([
       ...askSequence,
       Print(_message),
-      if (hasDefault) ...baseDefaultSequence,
+      if (_hasDefault) ..._baseDefaultSequence,
       const CursorPosition.moveRight(1),
       SetStyles(Style.foreground(Color.brightBlack)),
     ]);
@@ -101,7 +103,7 @@ final class Ask with TerminalTools implements Component<Future<String?>> {
     buffer.writeAnsiAll([
       ...errorSequence,
       Print(_message),
-      if (hasDefault) ...baseDefaultSequence,
+      if (_hasDefault) ..._baseDefaultSequence,
       const CursorPosition.moveRight(1),
     ]);
 

lib/src/application/components/checkbox.dart

@@ -7,6 +7,7 @@ import 'package:commander_ui/src/domains/models/component.dart';
 import 'package:commander_ui/src/io.dart';
 import 'package:mansion/mansion.dart';
 
+/// A component that asks the user to select one or more options.
 final class Checkbox<T>
     with TerminalTools
     implements Component<Future<List<T>>> {

lib/src/application/components/screen.dart

@@ -3,6 +3,7 @@ import 'dart:io';
 import 'package:commander_ui/src/domains/models/component.dart';
 import 'package:mansion/mansion.dart';
 
+/// A component that represents an alternate screen.
 final class Screen implements Component<ScreenManager> {
   String? _title;
 

lib/src/application/components/select.dart

@@ -7,6 +7,7 @@ import 'package:commander_ui/src/domains/models/component.dart';
 import 'package:commander_ui/src/io.dart';
 import 'package:mansion/mansion.dart';
 
+/// A component that asks the user to select one option.
 final class Select<T> with TerminalTools implements Component<Future<T>> {
   final _completer = Completer<T>();
 

lib/src/application/components/swap.dart

@@ -7,6 +7,7 @@ import 'package:commander_ui/src/domains/models/component.dart';
 import 'package:commander_ui/src/io.dart';
 import 'package:mansion/mansion.dart';
 
+/// A component that asks the user to swap between two options.
 final class Swap<T> with TerminalTools implements Component<Future<bool>> {
   final _completer = Completer<bool>();
 

lib/src/application/components/table.dart

@@ -5,6 +5,7 @@ import 'package:commander_ui/src/application/utils/terminal_tools.dart';
 import 'package:commander_ui/src/domains/models/component.dart';
 import 'package:mansion/mansion.dart';
 
+/// A component that renders a table.
 final class Table with TerminalTools implements Component<void> {
   final List<List<String>> data;
   final List<String> columns;

lib/src/application/components/task.dart

@@ -19,6 +19,7 @@ final List<String> _loadingSteps = [
   '⠏'
 ];
 
+/// A component that represents a task.
 final class Task with TerminalTools implements Component<Future<StepManager>> {
   final Terminal _terminal;
   final bool _colored;
@@ -31,6 +32,7 @@ final class Task with TerminalTools implements Component<Future<StepManager>> {
   }
 }
 
+/// A manager that handles the steps of a task.
 final class StepManager with TerminalTools {
   final Terminal _terminal;
   (int, int)? _position;
@@ -41,6 +43,7 @@ final class StepManager with TerminalTools {
 
   StepManager(this._terminal, this._colored);
 
+  /// Add new step to the task.
   Future<T> step<T>(String message, {FutureOr<T> Function()? callback}) {
     if (isInitialStep) {
       createSpace(_terminal, 1);
@@ -66,13 +69,14 @@ final class StepManager with TerminalTools {
           SetStyles.reset
         ]);
 
-        task.render(buffer);
+        task._render(buffer);
       });
     });
 
-    return task.start();
+    return task._start();
   }
 
+  /// Finishes the task with a success message.
   void success(String message) {
     final buffer = StringBuffer();
 
@@ -88,6 +92,7 @@ final class StepManager with TerminalTools {
     stdout.write(buffer.toString());
   }
 
+  /// Finishes the task with an error message.
   void warn(String message) {
     final buffer = StringBuffer();
 
@@ -103,6 +108,7 @@ final class StepManager with TerminalTools {
     stdout.write(buffer.toString());
   }
 
+  /// Finishes the task with an error message.
   void error(String message) {
     final buffer = StringBuffer();
 
@@ -132,6 +138,7 @@ final class StepManager with TerminalTools {
   }
 }
 
+/// A task step.
 final class StepTask<T> {
   final _completer = Completer<T>();
 
@@ -140,7 +147,7 @@ final class StepTask<T> {
 
   StepTask(this._message, this._callback);
 
-  Future<T> start() async {
+  Future<T> _start() async {
     if (_callback case Future<void> Function() callback) {
       callback().then((value) {
         _completer.complete(value as T);
@@ -152,7 +159,7 @@ final class StepTask<T> {
     return _completer.future;
   }
 
-  void render(StringBuffer buffer) {
+  void _render(StringBuffer buffer) {
     buffer.writeAnsiAll([
       SetStyles(Style.foreground(Color.brightBlack)),
       Print(' $_message'),

lib/src/domains/models/component.dart

@@ -1,3 +1,5 @@
+/// The component contract.
 abstract interface class Component<T> {
+  /// Handles the component.
   T handle();
 }

lib/src/io.dart

@@ -1,7 +1,4 @@
-export 'package:io/io.dart' show ExitCode;
-
 /// Non-printable characters that can be entered from the keyboard.
-///
 enum ControlCharacter {
   /// null
   none,