Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Reject @psalm-consistent-constructor in function docblocks #8713

Merged
merged 1 commit into from Nov 18, 2022
Merged

Reject @psalm-consistent-constructor in function docblocks #8713

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
42 changes: 35 additions & 7 deletions src/Psalm/Internal/PhpVisitor/Reflector/FunctionLikeDocblockParser.php
View file
Open in desktop
Expand Up @@ -15,6 +15,7 @@
use Psalm\Issue\InvalidDocblock;
use Psalm\IssueBuffer;

use function array_keys;
use function array_shift;
use function array_unique;
use function count;
Expand Down Expand Up @@ -704,17 +705,44 @@ private static function checkUnexpectedTags(
PhpParser\Comment\Doc $comment
): void {
if (isset($parsed_docblock->tags['psalm-import-type'])) {
foreach ($parsed_docblock->tags['psalm-import-type'] as $offset => $_) {
$info->unexpected_tags['psalm-import-type']['lines'][] = self::docblockLineNumber($comment, $offset);
}
$info->unexpected_tags['psalm-import-type']['lines'] = self::tagOffsetsToLines(
array_keys($parsed_docblock->tags['psalm-import-type']),
$comment
);
}

if (isset($parsed_docblock->combined_tags['var'])) {
$info->unexpected_tags['var'] = ['lines' => [], 'suggested_replacement' => 'param'];
foreach ($parsed_docblock->combined_tags['var'] as $offset => $_) {
$info->unexpected_tags['var']['lines'][] = self::docblockLineNumber($comment, $offset);
}
$info->unexpected_tags['var'] = [
'lines' => self::tagOffsetsToLines(
array_keys($parsed_docblock->combined_tags['var']),
$comment
),
'suggested_replacement' => 'param'
];
}

if (isset($parsed_docblock->tags['psalm-consistent-constructor'])) {
$info->unexpected_tags['psalm-consistent-constructor'] = [
'lines' => self::tagOffsetsToLines(
array_keys($parsed_docblock->tags['psalm-consistent-constructor']),
$comment
),
'suggested_replacement' => 'psalm-consistent-constructor on a class level',
];
}
}

/**
* @param list<int> $offsets
* @return list<int>
*/
private static function tagOffsetsToLines(array $offsets, PhpParser\Comment\Doc $comment): array
{
$ret = [];
foreach ($offsets as $offset) {
$ret[] = self::docblockLineNumber($comment, $offset);
}
return $ret;
}

private static function docblockLineNumber(PhpParser\Comment\Doc $comment, int $offset): int
Expand Down
5 changes: 5 additions & 0 deletions tests/FunctionLikeDocblockParserTest.php
View file
Open in desktop
Expand Up @@ -135,6 +135,7 @@ public function testReturnsUnexpectedTags(): void
$doc = '/**
* @psalm-import-type abcd
* @var int $p
* @psalm-consistent-constructor
*/
';
$php_parser_doc = new Doc($doc, 0);
Expand All @@ -147,6 +148,10 @@ public function testReturnsUnexpectedTags(): void
[
'psalm-import-type' => ['lines' => [1]],
'var' => ['lines' => [2], 'suggested_replacement' => 'param'],
'psalm-consistent-constructor' => [
'lines' => [3],
'suggested_replacement' => 'psalm-consistent-constructor on a class level'
]
],
$function_docblock->unexpected_tags
);
Expand Down