support comments in array shape

Author: shmax

src/Ast/Type/ArrayShapeNode.php

@@ -33,6 +33,12 @@ public function __construct(array $items, bool $sealed = true, string $kind = se
 		$this->kind = $kind;
 	}
 
+	/**
+	 * @return array<ArrayShapeItemNode>
+	 */
+	public function items(): array {
+		return array_filter($this->items, fn ($item) => $item instanceof ArrayShapeItemNode);
+	}
 
 	public function __toString(): string
 	{
@@ -42,7 +48,18 @@ public function __toString(): string
 			$items[] = '...';
 		}
 
-		return $this->kind . '{' . implode(', ', $items) . '}';
+		$res = $this->kind . '{';
+		foreach($items as $idx => $item) {
+			$res .= $item;
+
+			if($item instanceof ArrayShapeItemNode && $idx < count($items) - 1) {
+				$res .= ', ';
+			}
+
+		}
+		$res .= '}';
+
+		return $res;
 	}
 
 }

src/Lexer/Lexer.php

@@ -50,6 +50,8 @@ class Lexer
 	public const TOKEN_NEGATED = 35;
 	public const TOKEN_ARROW = 36;
 
+	public const TOKEN_COMMENT = 37;
+
 	public const TOKEN_LABELS = [
 		self::TOKEN_REFERENCE => '\'&\'',
 		self::TOKEN_UNION => '\'|\'',
@@ -65,6 +67,7 @@ class Lexer
 		self::TOKEN_OPEN_CURLY_BRACKET => '\'{\'',
 		self::TOKEN_CLOSE_CURLY_BRACKET => '\'}\'',
 		self::TOKEN_COMMA => '\',\'',
+		self::TOKEN_COMMENT => '\'//\'',
 		self::TOKEN_COLON => '\':\'',
 		self::TOKEN_VARIADIC => '\'...\'',
 		self::TOKEN_DOUBLE_COLON => '\'::\'',
@@ -160,6 +163,7 @@ private function generateRegexp(): string
 			self::TOKEN_CLOSE_CURLY_BRACKET => '\\}',
 
 			self::TOKEN_COMMA => ',',
+			self::TOKEN_COMMENT => '//',
 			self::TOKEN_VARIADIC => '\\.\\.\\.',
 			self::TOKEN_DOUBLE_COLON => '::',
 			self::TOKEN_DOUBLE_ARROW => '=>',

src/Parser/TokenIterator.php

@@ -239,10 +239,10 @@ public function joinUntil(int ...$tokenType): string
 	}
 
 
-	public function next(): void
+	public function next(bool $skipIrrelevant = true): void
 	{
 		$this->index++;
-		$this->skipIrrelevantTokens();
+		$skipIrrelevant && $this->skipIrrelevantTokens();
 	}
 
 

src/Parser/TypeParser.php

@@ -749,7 +749,24 @@ private function parseArrayShape(TokenIterator $tokens, Ast\Type\TypeNode $type,
 		$sealed = true;
 
 		do {
-			$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
+			$tokens->pushSavePoint();
+			$tokens->next();
+			$tab = "\t";
+			if($tokens->currentTokenType() == Lexer::TOKEN_CLOSE_CURLY_BRACKET) {
+				$tab = '';
+			}
+			$tokens->rollback();
+			if($tokens->currentTokenType() == Lexer::TOKEN_PHPDOC_EOL) {
+				$startLine = $tokens->currentTokenLine();
+				$startIndex = $tokens->currentTokenIndex();
+				$items[] = $this->enrichWithAttributes(
+					$tokens,
+					new Ast\Type\IdentifierTypeNode("\n$tab"),
+					$startLine,
+					$startIndex
+				);
+				$tokens->next();
+			}
 
 			if ($tokens->tryConsumeTokenType(Lexer::TOKEN_CLOSE_CURLY_BRACKET)) {
 				return new Ast\Type\ArrayShapeNode($items, true, $kind);
@@ -761,6 +778,22 @@ private function parseArrayShape(TokenIterator $tokens, Ast\Type\TypeNode $type,
 				break;
 			}
 
+			if ($tokens->tryConsumeTokenType(Lexer::TOKEN_COMMENT)) {
+				$items[] = $this->parseSimpleComment($tokens);
+			}
+
+			if($tokens->currentTokenType() == Lexer::TOKEN_PHPDOC_EOL) {
+				$startLine = $tokens->currentTokenLine();
+				$startIndex = $tokens->currentTokenIndex();
+				$items[] = $this->enrichWithAttributes(
+					$tokens,
+					new Ast\Type\IdentifierTypeNode("\n\t"),
+					$startLine,
+					$startIndex
+				);
+				$tokens->next();
+			}
+
 			$items[] = $this->parseArrayShapeItem($tokens);
 
 			$tokens->tryConsumeTokenType(Lexer::TOKEN_PHPDOC_EOL);
@@ -772,6 +805,25 @@ private function parseArrayShape(TokenIterator $tokens, Ast\Type\TypeNode $type,
 		return new Ast\Type\ArrayShapeNode($items, $sealed, $kind);
 	}
 
+	private function parseSimpleComment(TokenIterator $tokens): Ast\Type\CommentNode
+	{
+		$startLine = $tokens->currentTokenLine();
+		$startIndex = $tokens->currentTokenIndex();
+
+		$text = '';
+
+		while($tokens->currentTokenType() != Lexer::TOKEN_PHPDOC_EOL) {
+			$text .= $tokens->currentTokenValue();
+			$tokens->next(false);
+		}
+
+		return $this->enrichWithAttributes(
+			$tokens,
+			new Ast\Type\CommentNode($text),
+			$startLine,
+			$startIndex
+		);
+	}
 
 	/** @phpstan-impure */
 	private function parseArrayShapeItem(TokenIterator $tokens): Ast\Type\ArrayShapeItemNode

src/Printer/Printer.php

@@ -339,15 +339,7 @@ private function printTagValue(PhpDocTagValueNode $node): string
 	private function printType(TypeNode $node): string
 	{
 		if ($node instanceof ArrayShapeNode) {
-			$items = array_map(function (ArrayShapeItemNode $item): string {
-				return $this->printType($item);
-			}, $node->items);
-
-			if (! $node->sealed) {
-				$items[] = '...';
-			}
-
-			return $node->kind . '{' . implode(', ', $items) . '}';
+			return (string)$node;
 		}
 		if ($node instanceof ArrayShapeItemNode) {
 			if ($node->keyName !== null) {