feat(framework): overhaul console interactions (#754)

tempestphp · Dec 3, 2024 · 513eef8 · 513eef8
1 parent 4b97431
commit 513eef8
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 13 deletions.
diff --git a/src/Commands/DiscoveryClearCommand.php b/src/Commands/DiscoveryClearCommand.php
@@ -18,7 +18,7 @@ public function __construct(
 
     #[ConsoleCommand(
         name: 'discovery:clear',
-        description: 'Clear all cached discovery files',
+        description: 'Clears all cached discovery files',
         aliases: ['dc'],
     )]
     public function __invoke(): void

diff --git a/src/Commands/DiscoveryGenerateCommand.php b/src/Commands/DiscoveryGenerateCommand.php
@@ -81,8 +81,8 @@ public function generateDiscoveryCache(DiscoveryCacheStrategy $strategy): void
             $count += $discoveryItems->count();
         }
 
-        $this->writeln(sprintf(
-            '<success>Done</success> %d items cached',
+        $this->success(sprintf(
+            'Cached <em>%d</em> items',
             $count,
         ));
     }

diff --git a/src/Commands/DiscoveryStatusCommand.php b/src/Commands/DiscoveryStatusCommand.php
@@ -20,7 +20,7 @@ public function __construct(
 
     #[ConsoleCommand(
         name: 'discovery:status',
-        description: 'List all discovery locations and discovery classes',
+        description: 'Lists all discovery locations and discovery classes',
         aliases: ['ds'],
     )]
     public function __invoke(): void

diff --git a/src/Commands/InstallCommand.php b/src/Commands/InstallCommand.php
@@ -24,7 +24,7 @@ public function __construct(
     ) {
     }
 
-    #[ConsoleCommand(name: 'install', middleware: [ForceMiddleware::class])]
+    #[ConsoleCommand(name: 'install', description: 'Applies the specified installer', middleware: [ForceMiddleware::class])]
     public function __invoke(?string $installer = null): void
     {
         $installer = $this->resolveInstaller($installer);
@@ -35,15 +35,15 @@ public function __invoke(?string $installer = null): void
             return;
         }
 
-        if (! $this->confirm("Running the `{$installer->getName()}` installer, continue?")) {
-            $this->error('Aborted');
+        if (! $this->confirm("Running the <em>{$installer->getName()}</em> installer, continue?")) {
+            $this->error('Aborted.');
 
             return;
         }
 
         $installer->install();
 
-        $this->success('Done');
+        $this->success('Done.');
     }
 
     private function resolveInstaller(?string $search): ?Installer
@@ -55,10 +55,10 @@ private function resolveInstaller(?string $search): ?Installer
         if (! $search) {
             $search = $this->ask(
                 question: 'Please choose an installer',
-                options: $installers->map(fn (Installer $installer) => $installer->getName())->toArray(),
+                options: $installers->mapWithKeys(fn (Installer $installer) => yield $installer::class => $installer->getName())->toArray(),
             );
         }
 
-        return $installers->first(fn (Installer $installer) => $installer->getName() === $search);
+        return $installers->first(fn (Installer $installer) => $installer::class === $search || $installer->getName() === $search);
     }
 }
diff --git a/src/PublishesFiles.php b/src/PublishesFiles.php
@@ -5,6 +5,7 @@
 namespace Tempest\Core;
 
 use Closure;
+use Tempest\Console\Exceptions\ConsoleException;
 use Tempest\Console\HasConsole;
 use Tempest\Container\Inject;
 use Tempest\Generation\ClassManipulator;
@@ -50,7 +51,7 @@ public function publish(
     ): void {
         try {
             if (! $this->console->confirm(
-                question: sprintf('Do you want to create "%s"', $destination),
+                question: sprintf('Do you want to create <em>%s</em>?', $destination),
                 default: true,
             )) {
                 throw new FileGenerationAbortedException('Skipped.');
@@ -95,10 +96,14 @@ public function publish(
                 $callback($source, $destination);
             }
 
-            $this->console->success(sprintf('File successfully created at "%s".', $destination));
+            $this->console->success(sprintf('File successfully created at <em>%s</em>".', $destination));
         } catch (FileGenerationAbortedException $exception) {
             $this->console->info($exception->getMessage());
         } catch (Throwable $throwable) {
+            if ($throwable instanceof ConsoleException) {
+                throw $throwable;
+            }
+
             throw new FileGenerationFailedException(
                 message: 'The file could not be published.',
                 previous: $throwable,
@@ -180,7 +185,7 @@ public function askForOverride(string $targetPath): bool
         }
 
         return $this->console->confirm(
-            question: sprintf('The file "%s" already exists. Do you want to override it?', $targetPath),
+            question: sprintf('The file <em>%s</em> already exists. Do you want to override it?', $targetPath),
         );
     }
 }