fix(dead-code): preserve generic @return tags in `RemoveReturnTagIn…#8183
Merged
Merged
Conversation
…compatibleWithNativeTypeRector` The rule incorrectly removed `@return self<T>` and `@return ClassName<T>` annotations when the native return type was `self`. These annotations are not incompatible, because they carry template parameters that the native type cannot express. PHPStan and Psalm rely on them for generic type inference. Add an early bail-out when the `@return` type node is a `GenericTypeNode`, which covers all parameterized return types (`self<T>`, `static<T>`, `Foo<T>`).
samsonasik
approved these changes
Jul 13, 2026
Member
|
Looks good 👌 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This fixes
RemoveReturnTagIncompatibleWithNativeTypeRectorincorrectly stripping@return self<T>and@return ClassName<T>docblocks when the native return type isself.Problem
Given a templated class:
The rule would remove
@return self<TAdded, TRemoved>because it considered it incompatible with the nativeselfreturn type. However, the annotation is not redundant, because it narrows the return type with template parameters that PHP's native type system cannot express. PHPStan and Psalm rely on these annotations for generic type inference.Fix
Added an early bail-out when
$returnTagValueNode->typeis an instance ofGenericTypeNode. This catches all@return Foo<T>,@return self<T>, and@return static<T>patterns at the PHPDoc AST level before any expensive type resolution occurs.