chore(cli): Clean up console input/output (#321)

- Use `package:dart_console` for prompting since it handles control sequences better
- Add structured output to `list` commands

Author: dnys1

apps/cli/lib/src/commands/cloud_command.dart

@@ -9,7 +9,9 @@ import 'package:celest_cli/src/context.dart';
 import 'package:celest_cli/src/exceptions.dart';
 import 'package:celest_cli/src/utils/error.dart';
 import 'package:celest_cloud/celest_cloud.dart';
+import 'package:celest_cloud/src/proto/google/protobuf/timestamp.pb.dart' as pb;
 import 'package:celest_core/celest_core.dart';
+import 'package:dart_console/dart_console.dart';
 import 'package:logging/logging.dart';
 import 'package:mason_logger/mason_logger.dart' show Progress;
 import 'package:protobuf/protobuf.dart';
@@ -24,6 +26,9 @@ abstract base class BaseCloudCommand<R extends GeneratedMessage>
   /// The resource type of the service, e.g. `Project`.
   String get resourceType;
 
+  /// Creates an empty [Resource] protobuf message.
+  R createEmptyResource();
+
   /// The parsed arguments of the command.
   CloudCommandOptions get options => CloudCommandOptions(argResults!);
 }
@@ -33,9 +38,6 @@ base mixin CloudOperationCommand<R extends GeneratedMessage>
   /// Starts the operation in Celest Cloud.
   CloudOperation<R> callService();
 
-  /// Creates an empty [Resource] protobuf message.
-  R createEmptyResource();
-
   CloudVerbs get verbs;
 
   /// The parsed arguments of the command.
@@ -287,6 +289,11 @@ typedef CloudListResult<R extends GeneratedMessage> = ({
   String? nextPageToken
 });
 
+enum CloudListMode {
+  raw,
+  table,
+}
+
 abstract base class CloudListCommand<R extends GeneratedMessage>
     extends BaseCloudCommand<R> {
   Future<CloudListResult<R>> callService();
@@ -326,6 +333,13 @@ abstract base class CloudListCommand<R extends GeneratedMessage>
         'show-deleted',
         negatable: false,
         help: 'If set, the command will show deleted ${resource}s',
+      )
+      ..addOption(
+        'display',
+        abbr: 'd',
+        allowed: CloudListMode.values.map((it) => it.name),
+        defaultsTo: CloudListMode.table.name,
+        help: 'The display mode for results',
       );
   }();
 
@@ -343,15 +357,50 @@ abstract base class CloudListCommand<R extends GeneratedMessage>
       if (result.items.isEmpty) {
         cliLogger.info('No ${resourceType.toLowerCase()}s found');
       } else {
-        for (final item in result.items) {
-          stdout.writeln(item);
+        switch (options.mode) {
+          case CloudListMode.raw:
+            _showRawResult(result);
+          case CloudListMode.table:
+            _showTableResult(result);
         }
       }
       return 0;
     } on CloudException catch (e) {
       throw CliException(e.message);
     }
   }
+
+  void _showRawResult(CloudListResult<R> result) {
+    for (final item in result.items) {
+      stdout.writeln(item);
+    }
+  }
+
+  void _showTableResult(CloudListResult<R> result) {
+    final table = Table();
+    final columns = createEmptyResource().info_.byName.keys;
+    for (final column in columns) {
+      table.insertColumn(header: column);
+    }
+    for (final item in result.items) {
+      final row = <Object>[];
+      for (final column in columns) {
+        final tag = item.getTagNumber(column)!;
+        if (!item.hasField(tag)) {
+          row.add('<not set>');
+        } else {
+          final value = item.getField(tag) as Object;
+          row.add(switch (value) {
+            final pb.Timestamp ts => ts.toDateTime().toLocal(),
+            final ProtobufEnum enum_ when enum_.value == 0 => '<not set>',
+            final value => value,
+          });
+        }
+      }
+      table.insertRow(row);
+    }
+    stdout.writeln(table);
+  }
 }
 
 abstract base class CloudUpdateCommand<R extends GeneratedMessage>
@@ -524,4 +573,6 @@ extension type ListCommandArgResults(ArgResults argResults)
   String? get orderBy => option('order-by');
 
   bool get showDeleted => flag('show-deleted');
+
+  CloudListMode get mode => CloudListMode.values.byName(option('display')!);
 }

apps/cli/lib/src/commands/organizations/get_organization_command.dart

@@ -12,6 +12,9 @@ final class GetOrganizationCommand extends CloudGetCommand<Organization> {
   @override
   String get resourceType => 'Organization';
 
+  @override
+  Organization createEmptyResource() => Organization();
+
   @override
   Future<Organization?> callService() {
     return cloud.organizations.get(options.resourceId);

apps/cli/lib/src/commands/organizations/list_organizations_command.dart

@@ -15,6 +15,9 @@ final class ListOrganizationsCommand extends CloudListCommand<Organization> {
   @override
   String? get parentResourceType => null;
 
+  @override
+  Organization createEmptyResource() => Organization();
+
   @override
   Future<CloudListResult<Organization>> callService() async {
     final result = await cloud.organizations.list(

apps/cli/lib/src/commands/project_environments/get_project_environment_command.dart

@@ -13,6 +13,9 @@ final class GetProjectEnvironmentCommand
   @override
   String get resourceType => 'ProjectEnvironment';
 
+  @override
+  ProjectEnvironment createEmptyResource() => ProjectEnvironment();
+
   @override
   Future<ProjectEnvironment?> callService() {
     return cloud.projects.environments.get(options.resourceId);

apps/cli/lib/src/commands/project_environments/list_project_environments_command.dart

@@ -16,6 +16,9 @@ final class ListProjectEnvironmentsCommand
   @override
   String? get parentResourceType => 'Project';
 
+  @override
+  ProjectEnvironment createEmptyResource() => ProjectEnvironment();
+
   @override
   Future<CloudListResult<ProjectEnvironment>> callService() async {
     final result = await cloud.projects.environments.list(

apps/cli/lib/src/commands/projects/get_project_command.dart

@@ -12,6 +12,9 @@ final class GetProjectCommand extends CloudGetCommand<Project> {
   @override
   String get resourceType => 'Project';
 
+  @override
+  Project createEmptyResource() => Project();
+
   @override
   Future<Project?> callService() {
     return cloud.projects.get(options.resourceId);

apps/cli/lib/src/commands/projects/list_projects_command.dart

@@ -15,6 +15,9 @@ final class ListProjectsCommand extends CloudListCommand<Project> {
   @override
   String? get parentResourceType => 'Organization';
 
+  @override
+  Project createEmptyResource() => Project();
+
   @override
   Future<CloudListResult<Project>> callService() async {
     final result = await cloud.projects.list(

apps/cli/lib/src/frontend/celest_frontend.dart

@@ -31,7 +31,6 @@ import 'package:celest_cli/src/utils/process.dart';
 import 'package:celest_cli/src/utils/recase.dart';
 import 'package:celest_cli/src/utils/run.dart';
 import 'package:celest_cloud/src/proto.dart' as pb;
-import 'package:dcli/dcli.dart' as dcli;
 import 'package:logging/logging.dart';
 import 'package:mason_logger/mason_logger.dart' show Progress;
 import 'package:stream_transform/stream_transform.dart';
@@ -500,7 +499,7 @@ final class CelestFrontend {
       var organizationId = organization?.organizationId;
       var organizationDisplayName = organization?.displayName;
       if (organizationId == null) {
-        organizationDisplayName = dcli.ask(
+        organizationDisplayName = cliLogger.prompt(
           'What should we call your organization?',
         );
         if (organizationDisplayName.isEmpty) {

apps/cli/lib/src/logging/cli_logger.dart

@@ -1,9 +1,8 @@
-import 'dart:convert';
 import 'dart:io';
 
 import 'package:celest_cli/src/context.dart';
 import 'package:cli_util/cli_logging.dart' as cli_logging;
-import 'package:dcli/dcli.dart';
+import 'package:dart_console/dart_console.dart';
 import 'package:mason_logger/mason_logger.dart' as mason_logger;
 
 /// An interface which conforms to the [mason_logger.Logger] interface, but
@@ -14,6 +13,8 @@ class CliLogger implements mason_logger.Logger {
     this.progressOptions = const mason_logger.ProgressOptions(),
   });
 
+  static final Console console = Console();
+
   @override
   final mason_logger.LogTheme theme;
 
@@ -85,14 +86,7 @@ class CliLogger implements mason_logger.Logger {
     final suffix = ' ${defaultValue.toYesNo()}';
     final resolvedMessage = '$message$suffix ';
     stdout.write(resolvedMessage);
-    String? input;
-    try {
-      input = stdin.readLineSync();
-    } on FormatException catch (_) {
-      // FormatExceptions can occur due to utf8 decoding errors
-      // so we treat them as the user pressing enter (e.g. use `defaultValue`).
-      stdout.writeln();
-    }
+    final input = console.readLine(cancelOnBreak: true);
     return input == null || input.isEmpty
         ? defaultValue
         : input.toBoolean() ?? defaultValue;
@@ -153,20 +147,15 @@ class CliLogger implements mason_logger.Logger {
 
   @override
   String prompt(String? message, {Object? defaultValue, bool hidden = false}) {
-    if (ansiColorsEnabled) {
-      return ask(
-        message.toString(),
-        defaultValue: defaultValue?.toString(),
-        hidden: hidden,
-      );
-    }
     final resolvedDefaultValue = switch (defaultValue) {
       final defaultValue? when '$defaultValue'.isNotEmpty => ' ($defaultValue)',
       _ => ':',
     };
     final resolvedMessage = '$message$resolvedDefaultValue ';
     stdout.write(resolvedMessage);
-    final input = hidden ? _readLineHiddenSync() : stdin.readLineSync()?.trim();
+    final input = hidden
+        ? _readLineHiddenSync()
+        : console.readLine(cancelOnBreak: true)?.trim();
     return input == null || input.isEmpty ? resolvedDefaultValue : input;
   }
 
@@ -203,20 +192,23 @@ class CliLogger implements mason_logger.Logger {
   }
 
   String _readLineHiddenSync() {
-    const lineFeed = 10;
-    const carriageReturn = 13;
-    const delete = 127;
-    final value = <int>[];
+    const lineFeed = '\n';
+    const carriageReturn = '\r';
+    final value = <String>[];
 
     try {
       stdin
         ..echoMode = false
         ..lineMode = false;
-      int char;
+      Key key;
+      String char;
       do {
-        char = stdin.readByteSync();
+        key = console.readKey();
+        char = key.char;
         if (char != lineFeed && char != carriageReturn) {
-          final shouldDelete = char == delete && value.isNotEmpty;
+          final shouldDelete = key.isControl &&
+              key.controlChar == ControlCharacter.delete &&
+              value.isNotEmpty;
           shouldDelete ? value.removeLast() : value.add(char);
         }
       } while (char != lineFeed && char != carriageReturn);
@@ -226,7 +218,7 @@ class CliLogger implements mason_logger.Logger {
         ..echoMode = true;
     }
     stdout.writeln();
-    return utf8.decode(value);
+    return value.join();
   }
 }