Squiz/EmbeddedPhp: fix false positive when handling short open tags #591
Conversation
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
The content of a PHP long open tag token is `<?php ` (note the space after the tag). The content of a PHP short open tag is `<?` (no space after the tag). The sniff did not account correctly for this difference when checking the expected number of spaces after a short open tag, resulting in false positives and incorrect fixes. For example, the code below: ``` <? echo 'one space after short open tag'; ?> ``` Resulted in the error (there is just one space after the opening tag and not two, as stated in the error): ``` Expected 1 space after opening PHP tag; 2 found (Squiz.PHP.EmbeddedPhp.SpacingAfterOpen) ``` And the incorrect fix: ``` <?echo 'without space after short open tag'; ?> ``` This commit fixes this problem by changing the sniff code to consider that only long open tags contain a space after the tag in the `content` key of the token array.
jrfnl
reviewed
Aug 13, 2024
Member
jrfnl
left a comment
jrfnl
left a comment
There was a problem hiding this comment.
Thanks @rodrigoprimo!
Approved on the principle of the patch + the tests (which have been validated).
Just two nitpicks and then I can merge it.
Co-authored-by: Juliette <[email protected]>
rodrigoprimo
force-pushed
the
fix-embedded-php
branch
from
62a5e1b to
9bc7b0b
Compare
Contributor
Author
|
Thanks for reviewing this PR, @jrfnl. I applied your suggestions and it is now ready for a final check. |
jrfnl
approved these changes
Aug 13, 2024
Member
|
Closing as merged manually in 0ed5577. |
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
This PR fixes a bug in
Squiz.PHP.EmbeddedPhpthat causes a false positive when handling short open tags and was reported in #588.The content of a PHP long open tag token is
<?php(note the space after the tag). The content of a PHP short open tag is<?(no space after the tag). The sniff did not account correctly for this difference when checking the expected number of spaces after a short open tag, resulting in false positives and incorrect fixes.Suggested changelog entry
Squiz.PHP.EmbeddedPhpfalse positive when checking spaces after a PHP short open tag.Related issues/external references
Fixes #588
Types of changes
PR checklist