Skip to content

Commit 5164f16

Browse files
ondrejmirtesondrejmirtes
committed
New option to attach text between tags as description to the tag above
1 parent f9311f0 commit 5164f16

File tree

2 files changed

+115
-5
lines changed

2 files changed

+115
-5
lines changed

‎src/Parser/PhpDocParser.php‎

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ class PhpDocParser
4949
/** @var bool */
5050
private $useIndexAttributes;
5151

52+
/** @var bool */
53+
private $textBetweenTagsBelongsToDescription;
54+
5255
/**
5356
* @param array{lines?: bool, indexes?: bool} $usedAttributes
5457
*/
@@ -58,7 +61,8 @@ public function __construct(
5861
bool $requireWhitespaceBeforeDescription = false,
5962
bool $preserveTypeAliasesWithInvalidTypes = false,
6063
array $usedAttributes = [],
61-
bool $parseDoctrineAnnotations = false
64+
bool $parseDoctrineAnnotations = false,
65+
bool $textBetweenTagsBelongsToDescription = false
6266
)
6367
{
6468
$this->typeParser = $typeParser;
@@ -68,6 +72,7 @@ public function __construct(
6872
$this->parseDoctrineAnnotations = $parseDoctrineAnnotations;
6973
$this->useLinesAttributes = $usedAttributes['lines'] ?? false;
7074
$this->useIndexAttributes = $usedAttributes['indexes'] ?? false;
75+
$this->textBetweenTagsBelongsToDescription = $textBetweenTagsBelongsToDescription;
7176
}
7277

7378

@@ -215,10 +220,13 @@ private function parseText(TokenIterator $tokens): Ast\PhpDoc\PhpDocTextNode
215220
$text = '';
216221

217222
$endTokens = [Lexer::TOKEN_PHPDOC_EOL, Lexer::TOKEN_CLOSE_PHPDOC, Lexer::TOKEN_END];
223+
if ($this->textBetweenTagsBelongsToDescription) {
224+
$endTokens = [Lexer::TOKEN_CLOSE_PHPDOC, Lexer::TOKEN_END];
225+
}
218226

219227
// if the next token is EOL, everything below is skipped and empty string is returned
220-
while (!$tokens->isCurrentTokenType(Lexer::TOKEN_PHPDOC_EOL)) {
221-
$text .= $tokens->getSkippedHorizontalWhiteSpaceIfAny() . $tokens->joinUntil(...$endTokens);
228+
while ($this->textBetweenTagsBelongsToDescription || !$tokens->isCurrentTokenType(Lexer::TOKEN_PHPDOC_EOL)) {
229+
$text .= $tokens->getSkippedHorizontalWhiteSpaceIfAny() . $tokens->joinUntil(Lexer::TOKEN_PHPDOC_EOL, ...$endTokens);
222230

223231
// stop if we're not at EOL - meaning it's the end of PHPDoc
224232
if (!$tokens->isCurrentTokenType(Lexer::TOKEN_PHPDOC_EOL)) {
@@ -250,10 +258,13 @@ private function parseOptionalDescriptionAfterDoctrineTag(TokenIterator $tokens)
250258
$text = '';
251259

252260
$endTokens = [Lexer::TOKEN_PHPDOC_EOL, Lexer::TOKEN_CLOSE_PHPDOC, Lexer::TOKEN_END];
261+
if ($this->textBetweenTagsBelongsToDescription) {
262+
$endTokens = [Lexer::TOKEN_CLOSE_PHPDOC, Lexer::TOKEN_END];
263+
}
253264

254265
// if the next token is EOL, everything below is skipped and empty string is returned
255-
while (!$tokens->isCurrentTokenType(Lexer::TOKEN_PHPDOC_EOL)) {
256-
$text .= $tokens->getSkippedHorizontalWhiteSpaceIfAny() . $tokens->joinUntil(Lexer::TOKEN_PHPDOC_TAG, Lexer::TOKEN_DOCTRINE_TAG, ...$endTokens);
266+
while ($this->textBetweenTagsBelongsToDescription || !$tokens->isCurrentTokenType(Lexer::TOKEN_PHPDOC_EOL)) {
267+
$text .= $tokens->getSkippedHorizontalWhiteSpaceIfAny() . $tokens->joinUntil(Lexer::TOKEN_PHPDOC_TAG, Lexer::TOKEN_DOCTRINE_TAG, Lexer::TOKEN_PHPDOC_EOL, ...$endTokens);
257268

258269
// stop if we're not at EOL - meaning it's the end of PHPDoc
259270
if (!$tokens->isCurrentTokenType(Lexer::TOKEN_PHPDOC_EOL)) {

‎tests/PHPStan/Parser/PhpDocParserTest.php‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6682,4 +6682,103 @@ public function testDoctrine(
66826682
$this->assertEquals($expectedAnnotations, $parser->parse($input, $label), $label);
66836683
}
66846684

6685+
/**
6686+
* @return iterable<array{string, PhpDocNode}>
6687+
*/
6688+
public function dataTextBetweenTagsBelongsToDescription(): iterable
6689+
{
6690+
yield [
6691+
'/**' . PHP_EOL .
6692+
' * Real description' . PHP_EOL .
6693+
' * @param int $a' . PHP_EOL .
6694+
' * paramA description' . PHP_EOL .
6695+
' * @param int $b' . PHP_EOL .
6696+
' * paramB description' . PHP_EOL .
6697+
' */',
6698+
new PhpDocNode([
6699+
new PhpDocTextNode('Real description'),
6700+
new PhpDocTagNode('@param', new ParamTagValueNode(new IdentifierTypeNode('int'), false, '$a', PHP_EOL . ' paramA description')),
6701+
new PhpDocTagNode('@param', new ParamTagValueNode(new IdentifierTypeNode('int'), false, '$b', PHP_EOL . ' paramB description')),
6702+
]),
6703+
];
6704+
6705+
yield [
6706+
'/**' . PHP_EOL .
6707+
' * Real description' . PHP_EOL .
6708+
' * @param int $a aaaa' . PHP_EOL .
6709+
' * bbbb' . PHP_EOL .
6710+
' *' . PHP_EOL .
6711+
' * ccc' . PHP_EOL .
6712+
' */',
6713+
new PhpDocNode([
6714+
new PhpDocTextNode('Real description'),
6715+
new PhpDocTagNode('@param', new ParamTagValueNode(new IdentifierTypeNode('int'), false, '$a', 'aaaa' . PHP_EOL . ' bbbb' . PHP_EOL . PHP_EOL . 'ccc')),
6716+
]),
6717+
];
6718+
6719+
yield [
6720+
'/**' . PHP_EOL .
6721+
' * Real description' . PHP_EOL .
6722+
' * @ORM\Column()' . PHP_EOL .
6723+
' * bbbb' . PHP_EOL .
6724+
' *' . PHP_EOL .
6725+
' * ccc' . PHP_EOL .
6726+
' */',
6727+
new PhpDocNode([
6728+
new PhpDocTextNode('Real description'),
6729+
new PhpDocTagNode('@ORM\Column', new DoctrineTagValueNode(new DoctrineAnnotation('@ORM\Column', []), PHP_EOL . ' bbbb' . PHP_EOL . PHP_EOL . 'ccc')),
6730+
]),
6731+
];
6732+
6733+
yield [
6734+
'/**' . PHP_EOL .
6735+
' * Real description' . PHP_EOL .
6736+
' * @ORM\Column() aaaa' . PHP_EOL .
6737+
' * bbbb' . PHP_EOL .
6738+
' *' . PHP_EOL .
6739+
' * ccc' . PHP_EOL .
6740+
' */',
6741+
new PhpDocNode([
6742+
new PhpDocTextNode('Real description'),
6743+
new PhpDocTagNode('@ORM\Column', new DoctrineTagValueNode(new DoctrineAnnotation('@ORM\Column', []), 'aaaa' . PHP_EOL . ' bbbb' . PHP_EOL . PHP_EOL . 'ccc')),
6744+
]),
6745+
];
6746+
6747+
yield [
6748+
'/**' . PHP_EOL .
6749+
' * Real description' . PHP_EOL .
6750+
' * @ORM\Column() aaaa' . PHP_EOL .
6751+
' * bbbb' . PHP_EOL .
6752+
' *' . PHP_EOL .
6753+
' * ccc' . PHP_EOL .
6754+
' * @param int $b' . PHP_EOL .
6755+
' */',
6756+
new PhpDocNode([
6757+
new PhpDocTextNode('Real description'),
6758+
new PhpDocTagNode('@ORM\Column', new DoctrineTagValueNode(new DoctrineAnnotation('@ORM\Column', []), 'aaaa' . PHP_EOL . ' bbbb' . PHP_EOL . PHP_EOL . 'ccc')),
6759+
new PhpDocTagNode('@param', new ParamTagValueNode(new IdentifierTypeNode('int'), false, '$b', '')),
6760+
]),
6761+
];
6762+
}
6763+
6764+
/**
6765+
* @dataProvider dataTextBetweenTagsBelongsToDescription
6766+
*/
6767+
public function testTextBetweenTagsBelongsToDescription(
6768+
string $input,
6769+
PhpDocNode $expectedPhpDocNode
6770+
): void
6771+
{
6772+
$constExprParser = new ConstExprParser();
6773+
$typeParser = new TypeParser($constExprParser);
6774+
$phpDocParser = new PhpDocParser($typeParser, $constExprParser, true, true, [], true, true);
6775+
6776+
$tokens = new TokenIterator($this->lexer->tokenize($input));
6777+
$actualPhpDocNode = $phpDocParser->parse($tokens);
6778+
6779+
$this->assertEquals($expectedPhpDocNode, $actualPhpDocNode);
6780+
$this->assertSame((string) $expectedPhpDocNode, (string) $actualPhpDocNode);
6781+
$this->assertSame(Lexer::TOKEN_END, $tokens->currentTokenType());
6782+
}
6783+
66856784
}

0 commit comments

Comments
 (0)