Fix Class Property DocBlock sniff for union/intersection types #483
Conversation
This file contains 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
gabrielnoro
approved these changes
Jul 31, 2024
leduardohub
approved these changes
Jul 31, 2024
|
@ihor-sviziev any chance of merging this? The problem literally prevents some developers from using the supported PHP versions' typing system to its full extent, forcing us to fall back to PhpDocs and redundant conditionals if we need to pass CI tests... |
m2-community-project
bot
added
Progress: ready for review
and removed
Progress: approved
labels
fredden
approved these changes
Sep 27, 2024
m2-community-project
bot
added
Progress: approved
and removed
Progress: ready for review
labels
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.
Since PHP_CodeSniffer 3.7.0, there's a separate token
T_TYPE_INTERSECTIONfor the&type-intersection specifier, instead of using the sameT_BITWISE_ANDtoken for both type intersections and the bitwise operator. Due to this, theMagento2.Commenting.ClassPropertyPHPDocFormattingsniff fails to detect the DocBlock for intersection-typed properties in projects that use newer versions.Also, since PHP 8.2 added support for DNF types, two new tokens were added to PHP_CodeSniffer in 3.10.0 for the parentheses.
This PR proposes pinning the minimum PHP_CodeSniffer version to
^3.10.0in order to fully support the newer DNF types, while also fixing the sniff's allowed tokens to correctly detect DocBlocks for intersection-typed properties.