refactor(console): improve visual consistency (#888)

Co-authored-by: Brent Roose <[email protected]>

Author: innocenzi

composer.json

@@ -81,7 +81,8 @@
         "tempest/vite": "self.version"
     },
     "suggest": {
-        "ext-pcntl": "Required to use some interactive console components."
+        "ext-pcntl": "Required to use some interactive console components.",
+        "ext-posix": "Required to use some interactive console components."
     },
     "minimum-stability": "dev",
     "prefer-stable": true,

src/Tempest/Cache/src/CacheClearCommand.php

@@ -31,13 +31,23 @@ public function __invoke(bool $all = false): void
             );
         }
 
+        if (count($caches) === 0) {
+            $this->console->info('No cache selected.');
+
+            return;
+        }
+
+        $this->console->header('Clearing caches');
+
         foreach ($caches as $cacheClass) {
             /** @var Cache $cache */
             $cache = $this->container->get($cacheClass);
-
             $cache->clear();
 
-            $this->info("<em>{$cacheClass}</em> cleared successfully.");
+            $this->console->keyValue(
+                key: $cacheClass,
+                value: "<style='bold fg-green'>CLEARED</style>",
+            );
         }
     }
 }

src/Tempest/Cache/src/CacheStatusCommand.php

@@ -23,24 +23,25 @@ public function __construct(
     #[ConsoleCommand(name: 'cache:status', description: 'Shows which caches are enabled')]
     public function __invoke(): void
     {
-        $caches = $this->cacheConfig->caches;
-
-        foreach ($caches as $cacheClass) {
+        $this->console->header('Cache status');
+        $this->console->keyValue('Total caches', (string) count($this->cacheConfig->caches));
+        $this->console->keyValue('Global cache', match ($this->cacheConfig->enable) {
+            true => '<style="bold fg-green">ENABLED</style>',
+            false => '<style="bold fg-red">FORCEFULLY DISABLED</style>',
+            default => '<style="bold fg-gray">DISABLED</style>',
+        });
+
+        foreach ($this->cacheConfig->caches as $cacheClass) {
             /** @var Cache $cache */
             $cache = $this->container->get($cacheClass);
 
-            $reason = match ($this->cacheConfig->enable) {
-                true => ' (global CACHE = true)',
-                false => ' (global CACHE = false)',
-                null => '',
-            };
-
-            $this->writeln(sprintf(
-                '<em>%s</em> %s%s',
-                $cacheClass,
-                $cache->isEnabled() ? '<style="fg-green">enabled</style>' : '<style="fg-red">disabled</style>',
-                $reason,
-            ));
+            $this->console->keyValue(
+                key: $cacheClass,
+                value: match ($cache->isEnabled()) {
+                    true => '<style="bold fg-green">ENABLED</style>',
+                    false => '<style="bold fg-red">DISABLED</style>',
+                },
+            );
         }
     }
 }

src/Tempest/CommandBus/src/AsyncCommandRepositories/FileCommandRepository.php

@@ -39,6 +39,10 @@ public function markAsDone(string $uuid): void
 
     public function markAsFailed(string $uuid): void
     {
+        if (! is_file(__DIR__ . "/../stored-commands/{$uuid}.pending.txt")) {
+            return;
+        }
+
         rename(
             from: __DIR__ . "/../stored-commands/{$uuid}.pending.txt",
             to: __DIR__ . "/../stored-commands/{$uuid}.failed.txt",
@@ -50,7 +54,6 @@ public function getPendingCommands(): array
         return arr(glob(__DIR__ . '/../stored-commands/*.pending.txt'))
             ->mapWithKeys(function (string $path) {
                 $uuid = str_replace('.pending.txt', '', pathinfo($path, PATHINFO_BASENAME));
-
                 $payload = file_get_contents($path);
 
                 yield $uuid => unserialize($payload);

src/Tempest/CommandBus/src/CommandHandlerNotFound.php

@@ -12,6 +12,6 @@ public function __construct(object $command)
     {
         $commandName = $command::class;
 
-        parent::__construct("No handler found for {$commandName}");
+        parent::__construct("No handler found for [{$commandName}].");
     }
 }

src/Tempest/CommandBus/src/Exceptions/CouldNotResolveCommand.php

@@ -8,4 +8,8 @@
 
 final class CouldNotResolveCommand extends Exception
 {
+    public function __construct(public string $uuid)
+    {
+        parent::__construct("Could not resolve command [{$uuid}].");
+    }
 }

src/Tempest/CommandBus/src/HandleAsyncCommand.php

@@ -24,7 +24,7 @@ public function __construct(
     ) {
     }
 
-    #[ConsoleCommand(name: 'command:handle')]
+    #[ConsoleCommand(name: 'command:handle', description: 'Manually executes a pending command')]
     public function __invoke(?string $uuid = null): ExitCode
     {
         try {
@@ -35,7 +35,7 @@ public function __invoke(?string $uuid = null): ExitCode
             }
 
             if (! $command) {
-                $this->error('No pending command found');
+                $this->error('No pending command found.');
 
                 return ExitCode::ERROR;
             }
@@ -44,7 +44,7 @@ public function __invoke(?string $uuid = null): ExitCode
 
             if (! $commandHandler) {
                 $commandClass = $command::class;
-                $this->error("No handler found for command {$commandClass}");
+                $this->error("No handler found for command {$commandClass}.");
 
                 return ExitCode::ERROR;
             }
@@ -55,7 +55,6 @@ public function __invoke(?string $uuid = null): ExitCode
             );
 
             $this->repository->markAsDone($uuid);
-            $this->success('Done');
 
             return ExitCode::SUCCESS;
         } catch (Throwable $throwable) {

src/Tempest/CommandBus/src/MonitorAsyncCommands.php

@@ -23,23 +23,28 @@ public function __construct(
     ) {
     }
 
-    #[ConsoleCommand(name: 'command:monitor')]
+    #[ConsoleCommand(name: 'command:monitor', description: 'Monitors and executes pending async commands')]
     public function __invoke(): void
     {
-        $this->success('Monitoring for new commands. Press ctrl+c to stop.');
+        $this->info('Monitoring for new commands. Press <em>Ctrl+C</em> to stop.');
+        $this->writeln();
 
         /** @var \Symfony\Component\Process\Process[] $processes */
         $processes = [];
 
         while (true) { // @phpstan-ignore-line
             foreach ($processes as $uuid => $process) {
-                $time = new DateTimeImmutable();
-
                 if ($process->isTerminated()) {
                     if ($process->isSuccessful()) {
-                        $this->writeln("<style=\"fg-green\">{$uuid}</style> finished at {$time->format('Y-m-d H:i:s')}");
+                        $this->console->keyValue(
+                            key: "<style='fg-gray'>{$uuid}</style>",
+                            value: "<style='fg-green bold'>SUCCESS</style>",
+                        );
                     } else {
-                        $this->writeln("<style=\"fg-red\">{$uuid}</style> failed at {$time->format('Y-m-d H:i:s')}");
+                        $this->console->keyValue(
+                            key: "<style='fg-gray'>{$uuid}</style>",
+                            value: "<style='fg-red bold'>FAILED</style>",
+                        );
                     }
 
                     if ($output = trim($process->getOutput())) {
@@ -73,7 +78,10 @@ public function __invoke(): void
             $uuid = $availableCommands->keys()->first();
 
             $time = new DateTimeImmutable();
-            $this->writeln("<h2>{$uuid}</h2> started at {$time->format('Y-m-d H:i:s')}");
+            $this->console->keyValue(
+                key: $uuid,
+                value: "<style='fg-gray'>{$time->format('Y-m-d H:i:s')}</style>",
+            );
 
             $process = new Process([
                 $this->argumentBag->getBinaryPath(),

src/Tempest/Console/composer.json

@@ -17,6 +17,10 @@
         "tempest/validation": "dev-main",
         "ext-readline": "*"
     },
+    "suggest": {
+        "ext-pcntl": "Required to use some interactive console components.",
+        "ext-posix": "Required to use some interactive console components."
+    },
     "autoload": {
         "psr-4": {
             "Tempest\\Console\\": "src"

src/Tempest/Console/src/Actions/RenderConsoleCommand.php

@@ -32,7 +32,7 @@ public function __invoke(ConsoleCommand $consoleCommand): void
 
         if ($this->renderDescription) {
             if ($consoleCommand->description !== null && $consoleCommand->description !== '') {
-                $parts[] = $consoleCommand->description;
+                $parts[] = "<style='dim'>{$consoleCommand->description}</style>";
             }
         }
 
@@ -43,7 +43,6 @@ private function renderName(ConsoleCommand $consoleCommand): string
     {
         return str($consoleCommand->getName())
             ->alignRight($this->longestCommandName, padding: $this->longestCommandName ? 2 : 0)
-            ->wrap(before: '<style="fg-cyan">', after: '</style>')
             ->toString();
     }
 
@@ -58,7 +57,7 @@ private function renderArgument(ConsoleArgumentDefinition $argument): string
             default => $argument->name,
         };
 
-        $formattedArgumentName = str($formattedArgumentName)->wrap('<style="fg-cyan">', '</style>');
+        $formattedArgumentName = str($formattedArgumentName)->wrap('<style="fg-blue">', '</style>');
 
         if (! $argument->hasDefault) {
             return $formattedArgumentName->wrap('<style="fg-gray dim"><</style>', '<style="fg-gray dim">></style>')->toString();
@@ -88,8 +87,8 @@ private function renderEnumArgument(ConsoleArgumentDefinition $argument): string
             array: $argument->type::cases(),
         );
 
-        $partsAsString = ' {<style="fg-cyan">' . implode('|', $parts) . '</style>}';
-        $line = "<style=\"fg-cyan\">{$argument->name}</style>";
+        $partsAsString = ' {<style="fg-blue">' . implode('|', $parts) . '</style>}';
+        $line = "<style=\"fg-blue\">{$argument->name}</style>";
 
         if ($argument->hasDefault) {
             return "[{$line}={$argument->default->value}{$partsAsString}]";