Support typing extra items in unsealed array shapes

Author: tscni

src/Ast/Type/ArrayShapeNode.php

@@ -2,8 +2,11 @@
 
 namespace PHPStan\PhpDocParser\Ast\Type;
 
+use InvalidArgumentException;
 use PHPStan\PhpDocParser\Ast\NodeAttributes;
 use function implode;
+use function strlen;
+use function substr;
 
 class ArrayShapeNode implements TypeNode
 {
@@ -22,15 +25,27 @@ class ArrayShapeNode implements TypeNode
 	/** @var self::KIND_* */
 	public $kind;
 
+	/** @var GenericTypeNode|null */
+	public $extraItemType;
+
 	/**
 	 * @param ArrayShapeItemNode[] $items
 	 * @param self::KIND_* $kind
 	 */
-	public function __construct(array $items, bool $sealed = true, string $kind = self::KIND_ARRAY)
+	public function __construct(
+		array $items,
+		bool $sealed = true,
+		string $kind = self::KIND_ARRAY,
+		?GenericTypeNode $extraItemType = null
+	)
 	{
 		$this->items = $items;
 		$this->sealed = $sealed;
 		$this->kind = $kind;
+		$this->extraItemType = $extraItemType;
+		if ($sealed && $extraItemType !== null) {
+			throw new InvalidArgumentException('An extra item type may only be set for an unsealed array shape');
+		}
 	}
 
 
@@ -39,7 +54,11 @@ public function __toString(): string
 		$items = $this->items;
 
 		if (! $this->sealed) {
-			$items[] = '...';
+			$item = '...';
+			if ($this->extraItemType !== null) {
+				$item .= substr((string) $this->extraItemType, strlen((string) $this->extraItemType->type));
+			}
+			$items[] = $item;
 		}
 
 		return $this->kind . '{' . implode(', ', $items) . '}';

src/Parser/TypeParser.php

@@ -848,6 +848,7 @@ private function parseArrayShape(TokenIterator $tokens, Ast\Type\TypeNode $type,
 
 		$items = [];
 		$sealed = true;
+		$extraItemType = null;
 
 		do {
 			$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
@@ -858,6 +859,19 @@ private function parseArrayShape(TokenIterator $tokens, Ast\Type\TypeNode $type,
 
 			if ($tokens->tryConsumeTokenType(Lexer::TOKEN_VARIADIC)) {
 				$sealed = false;
+				$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
+				if ($tokens->isCurrentTokenType(Lexer::TOKEN_OPEN_ANGLE_BRACKET)) {
+					$extraItemType = $this->parseGeneric(
+						$tokens,
+						$this->enrichWithAttributes(
+							$tokens,
+							new Ast\Type\IdentifierTypeNode($kind),
+							$tokens->currentTokenLine(),
+							$tokens->currentTokenIndex()
+						)
+					);
+					$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
+				}
 				$tokens->tryConsumeTokenType(Lexer::TOKEN_COMMA);
 				break;
 			}
@@ -870,7 +884,7 @@ private function parseArrayShape(TokenIterator $tokens, Ast\Type\TypeNode $type,
 		$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
 		$tokens->consumeTokenType(Lexer::TOKEN_CLOSE_CURLY_BRACKET);
 
-		return new Ast\Type\ArrayShapeNode($items, $sealed, $kind);
+		return new Ast\Type\ArrayShapeNode($items, $sealed, $kind, $extraItemType);
 	}
 
 

src/Printer/Printer.php

@@ -74,6 +74,7 @@
 use function sprintf;
 use function strlen;
 use function strpos;
+use function substr;
 use function trim;
 use const PREG_SET_ORDER;
 
@@ -366,7 +367,11 @@ private function printType(TypeNode $node): string
 			}, $node->items);
 
 			if (! $node->sealed) {
-				$items[] = '...';
+				$item = '...';
+				if ($node->extraItemType !== null) {
+					$item .= substr($this->printType($node->extraItemType), strlen((string) $node->extraItemType->type));
+				}
+				$items[] = $item;
 			}
 
 			return $node->kind . '{' . implode(', ', $items) . '}';