Add Scramble::throwOnError() to control exception handling (#645)

* Add Scramble::throwOnError() to control exception handling

* Update src/Scramble.php

* Update src/Scramble.php

* Update src/Scramble.php

* Update src/Support/OperationExtensions/RequestBodyExtension.php

* throw when testing

---------

Co-authored-by: romalytvynenko <[email protected]>

src/Scramble.php

@@ -47,6 +47,14 @@ class Scramble
      */
     public static array $extensions = [];
 
+    /**
+     * Whether to throw an exception during docs generation. When `false`, 
+     * documentation will be generated and issues added to the endpoint description 
+     * that failed generation. When `true`, the exception will be thrown and docs 
+     * generation will fail.
+     */
+    public static bool $throwOnError = false;
+
     /**
      * Disables registration of default API documentation routes.
      */
@@ -185,4 +193,14 @@ public static function getGeneratorConfig(string $api)
 
         return Scramble::$apis[$api];
     }
+
+    public static function throwOnError(bool $throw = true): void
+    {
+        static::$throwOnError = $throw;
+    }
+
+    public function shouldThrowOnError(): bool
+    {
+        return static::$throwOnError;
+    }
 }

src/Support/OperationExtensions/RequestBodyExtension.php

@@ -42,7 +42,7 @@ public function handle(Operation $operation, RouteInfo $routeInfo)
         try {
             $rulesResults = collect($this->extractRouteRequestValidationRules($routeInfo, $routeInfo->methodNode()));
         } catch (Throwable $exception) {
-            if (app()->environment('testing')) {
+            if (Scramble::shouldThrowOnError()) {
                 throw $exception;
             }
             $description = $description->append('⚠️Cannot generate request documentation: '.$exception->getMessage());

tests/TestCase.php

@@ -17,6 +17,8 @@ protected function setUp(): void
     {
         parent::setUp();
 
+        Scramble::throwOnError();
+
         $this->app->when(RulesToParameters::class)
             ->needs('$validationNodesResults')
             ->give([]);