Allow extensions to add their own data to debug output

src/App/PrettyPHPCommand.php

@@ -1121,11 +1121,27 @@
                 continue;
             } catch (FormatterException $ex) {
                 Console::error('Unable to format:', $inputFile);
-                $this->maybeDumpDebugOutput($input, $ex->getOutput(), $ex->getTokens(), $ex->getLog(), $ex->getData());
+                $this->maybeDumpDebugOutput(
+                    $input,
+                    $ex->getOutput(),
+                    $ex->getTokens(),
+                    $ex->getLog(),
+                    $ex->getData(),
+                );
                 throw $ex;
             } catch (Throwable $ex) {
                 Console::error('Unable to format:', $inputFile);
-                $this->maybeDumpDebugOutput($input, null, $formatter->getTokens(), $formatter->Log, (string) $ex);
+                $data = [get_class($ex) => (string) $ex];
+                if ($this->Debug) {
+                    $data += $formatter->getExtensionData();
+                }
+                $this->maybeDumpDebugOutput(
+                    $input,
+                    null,
+                    $formatter->getTokens(),
+                    $formatter->Log,
+                    $data,
+                );
                 throw $ex;
             } finally {
                 Profile::stopTimer($inputFile, 'file');
@@ -1138,7 +1154,15 @@
             }
 
             if ($i === $count) {
-                $this->maybeDumpDebugOutput($input, $output, $formatter->getTokens(), $formatter->Log, null);
+                $this->maybeDumpDebugOutput(
+                    $input,
+                    $output,
+                    $formatter->getTokens(),
+                    $formatter->Log,
+                    $this->Debug
+                        ? $formatter->getExtensionData()
+                        : null,
+                );
             }
 
             if ($this->Diff !== null || $this->Check) {
@@ -1660,7 +1684,7 @@
         $files += [
             'input.php' => $input,
             'output.php' => $output,
-            'tokens.json' => $tokens,
+            'tokens.json' => $tokens !== null ? (object) $tokens : null,
             'data.out' => is_string($data) ? $data : null,
             'data.json' => is_string($data) ? null : $data,
         ];
@@ -1674,7 +1698,7 @@
             if (!is_string($out)) {
                 $out = Json::prettyPrint(
                     $out,
-                    \JSON_FORCE_OBJECT | \JSON_INVALID_UTF8_IGNORE
+                    \JSON_INVALID_UTF8_IGNORE
                 ) . \PHP_EOL;
             }
             File::writeContents($file, $out);

src/Concern/ExtensionTrait.php

@@ -31,4 +31,12 @@ public function boot(): void {}
      * @inheritDoc
      */
     public function reset(): void {}
+
+    /**
+     * @inheritDoc
+     */
+    public function getData(): array
+    {
+        return [];
+    }
 }

src/Contract/Extension.php

@@ -25,4 +25,13 @@ public function boot(): void;
      * Called once per document, before formatting begins.
      */
     public function reset(): void;
+
+    /**
+     * Get extension data as an associative array
+     *
+     * Called when generating debug output.
+     *
+     * @return array<string,mixed>
+     */
+    public function getData(): array;
 }

src/Exception/FormatterException.php

@@ -49,11 +49,11 @@ public function __construct(
      */
     public function getMetadata(): array
     {
-        $flags = \JSON_FORCE_OBJECT | \JSON_INVALID_UTF8_IGNORE;
+        $flags = \JSON_INVALID_UTF8_IGNORE;
 
         return [
             'output' => $this->Output,
-            'tokens' => Json::prettyPrint($this->Tokens, $flags),
+            'tokens' => Json::prettyPrint($this->Tokens !== null ? (object) $this->Tokens : null, $flags),
             'data' => Json::prettyPrint($this->Data, $flags),
         ];
     }

src/Formatter.php

@@ -1202,8 +1202,8 @@
                 null,
                 $this->Debug ? $this->Tokens : null,
                 $this->Log,
-                null,
-                $ex
+                $this->Debug ? $this->getExtensionData() : null,
+                $ex,
             );
             // @codeCoverageIgnoreEnd
         } finally {
@@ -1239,8 +1239,8 @@
                 $out,
                 $this->Tokens ?? null,
                 $this->Log,
-                null,
-                $ex
+                $this->Debug ? $this->getExtensionData() : null,
+                $ex,
             );
             // @codeCoverageIgnoreEnd
         } finally {
@@ -1263,7 +1263,7 @@
                 $out,
                 $this->Tokens ?? null,
                 $this->Log,
-                ['before' => $before, 'after' => $after]
+                $this->Debug ? $this->getExtensionData() : null,
             );
             // @codeCoverageIgnoreEnd
         }
@@ -1400,6 +1400,21 @@
         );
     }
 
+    /**
+     * Get extension data as an array of associative arrays
+     *
+     * @return array<class-string<Extension>,non-empty-array<string,mixed>>
+     */
+    public function getExtensionData(): array
+    {
+        foreach ($this->Extensions ?? [] as $_ext => $ext) {
+            if ($_data = $ext->getData()) {
+                $data[$_ext] = $_data;
+            }
+        }
+        return $data ?? [];
+    }
+
     /**
      * @template T of Extension
      *
@@ -1561,7 +1576,8 @@
                 null,
                 $this->Tokens,
                 $this->Log,
-                $ex
+                $this->getExtensionData(),
+                $ex,
             );
         } finally {
             Profile::stopTimer(__METHOD__ . '#render');