refactor(console): improve console output consistency (#1102)

Author: innocenzi

src/Tempest/Console/src/Actions/ExecuteConsoleCommand.php

@@ -14,6 +14,8 @@
 use Tempest\Container\Container;
 use Throwable;
 
+use function Tempest\Support\Arr\wrap;
+
 final readonly class ExecuteConsoleCommand
 {
     public function __construct(
@@ -39,6 +41,16 @@ public function __invoke(string|array $command, string|array $arguments = []): E
         ));
     }
 
+    public function withoutArgumentBag(): self
+    {
+        $bag = new ConsoleArgumentBag([
+            $this->argumentBag->getBinaryPath(),
+            $this->argumentBag->getCommandName(),
+        ]);
+
+        return new self($this->container, $this->consoleConfig, $bag, $this->resolveConsoleCommand);
+    }
+
     private function getCallable(array $commandMiddleware): ConsoleMiddlewareCallable
     {
         $callable = new ConsoleMiddlewareCallable(function (Invocation $invocation) {
@@ -77,9 +89,10 @@ private function resolveConsoleCommand(string|array $commandName): ?ConsoleComma
     }
 
     /** @return array{string,array} */
-    private function resolveCommandAndArguments(string|array $command, array $arguments = []): array
+    private function resolveCommandAndArguments(string|array $command, string|array $arguments = []): array
     {
         $commandName = $command;
+        $arguments = wrap($arguments);
 
         if (is_array($command)) {
             $commandName = $command[0] ?? '';

src/Tempest/Console/src/Commands/MakeCommandCommand.php

@@ -38,6 +38,7 @@ public function __invoke(
             ],
         );
 
-        $this->console->success(sprintf('File successfully created at <em>%s</em>.', $targetPath));
+        $this->console->writeln();
+        $this->console->success(sprintf('File successfully created at <file="%s"/>.', $targetPath));
     }
 }

src/Tempest/Console/src/Commands/MakeGeneratorCommandCommand.php

@@ -38,6 +38,7 @@ public function __invoke(
             ],
         );
 
-        $this->console->success(sprintf('File successfully created at <em>%s</em>.', $targetPath));
+        $this->console->writeln();
+        $this->console->success(sprintf('File successfully created at <file="%s"/>.', $targetPath));
     }
 }

src/Tempest/Console/src/Commands/MakeMiddlewareCommand.php

@@ -41,6 +41,7 @@ public function __invoke(
             shouldOverride: $shouldOverride,
         );
 
+        $this->console->writeln();
         $this->console->success(sprintf('Middleware successfully created at <file="%s"/>.', $targetPath));
     }
 

src/Tempest/Console/src/Components/InteractiveComponentRenderer.php

@@ -226,15 +226,7 @@ private function resolveHandlers(InteractiveConsoleComponent $component): array
      */
     private function validate(mixed $value, array $validation): ?Rule
     {
-        $validator = new Validator();
-
-        try {
-            $validator->validateValue($value, $validation);
-        } catch (InvalidValueException $invalidValueException) {
-            return $invalidValueException->failingRules[0];
-        }
-
-        return null;
+        return new Validator()->validateValue($value, $validation)[0] ?? null;
     }
 
     public function isComponentSupported(Console $console, InteractiveConsoleComponent $component): bool

src/Tempest/Console/src/Components/Renderers/MessageRenderer.php

@@ -23,7 +23,6 @@ public function render(string $contents, ?string $title = null): string
             ->implode("\n");
 
         return str()
-            ->append("\n")
             ->append("<style='fg-{$this->color} bold'>{$title}</style> <style='dim fg-{$this->color}'>//</style>")
             ->append("<style='fg-{$this->color}'>{$lines}</style>")
             ->toString();

src/Tempest/Console/src/Components/Renderers/RendersInput.php

@@ -17,6 +17,8 @@ trait RendersInput
 
     public const int MARGIN_TOP = 1;
 
+    public const int MARGIN_BOTTOM = 0;
+
     private ImmutableString $frame;
 
     private Terminal $terminal;
@@ -54,10 +56,10 @@ private function prepareRender(Terminal $terminal, ComponentState $state): self
     private function finishRender(): string
     {
         if ($this->state->isFinished() && $this->frame->endsWith("\n")) {
-            $this->frame = $this->frame->replaceEnd("\n", '');
+            $this->frame = $this->frame->stripEnd("\n");
         }
 
-        return $this->frame->toString();
+        return $this->frame->append(str_repeat("\n", self::MARGIN_BOTTOM))->toString();
     }
 
     private function truncate(?string $string = null, int $maxLineOffset = 0): string

src/Tempest/Console/src/Components/Renderers/TextInputRenderer.php

@@ -8,6 +8,7 @@
 use Tempest\Console\Components\TextBuffer;
 use Tempest\Console\Point;
 use Tempest\Console\Terminal\Terminal;
+use Tempest\Support\Str\ImmutableString;
 
 use function Tempest\Support\str;
 
@@ -42,7 +43,8 @@ public function render(
         $lines = str($buffer->text ?: ($placeholder ?: ''))
             ->explode("\n")
             ->flatMap(fn (string $line) => str($line)->chunk($this->maxLineCharacters)->toArray())
-            ->map(static fn (string $line) => str($line)->replaceEnd("\n", ' '));
+            ->map(static fn (string $line) => str($line)->replaceEnd("\n", ' '))
+            ->filter(fn (ImmutableString $line) => $line->isNotEmpty());
 
         // calculates scroll offset based on cursor position
         $this->scrollOffset = $this->calculateScrollOffset($lines, $this->maximumLines, $buffer->getRelativeCursorPosition($this->maxLineCharacters)->y);
@@ -51,7 +53,7 @@ public function render(
         $displayLines = $lines->slice($this->scrollOffset, $this->state->isFinished() ? 1 : $this->maximumLines);
 
         // if there is nothing to display after the component is done, show "no input"
-        if ($this->state->isFinished() && $lines->count() === 0) {
+        if ($this->state->isFinished() && $lines->isEmpty()) {
             $this->line($this->style('italic dim', 'No input.'))->newLine();
         }
 

src/Tempest/Console/src/Exceptions/ConsoleErrorHandler.php

@@ -15,6 +15,8 @@
 use Tempest\Highlight\Highlighter;
 use Throwable;
 
+use function Tempest\Support\str;
+
 final readonly class ConsoleErrorHandler implements ErrorHandler
 {
     public function __construct(
@@ -36,9 +38,9 @@ public function handleException(Throwable $throwable): void
                 condition: $throwable->getMessage(),
                 callback: fn (Console $console) => $console->error($throwable->getMessage()),
             )
-            ->writeln($this->getSnippet($throwable->getFile(), $throwable->getLine()))
             ->writeln()
-            ->writeln('<u>' . $throwable->getFile() . ':' . $throwable->getLine() . '</u>')
+            ->writeln('In ' . $this->formatFileWithLine($throwable->getFile() . ':' . $throwable->getLine()))
+            ->writeln($this->getSnippet($throwable->getFile(), $throwable->getLine()))
             ->writeln();
 
         if ($this->argumentBag->get('-v') !== null) {
@@ -48,12 +50,11 @@ public function handleException(Throwable $throwable): void
 
             $this->console->writeln();
         } else {
-            $firstLine = $throwable->getTrace()[0];
-
             $this->console
-                ->writeln('<style="fg-blue bold">#0</style> ' . $this->formatTrace($firstLine))
+                ->writeln('<style="fg-blue bold">#0</style> ' . $this->formatTrace($throwable->getTrace()[0]))
+                ->writeln('<style="fg-blue bold">#1</style> ' . $this->formatTrace($throwable->getTrace()[1]))
                 ->writeln()
-                ->writeln('<em>-v</em> show more')
+                ->writeln('   <style="dim">Run with -v to show more.</style>')
                 ->writeln();
         }
 
@@ -75,10 +76,13 @@ public function handleError(int $errNo, string $errstr, string $errFile, int $er
     private function getSnippet(string $file, int $lineNumber): string
     {
         $highlighter = $this->highlighter->withGutter();
-        $code = Escape::terminal($highlighter->parse(file_get_contents($file), 'php'));
+        $code = Escape::terminal($highlighter->parse(file_get_contents($file), language: 'php'));
         $lines = explode(PHP_EOL, $code);
 
-        $lines[$lineNumber - 1] = $lines[$lineNumber - 1] . ' <style="fg-red"><</style>';
+        $lines[$lineNumber - 1] = str($lines[$lineNumber - 1])
+            ->replaceRegex('/^\d+/', fn (array $match) => "<style='fg-red'>{$match[0]}</style>")
+            ->append('  <style="fg-red"><<<</style>')
+            ->toString();
 
         $excerptSize = 5;
         $start = max(0, ($lineNumber - $excerptSize) - 2);
@@ -87,16 +91,30 @@ private function getSnippet(string $file, int $lineNumber): string
         return PHP_EOL . implode(PHP_EOL, $lines);
     }
 
-    private function formatTrace(mixed $trace): string
+    private function formatFileWithLine(string $file): string
+    {
+        [$file, $line] = explode(':', $file);
+        $directory = dirname($file);
+        $filename = basename($file);
+
+        return sprintf('<style="fg-gray">%s/</style>%s<style="dim">:</style>%s', $directory, $filename, $line);
+    }
+
+    private function formatTrace(array $trace): string
     {
         if (isset($trace['file'])) {
-            return '<u>' . $trace['file'] . ':' . $trace['line'] . '</u>';
+            return $this->formatFileWithLine($trace['file'] . ':' . $trace['line']);
         }
 
         if (isset($trace['class'])) {
-            return $trace['class'] . $trace['type'] . $trace['function'];
+            return sprintf(
+                "%s<style='dim'>%s</style>%s<style='dim'>()</style>",
+                $trace['class'],
+                $trace['type'],
+                $trace['function'],
+            );
         }
 
-        return $trace['function'] . '()';
+        return sprintf("%s<style='dim'>()</style>", $trace['function']);
     }
 }

src/Tempest/Console/src/Exceptions/InterruptException.php

@@ -10,6 +10,7 @@ final class InterruptException extends ConsoleException
 {
     public function render(Console $console): void
     {
+        $console->writeln();
         $console->error('Interrupted by user.');
     }
 }