From e80305ead957e2f12a56b091c26ac4b7bb719c2c Mon Sep 17 00:00:00 2001
From: rhertogh <rhertogh@users.noreply.github.com>
Date: Sun, 16 Jul 2023 00:51:12 +0200
Subject: [PATCH 1/2] Support "one-line" comments (starting with //)

---
 src/Parser/TokenIterator.php            |  33 +++++++
 src/Parser/TypeParser.php               |   1 +
 tests/PHPStan/Parser/TypeParserTest.php | 116 ++++++++++++++++++++++++
 3 files changed, 150 insertions(+)

diff --git a/src/Parser/TokenIterator.php b/src/Parser/TokenIterator.php
index 9be7593d..b0df9411 100644
--- a/src/Parser/TokenIterator.php
+++ b/src/Parser/TokenIterator.php
@@ -380,4 +380,37 @@ public function hasParentheses(int $startPos, int $endPos): bool
 			&& $this->hasTokenImmediatelyAfter($endPos, Lexer::TOKEN_CLOSE_PARENTHESES);
 	}
 
+	/**
+	 * Strip PHP style "one-line" comments (text starting with //)
+	 */
+	public function stripComments(): void
+	{
+		$line = 1;
+		$cleanTokens = [];
+		for ($i = 0; $i < count($this->tokens); $i++) {
+			$token = $this->tokens[$i];
+			if (
+				$token[Lexer::TYPE_OFFSET] === Lexer::TOKEN_OTHER
+				&& strpos($token[Lexer::VALUE_OFFSET], '//') === 0
+			) {
+				while (
+					strpos($this->tokens[$i][Lexer::VALUE_OFFSET], "\n") === false
+					&& $i < count($this->tokens)
+				) {
+					$i++;
+				}
+				if ($this->tokens[$i][Lexer::LINE_OFFSET] !== $line) {
+					for ($j = $i + 1; $j < count($this->tokens); $j++) {
+						$this->tokens[$j][Lexer::LINE_OFFSET]--;
+					}
+				}
+			} else {
+				$cleanTokens[] = $token;
+				$line = $token[Lexer::LINE_OFFSET];
+			}
+		}
+
+		$this->tokens = $cleanTokens;
+	}
+
 }
diff --git a/src/Parser/TypeParser.php b/src/Parser/TypeParser.php
index 645f544b..a360d113 100644
--- a/src/Parser/TypeParser.php
+++ b/src/Parser/TypeParser.php
@@ -43,6 +43,7 @@ public function __construct(
 	/** @phpstan-impure */
 	public function parse(TokenIterator $tokens): Ast\Type\TypeNode
 	{
+		$tokens->stripComments();
 		$startLine = $tokens->currentTokenLine();
 		$startIndex = $tokens->currentTokenIndex();
 		if ($tokens->isCurrentTokenType(Lexer::TOKEN_NULLABLE)) {
diff --git a/tests/PHPStan/Parser/TypeParserTest.php b/tests/PHPStan/Parser/TypeParserTest.php
index 85ae0db8..e6bc8511 100644
--- a/tests/PHPStan/Parser/TypeParserTest.php
+++ b/tests/PHPStan/Parser/TypeParserTest.php
@@ -1289,6 +1289,122 @@ public function provideParseData(): array
 				'int|array{}',
 				new UnionTypeNode([new IdentifierTypeNode('int'), new ArrayShapeNode([])]),
 			],
+			[
+				<<<EOT
+				array{ // Array with comments
+			        // Array with single quoted keys
+			        'single quote keys': array{            // Single quoted key
+			            'single_quote_key//1': int,        // Single quoted key with //
+			            'single_quote_key\'//2': string,   // Single quoted key with ' and //
+			            'single_quote_key\'//\'3': bool,   // Single quoted key with 2x ' and //
+			            'single_quote_key"//"4': float,    // Single quoted key with 2x " and //
+			            'single_quote_key"//\'5': array{   // Single quoted key with ', " and //
+			                'single_quote_key//5//1': int, // Single quoted key with 2x //
+			            },
+			            // 'commented_out_array_element//1': int
+			            'single_quote_key//no_whitespace':int,//Single quoted key without whitespace
+			        },
+			        // Array with double quoted keys
+			        "double quote keys": array{           // Double quoted key
+			            "double_quote_key//1": int,        // Double quoted key with //
+			            "double_quote_key'//2": string,    // Double quoted key with ' and //
+			            "double_quote_key\"//\"3": bool,   // Double quoted key with 2x ' and //
+			            "double_quote_key'//'4": float,    // Double quoted key with 2x " and //
+			            "double_quote_key\"//'5": array{  // Double quoted key with ', " and //
+			                "double_quote_key//5//1": int, // Double quoted key with 2x //
+			            },
+			            // "commented_out_array_element//1": int
+			            "double_quote_key//no_whitespace":int,//Double quoted key without whitespace
+			        },
+			    }
+EOT,
+				new ArrayShapeNode([
+					new ArrayShapeItemNode(
+						new QuoteAwareConstExprStringNode('single quote keys', QuoteAwareConstExprStringNode::SINGLE_QUOTED),
+						false,
+						new ArrayShapeNode([
+							new ArrayShapeItemNode(
+								new QuoteAwareConstExprStringNode('single_quote_key//1', QuoteAwareConstExprStringNode::SINGLE_QUOTED),
+								false,
+								new IdentifierTypeNode('int')
+							),
+							new ArrayShapeItemNode(
+								new QuoteAwareConstExprStringNode('single_quote_key\'//2', QuoteAwareConstExprStringNode::SINGLE_QUOTED),
+								false,
+								new IdentifierTypeNode('string')
+							),
+							new ArrayShapeItemNode(
+								new QuoteAwareConstExprStringNode('single_quote_key\'//\'3', QuoteAwareConstExprStringNode::SINGLE_QUOTED),
+								false,
+								new IdentifierTypeNode('bool')
+							),
+							new ArrayShapeItemNode(
+								new QuoteAwareConstExprStringNode('single_quote_key"//"4', QuoteAwareConstExprStringNode::SINGLE_QUOTED),
+								false,
+								new IdentifierTypeNode('float')
+							),
+							new ArrayShapeItemNode(
+								new QuoteAwareConstExprStringNode('single_quote_key"//\'5', QuoteAwareConstExprStringNode::SINGLE_QUOTED),
+								false,
+								new ArrayShapeNode([
+									new ArrayShapeItemNode(
+										new QuoteAwareConstExprStringNode('single_quote_key//5//1', QuoteAwareConstExprStringNode::SINGLE_QUOTED),
+										false,
+										new IdentifierTypeNode('int')
+									),
+								])
+							),
+							new ArrayShapeItemNode(
+								new QuoteAwareConstExprStringNode('single_quote_key//no_whitespace', QuoteAwareConstExprStringNode::SINGLE_QUOTED),
+								false,
+								new IdentifierTypeNode('int')
+							),
+						])
+					),
+					new ArrayShapeItemNode(
+						new QuoteAwareConstExprStringNode("double quote keys", QuoteAwareConstExprStringNode::DOUBLE_QUOTED),
+						false,
+						new ArrayShapeNode([
+							new ArrayShapeItemNode(
+								new QuoteAwareConstExprStringNode("double_quote_key//1", QuoteAwareConstExprStringNode::DOUBLE_QUOTED),
+								false,
+								new IdentifierTypeNode('int')
+							),
+							new ArrayShapeItemNode(
+								new QuoteAwareConstExprStringNode("double_quote_key'//2", QuoteAwareConstExprStringNode::DOUBLE_QUOTED),
+								false,
+								new IdentifierTypeNode('string')
+							),
+							new ArrayShapeItemNode(
+								new QuoteAwareConstExprStringNode("double_quote_key\"//\"3", QuoteAwareConstExprStringNode::DOUBLE_QUOTED),
+								false,
+								new IdentifierTypeNode('bool')
+							),
+							new ArrayShapeItemNode(
+								new QuoteAwareConstExprStringNode("double_quote_key'//'4", QuoteAwareConstExprStringNode::DOUBLE_QUOTED),
+								false,
+								new IdentifierTypeNode('float')
+							),
+							new ArrayShapeItemNode(
+								new QuoteAwareConstExprStringNode("double_quote_key\"//'5", QuoteAwareConstExprStringNode::DOUBLE_QUOTED),
+								false,
+								new ArrayShapeNode([
+									new ArrayShapeItemNode(
+										new QuoteAwareConstExprStringNode("double_quote_key//5//1", QuoteAwareConstExprStringNode::DOUBLE_QUOTED),
+										false,
+										new IdentifierTypeNode('int')
+									),
+								])
+							),
+							new ArrayShapeItemNode(
+								new QuoteAwareConstExprStringNode('double_quote_key//no_whitespace', QuoteAwareConstExprStringNode::DOUBLE_QUOTED),
+								false,
+								new IdentifierTypeNode('int')
+							),
+						])
+					),
+				]),
+			],
 			[
 				'callable(' . PHP_EOL .
 				'  Foo' . PHP_EOL .

From 5b055b1591575384db1753491f5fa7f915c21007 Mon Sep 17 00:00:00 2001
From: rhertogh <rhertogh@users.noreply.github.com>
Date: Sun, 16 Jul 2023 01:17:44 +0200
Subject: [PATCH 2/2] Fixed coding standards and linting for 'support
 "one-line" comments' changes

---
 src/Parser/TokenIterator.php            | 1 +
 tests/PHPStan/Parser/TypeParserTest.php | 8 ++++----
 2 files changed, 5 insertions(+), 4 deletions(-)

diff --git a/src/Parser/TokenIterator.php b/src/Parser/TokenIterator.php
index b0df9411..fd1e9fe5 100644
--- a/src/Parser/TokenIterator.php
+++ b/src/Parser/TokenIterator.php
@@ -9,6 +9,7 @@
 use function count;
 use function in_array;
 use function strlen;
+use function strpos;
 use function substr;
 
 class TokenIterator
diff --git a/tests/PHPStan/Parser/TypeParserTest.php b/tests/PHPStan/Parser/TypeParserTest.php
index e6bc8511..29b09eed 100644
--- a/tests/PHPStan/Parser/TypeParserTest.php
+++ b/tests/PHPStan/Parser/TypeParserTest.php
@@ -1362,11 +1362,11 @@ public function provideParseData(): array
 						])
 					),
 					new ArrayShapeItemNode(
-						new QuoteAwareConstExprStringNode("double quote keys", QuoteAwareConstExprStringNode::DOUBLE_QUOTED),
+						new QuoteAwareConstExprStringNode('double quote keys', QuoteAwareConstExprStringNode::DOUBLE_QUOTED),
 						false,
 						new ArrayShapeNode([
 							new ArrayShapeItemNode(
-								new QuoteAwareConstExprStringNode("double_quote_key//1", QuoteAwareConstExprStringNode::DOUBLE_QUOTED),
+								new QuoteAwareConstExprStringNode('double_quote_key//1', QuoteAwareConstExprStringNode::DOUBLE_QUOTED),
 								false,
 								new IdentifierTypeNode('int')
 							),
@@ -1376,7 +1376,7 @@ public function provideParseData(): array
 								new IdentifierTypeNode('string')
 							),
 							new ArrayShapeItemNode(
-								new QuoteAwareConstExprStringNode("double_quote_key\"//\"3", QuoteAwareConstExprStringNode::DOUBLE_QUOTED),
+								new QuoteAwareConstExprStringNode('double_quote_key"//"3', QuoteAwareConstExprStringNode::DOUBLE_QUOTED),
 								false,
 								new IdentifierTypeNode('bool')
 							),
@@ -1390,7 +1390,7 @@ public function provideParseData(): array
 								false,
 								new ArrayShapeNode([
 									new ArrayShapeItemNode(
-										new QuoteAwareConstExprStringNode("double_quote_key//5//1", QuoteAwareConstExprStringNode::DOUBLE_QUOTED),
+										new QuoteAwareConstExprStringNode('double_quote_key//5//1', QuoteAwareConstExprStringNode::DOUBLE_QUOTED),
 										false,
 										new IdentifierTypeNode('int')
 									),