Squiz/EmbeddedPhp: bug fix - prevent fixer conflict #838
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
The `Squiz.PHP.EmbeddedPhp` sniff expects no blank lines before the PHP close tag. This rule can, however, conflict with sniffs enforcing blank lines after a class or function. The sniff already contains protection against this conflict, but that protection did not take potential trailing comments after the close curly, like `//end class`, into account. Fixed now. Includes test.
fredden
approved these changes
Feb 21, 2025
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.
Description
The
Squiz.PHP.EmbeddedPhpsniff expects no blank lines before the PHP close tag.This rule can, however, conflict with sniffs enforcing blank lines after a class or function.
The sniff already contains protection against this conflict, but that protection did not take potential trailing comments after the close curly, like
//end class, into account.Fixed now.
Includes test.
Suggested changelog entry
Squiz.PHP.EmbeddedPhp: no new line before close tag was incorrectly enforced when a preceding OO construct or function had a trailing comment after the close curly
Related issues/external references
Related to #152
Types of changes