PSR2/NamespaceDeclaration: do not enforce new line in inline HTML #815
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
If a namespace declaration has a PHP close tag on the same line, the new line would be added as `T_INLINE_HTML` and therefore not be recognized as a blank line as the sniff solely looks for `T_WHITESPACE`. This then leads to a fixer conflict where the sniff just keeps adding new lines until it runs out of loops.
```
=> Fixing file: 0/6 violations remaining [made 46 passes]...
* fixed 0 violations, starting loop 47 *
PSR2.Namespaces.NamespaceDeclaration:81 replaced token 118 (T_INLINE_HTML on line 32) "\n\n" => "\n\n\n"
PSR2.Namespaces.NamespaceDeclaration:81 replaced token 153 (T_INLINE_HTML on line 58) "\n\n" => "\n\n\n"
=> Fixing file: 2/6 violations remaining [made 47 passes]...
* fixed 2 violations, starting loop 48 *
**** PSR2.Namespaces.NamespaceDeclaration:81 has possible conflict with another sniff on loop 46; caused by the following change ****
**** replaced token 118 (T_INLINE_HTML on line 32) "\n\n" => "\n\n\n" ****
**** ignoring all changes until next loop ****
=> Fixing file: 0/6 violations remaining [made 48 passes]...
* fixed 0 violations, starting loop 49 *
```
In my opinion, the sniff should bow out in that situation and should not enforce a new line as it may impact HTML display.
This commit implements this.
Includes a test safeguarding the fix.
|
FYI: Build failure is unrelated to this PR, but has to do with an outage at Coveralls. See lemurheavy/coveralls-public#1791 and https://status.coveralls.io/ |
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
If a namespace declaration has a PHP close tag on the same line, the new line would be added as
T_INLINE_HTMLand therefore not be recognized as a blank line as the sniff solely looks forT_WHITESPACE. This then leads to a fixer conflict where the sniff just keeps adding new lines until it runs out of loops.In my opinion, the sniff should bow out in that situation and should not enforce a new line as it may impact HTML display.
This commit implements this.
Includes a test safeguarding the fix.
Suggested changelog entry
PSR2.Namespaces.NamespaceDeclaration: prevent fixer conflict when the next thing after a namespace declaration is a PHP close tag
Related issues/external references
Related to #152
Types of changes