[DeadCode] Keep generic @var/@return self<...> narrowing annotations#8147
Merged
Merged
Conversation
Member
Author
|
LGTM 👍 |
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.
Fixes rectorphp/rector#9793
Two DeadCode rules stripped valid generic type annotations that narrow the return type of a generic class via template specialization. The
@var self<...>/@return self<...>add information that the nativeselftype /new self()cannot express, so they must be kept.RemoveNonExistingVarAnnotationRectorAn empty-name
@varbeforereturn new self(...)was removed, becauseNew_returns were explicitly excluded (a plain@var array<...>onnew stdClassreally is unwanted). Now it is kept when the@varis a generic type over the instantiated class.Before: the docblock was removed. After: kept.
A mismatched annotation such as
/** @var array<string, string> */ return new stdClass;is still removed (base typearray!=stdClass).RemoveDuplicatedReturnSelfDocblockRector@return self<...>maps to aGenericObjectType(subclass ofObjectType) whose class name equals the current class, so it was treated as a duplicate of the nativeselfreturn type and removed. Generic doc types are now skipped.Before: the docblock was removed. After: kept. Bare
@return self/@return $this/@return staticare still removed as before.Tests
New skip fixtures for both rules covering the generic case.