fix HTML description detection for phpstorm stubs

phpstan · Nov 17, 2023 · 0601081 · 0601081
1 parent c2b8bbf
commit 0601081
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 2 deletions.
diff --git a/src/Parser/TypeParser.php b/src/Parser/TypeParser.php
@@ -380,10 +380,16 @@ public function isHtml(TokenIterator $tokens): bool
 			return false;
 		}
 
+		$endTag = '</' . $htmlTagName . '>';
+		$endTagSearchOffset = - strlen($endTag);
+
 		while (!$tokens->isCurrentTokenType(Lexer::TOKEN_END)) {
 			if (
-				$tokens->tryConsumeTokenType(Lexer::TOKEN_OPEN_ANGLE_BRACKET)
-				&& strpos($tokens->currentTokenValue(), '/' . $htmlTagName . '>') !== false
+				(
+					$tokens->tryConsumeTokenType(Lexer::TOKEN_OPEN_ANGLE_BRACKET)
+					&& strpos($tokens->currentTokenValue(), '/' . $htmlTagName . '>') !== false
+				)
+				|| substr_compare($tokens->currentTokenValue(), $endTag, $endTagSearchOffset) === 0
 			) {
 				return true;
 			}

diff --git a/tests/PHPStan/Parser/PhpDocParserTest.php b/tests/PHPStan/Parser/PhpDocParserTest.php
@@ -1301,6 +1301,20 @@ public function provideReturnTagsData(): Iterator
 			]),
 		];
 
+		yield [
+			'OK with HTML description',
+			'/** @return MongoCollection <p>Returns a collection object representing the new collection.</p> */',
+			new PhpDocNode([
+				new PhpDocTagNode(
+					'@return',
+					new ReturnTagValueNode(
+						new IdentifierTypeNode('MongoCollection'),
+						'<p>Returns a collection object representing the new collection.</p>'
+					)
+				),
+			]),
+		];
+
 		yield [
 			'invalid without type and description',
 			'/** @return */',

diff --git a/tests/PHPStan/Parser/TypeParserTest.php b/tests/PHPStan/Parser/TypeParserTest.php
@@ -2166,6 +2166,11 @@ public function provideParseData(): array
 					false
 				)),
 			],
+			[
+				'MongoCollection <p>Returns a collection object representing the new collection.</p>',
+				new IdentifierTypeNode('MongoCollection'),
+				Lexer::TOKEN_OPEN_ANGLE_BRACKET,
+			],
 		];
 	}