refactor: moved all icons inside a separate file

* getInput now has option to change leading and trailing icons

* prompts at various places are replaced by getInput

* added tests: for getInput, snake_to_pascal_case,

Author: ShivanshuKGupta

packages/gazelle_cli/lib/commands/codegen/codegen.dart

@@ -4,6 +4,7 @@ import 'package:args/command_runner.dart';
 import 'package:cli_spin/cli_spin.dart';
 import 'package:path/path.dart';
 
+import '../../commons/entities/input_icons.dart';
 import '../../commons/functions/load_project_configuration.dart';
 import 'analyze_entities.dart';
 import 'generate_client.dart';
@@ -62,7 +63,7 @@ class _CodegenModelsCommand extends Command {
       );
 
       spinner.success(
-        "Models generated 🚀\nAdd ${models.modelProvider.path.split("/").last} to your GazelleApp!",
+        "Models generated ${InputIcons.rocket}${InputIcons.rocket}\nAdd ${models.modelProvider.path.split("/").last} to your GazelleApp!",
       );
     } on LoadProjectConfigurationGazelleNotFoundError catch (e) {
       spinner.fail(e.errorMessage);
@@ -114,7 +115,7 @@ class _CodegenClientCommand extends Command {
       );
 
       spinner.success(
-          "Client generated 🚀\nImport the client in your Dart frontend application!");
+          "Client generated ${InputIcons.rocket}\nImport the client in your Dart frontend application!");
     } on LoadProjectConfigurationGazelleNotFoundError catch (e) {
       spinner.fail(e.errorMessage);
       exit(e.errorCode);

packages/gazelle_cli/lib/commands/codegen/generate_client.dart

@@ -6,7 +6,6 @@ import 'package:dart_style/dart_style.dart';
 import '../../commons/consts.dart';
 import '../../commons/functions/get_latest_package_version.dart';
 import '../../commons/functions/snake_to_pascal_case.dart';
-import '../../commons/functions/version.dart';
 
 String _getPubspecTemplate({
   required String gazelleClientVersion,

packages/gazelle_cli/lib/commands/create/create.dart

@@ -3,6 +3,7 @@ import 'dart:io';
 import 'package:args/command_runner.dart';
 import 'package:cli_spin/cli_spin.dart';
 
+import '../../commons/entities/input_icons.dart';
 import '../../commons/functions/get_input.dart';
 import '../../commons/functions/load_project_configuration.dart';
 import 'create_handler.dart';
@@ -44,15 +45,13 @@ class _CreateProjectCommand extends Command {
 
   @override
   void run() async {
-    stdout.writeln("✨ What would you like to name your new project? 🚀");
-    String? projectName = stdin.readLineSync();
-    while (projectName == null || projectName == "") {
-      stdout.writeln("⚠ Please provide a name for your project to proceed:");
-      projectName = stdin.readLineSync();
-    }
-    stdout.writeln();
+    final projectName = getInput(
+      "What would you like to name your new project?",
+      onEmpty: "Please provide a name for your project to proceed!",
+      onValidated: (input) =>
+          input.replaceAll(RegExp(r'\s+'), "_").toLowerCase(),
+    );
 
-    projectName = projectName.replaceAll(RegExp(r'\s+'), "_").toLowerCase();
     final fullstack = argResults?.flag("flutter") != null ? true : false;
 
     final spinner = CliSpin(
@@ -68,7 +67,7 @@ class _CreateProjectCommand extends Command {
       );
 
       spinner.success(
-        "$projectName project created 🚀\n💡To navigate to your project run \"cd $projectName\"\n💡Then, use \"gazelle run\" to execute it!",
+        "$projectName project created ${InputIcons.rocket}\n💡To navigate to your project run \"cd $projectName\"\n💡Then, use \"gazelle run\" to execute it!",
       );
     } on CreateProjectError catch (e) {
       spinner.fail(e.message);
@@ -96,15 +95,12 @@ class _CreateRouteCommand extends Command {
     CliSpin spinner = CliSpin();
     try {
       await loadProjectConfiguration();
-      stdout.writeln("✨ What would you like to name your new route? 🚀");
-      String? routeName = stdin.readLineSync();
-      while (routeName == null || routeName == "") {
-        stdout.writeln("⚠ Please provide a name for your route to proceed:");
-        routeName = stdin.readLineSync();
-      }
-      stdout.writeln();
-
-      routeName = routeName.replaceAll(RegExp(r'\s+'), "_").toLowerCase();
+      final routeName = getInput(
+        "What would you like to name your new route?",
+        onEmpty: "Please provide a name for your route to proceed!",
+        onValidated: (input) =>
+            input.replaceAll(RegExp(r'\s+'), "_").toLowerCase(),
+      );
 
       spinner = CliSpin(
         text: "Creating $routeName route...",
@@ -120,7 +116,7 @@ class _CreateRouteCommand extends Command {
       );
 
       spinner.success(
-        "$routeName route created 🚀",
+        "$routeName route created ${InputIcons.rocket}",
       );
     } on LoadProjectConfigurationGazelleNotFoundError catch (e) {
       spinner.fail(e.errorMessage);
@@ -198,7 +194,7 @@ class _CreatHandlerCommand extends Command {
         path: path,
       );
 
-      spinner.success("$handlerName handler created 🚀");
+      spinner.success("$handlerName handler created ${InputIcons.rocket}");
     } on LoadProjectConfigurationGazelleNotFoundError catch (e) {
       spinner.fail(e.errorMessage);
       exit(e.errorCode);

packages/gazelle_cli/lib/commands/create/create_models.dart

@@ -3,7 +3,6 @@ import 'dart:io';
 import '../../commons/consts.dart';
 import '../../commons/functions/get_latest_package_version.dart';
 import '../../commons/functions/snake_to_pascal_case.dart';
-import '../../commons/functions/version.dart';
 
 String _getPubspecTemplate(String gazelleSerializationVersion) => """
 name: models 

packages/gazelle_cli/lib/commands/create/create_server.dart

@@ -5,7 +5,6 @@ import 'package:dart_style/dart_style.dart';
 import '../../commons/consts.dart';
 import '../../commons/functions/get_latest_package_version.dart';
 import '../../commons/functions/snake_to_pascal_case.dart';
-import '../../commons/functions/version.dart';
 import 'create_route.dart';
 
 const _gitignore = """

packages/gazelle_cli/lib/commands/delete/delete.dart

@@ -1,8 +1,11 @@
 import 'dart:io';
+
 import 'package:args/command_runner.dart';
 import 'package:cli_spin/cli_spin.dart';
+
+import '../../commons/entities/input_icons.dart';
 import '../../commons/entities/project_configuration.dart';
-import '../../commons/functions/confirmation.dart';
+import '../../commons/functions/get_input.dart';
 import '../../commons/functions/load_project_configuration.dart';
 import 'delete_project.dart';
 
@@ -43,9 +46,15 @@ class DeleteCommand extends Command {
       spinner.fail(e.toString());
       exit(2);
     }
-    final answer = getConfirmation(
-        '\nAre you sure you want to delete the project ${projectConfiguration.name}');
-    if (!answer) {
+    final answer = getInput(
+      '\nAre you sure you want to delete the project ${projectConfiguration.name}? (y/n)',
+      onValidated: (input) =>
+          ['yes', 'y'].contains(input.toLowerCase()) ? 'y' : 'n',
+      leading: InputIcons.warning,
+      trailing: InputIcons.none,
+      defaultValue: 'n',
+    );
+    if (answer == 'y') {
       spinner.fail("Project deletion aborted.");
       return;
     }

packages/gazelle_cli/lib/commands/run/run_project.dart

@@ -1,8 +1,8 @@
 import 'dart:convert';
 import 'dart:io';
 
+import '../../commons/consts.dart';
 import '../../commons/entities/stdin_broadcast.dart';
-import '../../commons/functions/version.dart';
 
 String _getPubspecTemplate(String projectName) => """
 name: temp_project

packages/gazelle_cli/lib/commons/consts.dart

@@ -1,3 +1,5 @@
+import 'dart:io';
+
 /// Gazelle Core package name.
 const gazelleCorePackageName = "gazelle_core";
 
@@ -6,3 +8,6 @@ const gazelleSerializationPackageName = "gazelle_serialization";
 
 /// Gazelle Client package name.
 const gazelleClientPackageName = "gazelle_client";
+
+/// Returns the Currently Installed Dart SDK version.
+final String dartSdkVersion = Platform.version.split(' ').first;

packages/gazelle_cli/lib/commons/entities/input_icons.dart

@@ -0,0 +1,17 @@
+/// A class that contains leading icons to display before messages.
+class InputIcons {
+  /// No Icon
+  static const none = "";
+
+  /// ✨ Icon
+  static const star = "✨";
+
+  /// 🚀 Icon
+  static const rocket = "🚀";
+
+  /// ⚠ Icon
+  static const warning = "⚠";
+
+  /// ❌ Icon
+  static const error = "❌";
+}

packages/gazelle_cli/lib/commons/functions/confirmation.dart

@@ -1,5 +1,7 @@
 import 'dart:io';
 
+import '../entities/input_icons.dart';
+
 /// Gets user input from the command line.
 String getInput(
   /// The message to display to the user.
@@ -17,11 +19,17 @@ String getInput(
   /// This function is called just before returning the input.
   /// You can use this function to modify the input before returning it.
   String Function(String input)? onValidated,
+
+  /// The leading icon to display before the message.
+  String leading = InputIcons.star,
+
+  /// The trailing icon to display after the message.
+  String trailing = InputIcons.rocket,
 }) {
   String? input;
   while (true) {
     stdout.write(
-        "✨ $message 🚀 ${defaultValue != null ? "($defaultValue)" : ""}: ");
+        "${leading.isEmpty ? '' : '$leading '}$message ${trailing.isEmpty ? '' : '$trailing '}${defaultValue != null ? "($defaultValue)" : ""}: ");
     input = stdin.readLineSync();
     if (input == null) {
       print("Operation cancelled by the user.");
@@ -31,12 +39,11 @@ String getInput(
       input = defaultValue;
     }
     String? validationError = validator?.call(input);
-    if (input == "" || validationError != null) {
-      stdout.writeln("⚠  ${validationError ?? onEmpty}");
+    if (input.isEmpty || validationError != null) {
+      stdout.writeln("${InputIcons.warning}  ${validationError ?? onEmpty}");
     } else {
       break;
     }
   }
-  input = onValidated?.call(input) ?? input;
-  return input;
+  return onValidated?.call(input) ?? input;
 }

packages/gazelle_cli/lib/commons/functions/get_input.dart

@@ -13,9 +13,9 @@ void main() {
                 (response) => jsonDecode(response.body)['latest']['version'],
               );
 
-      final version = await getLatestPackageVersion('http');
+      final expectedVersion = await getLatestPackageVersion('http');
 
-      expect(version, equals(originalVersion));
+      expect(expectedVersion, equals(originalVersion));
     });
   });
 }

packages/gazelle_cli/lib/commons/functions/version.dart

@@ -0,0 +1,20 @@
+import 'package:gazelle_cli/commons/functions/snake_to_pascal_case.dart';
+import 'package:test/test.dart';
+
+void main() {
+  test("snake to pascal case", () {
+    final snakeCases = [
+      "snake_case",
+      "_snake_case",
+      "snake_case_",
+      "__snake_case__",
+      "SNAKE_cAsE",
+    ];
+
+    final pascalCase = "SnakeCase";
+
+    for (final snakeCase in snakeCases) {
+      expect(snakeToPascalCase(snakeCase), pascalCase);
+    }
+  });
+}