Improve error output and CI integration

Author: WyriHaximus

bin/openapi-client-generator.source

@@ -3,6 +3,7 @@
 
 use ApiClients\Tools\OpenApiClientGenerator\Configuration;
 use ApiClients\Tools\OpenApiClientGenerator\Generator;
+use ApiClients\Tools\OpenApiClientGenerator\Output\Error;
 use EventSauce\ObjectHydrator\ObjectMapperUsingReflection;
 use Symfony\Component\Yaml\Yaml;
 
@@ -14,20 +15,27 @@ use Symfony\Component\Yaml\Yaml;
 })();
 
 (function(string $configuration): void {
-    /**
-     * Create and boot up the application
-     */
-    exit((function (string $configurationFile): int {
-        $configuration = (new ObjectMapperUsingReflection())->hydrateObject(Configuration::class, Yaml::parseFile($configurationFile));
-        (new Generator(
-            $configuration,
-            dirname($configurationFile) . DIRECTORY_SEPARATOR,
-        ))->generate(
-            $configuration->namespace->source . '\\',
-            $configuration->namespace->test . '\\',
-            dirname($configurationFile) . DIRECTORY_SEPARATOR,
-        );
+    $exitCode = 1;
+    try {
+        /**
+         * Create and boot up the application
+         */
+        $exitCode = (function (string $configurationFile): int {
+            $configuration = (new ObjectMapperUsingReflection())->hydrateObject(Configuration::class, Yaml::parseFile($configurationFile));
+            (new Generator(
+                $configuration,
+                dirname($configurationFile) . DIRECTORY_SEPARATOR,
+            ))->generate(
+                $configuration->namespace->source . '\\',
+                $configuration->namespace->test . '\\',
+                dirname($configurationFile) . DIRECTORY_SEPARATOR,
+            );
 
-        return 0;
-    })($configuration));
+            return 0;
+        })($configuration);
+    } catch (Throwable $throwable) {
+        Error::display($throwable);
+    } finally {
+        exit ($exitCode);
+    }
 })($argv[1]);

src/Generator.php

@@ -26,7 +26,7 @@
 use ApiClients\Tools\OpenApiClientGenerator\Representation\Path;
 use ApiClients\Tools\OpenApiClientGenerator\State\File as StateFile;
 use ApiClients\Tools\OpenApiClientGenerator\State\Files;
-use ApiClients\Tools\OpenApiClientGenerator\StatusOutput\Step;
+use ApiClients\Tools\OpenApiClientGenerator\Output\Status\Step;
 use cebe\openapi\Reader;
 use cebe\openapi\spec\OpenApi;
 use EventSauce\ObjectHydrator\ObjectMapperUsingReflection;
@@ -76,15 +76,15 @@
     private State $state;
     private string $currentSpecHash;
 
-    private StatusOutput $statusOutput;
+    private Output\Status $statusOutput;
 
     public function __construct(
         private Configuration $configuration,
         string $configurationLocation,
     ) {
         $this->forceGeneration = is_string(getenv('FORCE_GENERATION')) && strlen(getenv('FORCE_GENERATION')) > 0;
 
-        $this->statusOutput = new StatusOutput(
+        $this->statusOutput = new Output\Status(
             ! (new CiDetector())->isCiDetected(),
             new Step('hash_current_spec', 'Hashing current spec', false),
             new Step('loading_state', 'Loading state', false),

src/Output/Error.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ApiClients\Tools\OpenApiClientGenerator\Output;
+
+use ApiClients\Tools\OpenApiClientGenerator\Output\Status\ANSI;
+use ApiClients\Tools\OpenApiClientGenerator\Output\Status\Simple;
+use ApiClients\Tools\OpenApiClientGenerator\Output\Status\Step;
+use OndraM\CiDetector\CiDetector;
+use function Termwind\render;
+
+final readonly class Error
+{
+    public static function display(\Throwable $throwable)
+    {
+        render('<div>
+            <div class="px-1 bg-red-600">ERROR</div>
+            <em class="ml-1">
+              ' . $throwable->getMessage() . '
+            </em>
+        </div>');
+
+        if ((new CiDetector())->detect()->getCiName() === CiDetector::CI_GITHUB_ACTIONS) {
+            file_put_contents(getenv('GITHUB_STEP_SUMMARY'), "### ⚠️ Error ⚠️\n```" . $throwable->getMessage() . "```\n", FILE_APPEND);
+        }
+    }
+}

src/StatusOutput.php renamed to src/Output/Status.php

@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace ApiClients\Tools\OpenApiClientGenerator;
+namespace ApiClients\Tools\OpenApiClientGenerator\Output;
 
-use ApiClients\Tools\OpenApiClientGenerator\StatusOutput\ANSI;
-use ApiClients\Tools\OpenApiClientGenerator\StatusOutput\Simple;
-use ApiClients\Tools\OpenApiClientGenerator\StatusOutput\Step;
+use ApiClients\Tools\OpenApiClientGenerator\Output\Status\ANSI;
+use ApiClients\Tools\OpenApiClientGenerator\Output\Status\Simple;
+use ApiClients\Tools\OpenApiClientGenerator\Output\Status\Step;
 
-final readonly class StatusOutput
+final readonly class Status
 {
     private ANSI|Simple $output;
 

src/StatusOutput/ANSI.php renamed to src/Output/Status/ANSI.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace ApiClients\Tools\OpenApiClientGenerator\StatusOutput;
+namespace ApiClients\Tools\OpenApiClientGenerator\Output\Status;
 
 use Symfony\Component\Console\Output\ConsoleOutput;
 

src/StatusOutput/OverWritingOutPut.php renamed to src/Output/Status/OverWritingOutPut.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace ApiClients\Tools\OpenApiClientGenerator\StatusOutput;
+namespace ApiClients\Tools\OpenApiClientGenerator\Output\Status;
 
 use Symfony\Component\Console\Formatter\OutputFormatterInterface;
 use Symfony\Component\Console\Output\OutputInterface;

src/StatusOutput/Simple.php renamed to src/Output/Status/Simple.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace ApiClients\Tools\OpenApiClientGenerator\StatusOutput;
+namespace ApiClients\Tools\OpenApiClientGenerator\Output\Status;
 
 use function array_combine;
 use function array_map;

src/StatusOutput/Step.php renamed to src/Output/Status/Step.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace ApiClients\Tools\OpenApiClientGenerator\StatusOutput;
+namespace ApiClients\Tools\OpenApiClientGenerator\Output\Status;
 
 final readonly class Step
 {