build(deps): Upgrade to phpdocumentor/reflection-docblock 5.4 (#1357)

box-project · Apr 23, 2024 · 68c1ba7 · 68c1ba7
1 parent 6aae0ae
commit 68c1ba7
Show file tree

Hide file tree

Showing 4 changed files with 44 additions and 17 deletions.
diff --git a/composer.json b/composer.json
@@ -30,7 +30,7 @@
         "humbug/php-scoper": "^0.18.6",
         "justinrainbow/json-schema": "^5.2.12",
         "nikic/iter": "^2.2",
-        "phpdocumentor/reflection-docblock": "^5.3",
+        "phpdocumentor/reflection-docblock": "^5.4",
         "phpdocumentor/type-resolver": "^1.7",
         "psr/log": "^3.0",
         "sebastian/diff": "^5.0",

diff --git a/composer.lock b/composer.lock
diff --git a/src/Annotation/CompactedFormatter.php b/src/Annotation/CompactedFormatter.php
@@ -17,18 +17,38 @@
 use phpDocumentor\Reflection\DocBlock\Tag;
 use phpDocumentor\Reflection\DocBlock\Tags\Formatter;
 use phpDocumentor\Reflection\DocBlock\Tags\Generic;
+use phpDocumentor\Reflection\DocBlock\Tags\InvalidTag;
 use function array_map;
 use function explode;
 use function implode;
+use function sprintf;
 
 final class CompactedFormatter implements Formatter
 {
     public function format(Tag $tag): string
     {
-        if (!$tag instanceof Generic) {
-            return trim('@'.$tag->getName());
+        if ($tag instanceof InvalidTag) {
+            return self::formatInvalidTag($tag);
+        }
+
+        if ($tag instanceof Generic) {
+            return self::formatGenericTag($tag);
         }
 
+        return trim('@'.$tag->getName());
+    }
+
+    private static function formatInvalidTag(InvalidTag $tag): string
+    {
+        return sprintf(
+            '@%s %s',
+            $tag->getName(),
+            $tag,
+        );
+    }
+
+    private static function formatGenericTag(Generic $tag): string
+    {
         $description = (string) $tag;
 
         if (!str_starts_with($description, '(')) {

diff --git a/tests/Compactor/PhpTest.php b/tests/Compactor/PhpTest.php
@@ -423,8 +423,8 @@ function foo($x) {
                 <?php
 
                 /**
-                 * @param (string|stdClass $x
-                 */
+                @param (string|stdClass $x
+                */
                 function foo($x) {
                 }
                 PHP,