Improved output

Especially for verbose and debug scenarios the output is now more
readable.

Author: sebastianfeldmann

src/Console/Command/Hook.php

@@ -130,13 +130,7 @@ private function handleBootstrap(Config $config): void
      */
     private function handleError(OutputInterface $output, Exception $e): int
     {
-        $header = PHP_EOL . IOUtil::getLineSeparator() . PHP_EOL
-                . IOUtil::formatHeadline(get_class($e), 80, '>', '<') . PHP_EOL
-                . IOUtil::getLineSeparator();
-
-        $output->writeLn($header, OutputInterface::VERBOSITY_VERBOSE);
-        $output->writeLn(PHP_EOL . $e->getMessage());
-
+        $output->writeLn('<error>' . PHP_EOL . $e->getMessage() . '</error>');
         return 1;
     }
 

src/Runner/Action/Cli.php

@@ -47,7 +47,7 @@ public function execute(Config $config, IO $io, Repository $repository, Config\A
         // if any placeholders got replaced display the finally executed command
         if ($cmdFormatted !== $cmdOriginal) {
             $io->write(
-                PHP_EOL . ' - <comment>' . $cmdFormatted . '</comment>',
+                ' - <comment>' . $cmdFormatted . '</comment>',
                 true,
                 IO::VERBOSE
             );
@@ -70,7 +70,12 @@ public function execute(Config $config, IO $io, Repository $repository, Config\A
         }
 
         $io->write(
-            ['', empty($output) ? '<info>command executed successfully</info>' : trim($output), ''],
+            [
+                ' - <comment>command output</comment>',
+                '',
+                empty($output) ? '<info>command executed successfully</info>' : trim($output),
+                '',
+            ],
             true,
             IO::VERBOSE
         );

src/Runner/Hook.php

@@ -44,28 +44,28 @@ abstract class Hook extends RepositoryAware
      *
      * @var bool
      */
-    private $skipActions = false;
+    private bool $skipActions = false;
 
     /**
      * Event dispatcher
      *
      * @var \CaptainHook\App\Event\Dispatcher
      */
-    protected $dispatcher;
+    protected Dispatcher $dispatcher;
 
     /**
      * List of error messages to display after all action have finished
      *
      * @var array<\Exception>
      */
-    protected $errors = [];
+    protected array $errors = [];
 
     /**
      * Plugins to apply to this hook
      *
      * @var array<Plugin\Hook>|null
      */
-    private $hookPlugins = null;
+    private ?array $hookPlugins = null;
 
     public function __construct(IO $io, Config $config, Repository $repository)
     {
@@ -245,7 +245,6 @@ private function executeActions(array $actions): void
             } else {
                 $this->executeFailAfterAllActions($actions);
             }
-            $this->io->write($this->formatCollectedErrors());
         } catch (Exception $e) {
             $this->dispatcher->dispatch('onHookFailure');
             throw $e;
@@ -288,7 +287,7 @@ private function executeFailAfterAllActions(array $actions): void
 
         if ($failedActions > 0) {
             throw new ActionFailed(
-                '<error>' . $failedActions . ' action' . ($failedActions > 1 ? 's' : '') . ' failed</error>'
+                $failedActions . ' action' . ($failedActions > 1 ? 's' : '') . ' failed'
                 . PHP_EOL
                 . $this->formatCollectedErrors()
             );
@@ -312,7 +311,10 @@ private function handleAction(Config\Action $action): void
             return;
         }
 
-        $this->io->write(' - <fg=blue>' . $this->formatActionOutput($action->getAction()) . '</> : ', false);
+        $this->io->write(
+            ' - <fg=blue>' . $this->formatActionOutput($action->getAction()) . '</> : ',
+            $this->io->isVerbose()
+        );
 
         if (!$this->doConditionsApply($action->getConditions())) {
             $this->io->write('<comment>skipped</comment>', true);
@@ -476,8 +478,7 @@ private function executeHookPluginsFor(string $method, ?Config\Action $action =
         $plugins = $this->getHookPlugins();
 
         if (count($plugins) === 0) {
-            $this->io->write(['', 'No plugins to execute for: <comment>' . $method . '</comment>'], true, IO::DEBUG);
-
+            $this->io->write(['No plugins to execute for: <comment>' . $method . '</comment>'], true, IO::DEBUG);
             return;
         }
 
@@ -487,7 +488,7 @@ private function executeHookPluginsFor(string $method, ?Config\Action $action =
             $params[] = $action;
         }
 
-        $this->io->write(['', 'Executing plugins for: <comment>' . $method . '</comment>'], true, IO::DEBUG);
+        $this->io->write(['Executing plugins for: <comment>' . $method . '</comment>'], true, IO::DEBUG);
 
         foreach ($plugins as $plugin) {
             $this->io->write('<info>- Running ' . get_class($plugin) . '::' . $method . '</info>', true, IO::DEBUG);

tests/unit/Runner/HookTest.php

@@ -167,9 +167,9 @@ public function testRunHookWithPlugins(): void
             $pluginConfig5,
         ]);
 
-        $io = $this->createIOMock();
-        $repo = $this->createRepositoryMock();
-        $hookConfig = $this->createHookConfigMock();
+        $io           = $this->createIOMock();
+        $repo         = $this->createRepositoryMock();
+        $hookConfig   = $this->createHookConfigMock();
         $actionConfig = $this->createActionConfigMock();
         $actionConfig->method('getAction')->willReturn(CH_PATH_FILES . '/bin/success');
         $hookConfig->expects($this->atLeastOnce())->method('isEnabled')->willReturn(true);