Add json serialization support

Author: Kirill Nesmeyanov

composer.json

@@ -9,7 +9,8 @@
         "issues": "https://github.com/php-type-language/phpdoc/issues"
     },
     "require": {
-        "php": "^8.1"
+        "php": "^8.1",
+        "ext-json": "*"
     },
     "autoload": {
         "psr-4": {

src/DocBlock.php

@@ -21,6 +21,7 @@ final class DocBlock implements
     OptionalDescriptionProviderInterface,
     TagsProviderInterface,
     \IteratorAggregate,
+    \JsonSerializable,
     \ArrayAccess,
     \Countable
 {
@@ -94,6 +95,14 @@ public function getIterator(): \Traversable
         return new \ArrayIterator($this->tags);
     }
 
+    public function jsonSerialize(): array
+    {
+        return [
+            'description' => $this->description,
+            'tags' => $this->tags,
+        ];
+    }
+
     /**
      * @return int<0, max>
      */

src/Tag/Description/Description.php

@@ -37,6 +37,11 @@ public static function fromStringableOrNull(string|\Stringable|null $description
         return self::fromStringable($description);
     }
 
+    public function jsonSerialize(): string
+    {
+        return $this->value;
+    }
+
     public function __toString(): string
     {
         return $this->value;

src/Tag/Description/DescriptionInterface.php

@@ -8,7 +8,7 @@
  * Any class that implements this interface is a description object
  * that can be represented as a raw string scalar value.
  */
-interface DescriptionInterface extends \Stringable
+interface DescriptionInterface extends \JsonSerializable, \Stringable
 {
     /**
      * Returns a plain string representation of this description.

src/Tag/Description/TaggedDescription.php

@@ -88,6 +88,11 @@ public function offsetUnset(mixed $offset): void
         throw new \BadMethodCallException(static::class . ' objects are immutable');
     }
 
+    public function jsonSerialize(): array
+    {
+        return $this->components;
+    }
+
     public function __toString(): string
     {
         return \implode('', $this->components);

src/Tag/Tag.php

@@ -31,6 +31,14 @@ public function getDescription(): ?DescriptionInterface
         return $this->description;
     }
 
+    public function jsonSerialize(): array
+    {
+        return \array_filter([
+            'name' => $this->name,
+            'description' => $this->description,
+        ], static fn(mixed $value): bool => $value !== null);
+    }
+
     public function __toString(): string
     {
         if ($this->description === null) {

src/Tag/TagInterface.php

@@ -6,7 +6,10 @@
 
 use TypeLang\PHPDoc\Tag\Description\OptionalDescriptionProviderInterface;
 
-interface TagInterface extends OptionalDescriptionProviderInterface, \Stringable
+interface TagInterface extends
+    OptionalDescriptionProviderInterface,
+    \JsonSerializable,
+    \Stringable
 {
     /**
      * Returns the non-empty tag name string without the '@' prefix.