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

Skip removing Psalm PhpDocTagNode #1829

Merged
merged 5 commits into from
Feb 18, 2022
Merged

Skip removing Psalm PhpDocTagNode #1829

merged 5 commits into from
Feb 18, 2022

Conversation

rajyan
Copy link
Contributor

@rajyan rajyan commented Feb 17, 2022 •
edited
Loading

closes #1799

leighman and others added 3 commits February 18, 2022 00:10
@leighman @rajyan
Add failing test for RemoveUselessReturnTagRector
77b929d 
Psalm allows prefixing of tags. Usually these would provide refinement on top of the type so should not be removed
@rajyan
fix test
e52d3a4
@rajyan
skip remove for psalm docs
8fe459d
@rajyan rajyan marked this pull request as ready for review February 17, 2022 16:07
@rajyan
Copy link
Contributor Author

rajyan commented Feb 17, 2022

@leighman

Hi, I cherry-picked your test case and tried to fix it.

@rajyan
Copy link
Contributor Author

rajyan commented Feb 17, 2022 •
edited
Loading

@samsonasik
39edeb3
This is a similar situation to this commit.

I changed to totally ignore psalm prefixed annotations because it's most time not intended to remove. What do you think about this change?

@rajyan rajyan changed the title Feature/psalm return type Ignore removing psalm Feb 17, 2022
@rajyan rajyan changed the title Ignore removing psalm Ignore removing Psalm PhpDocTagNode Feb 17, 2022
@rajyan rajyan changed the title Ignore removing Psalm PhpDocTagNode Skip removing Psalm PhpDocTagNode Feb 17, 2022
staabm
staabm reviewed Feb 17, 2022
View reviewed changes
packages/BetterPhpDocParser/PhpDocInfo/PhpDocInfo.php Outdated
@@ -305,7 +305,7 @@ public function removeByType(string $typeToRemove): void
$typeToRemove
): ?int {
if ($node instanceof PhpDocTagNode && is_a($node->value, $typeToRemove, true)) {
if ($typeToRemove === VarTagValueNode::class && $node->name !== '@var') {
if (str_starts_with($node->name, '@psalm-')) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this also skip "phpstan-" prefixed ones?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!
I looked into https://github.com/phpstan/phpdoc-parser/blob/d5a6692b8a74aeb00cc25e144f37a35da2bc31de/src/Parser/PhpDocParser.php#L121-L206
and decided to add "phpstan-" prefix too.

@rajyan rajyan force-pushed the feature/psalm-return-type branch from ff364ec to af06eb8 Compare February 18, 2022 01:00
@samsonasik samsonasik merged commit 323be2a into rectorphp:main Feb 18, 2022
@samsonasik
Copy link
Member

Thank you @rajyan @staabm

@rajyan rajyan deleted the feature/psalm-return-type branch February 18, 2022 01:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@staabm staabm staabm left review comments

@samsonasik samsonasik samsonasik approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@rajyan @samsonasik @staabm @leighman