Extra: add two new sniffs related to heredoc/nowdocs #2534
Merged
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
Two new sniffs were introduced in PHPCS 3.11.0:
* The `Generic.Strings.UnnecessaryHeredoc` sniff recommends using nowdoc syntax for heredocs which don't contain interpolation or expressions.
This is similar to the `Squiz.Strings.DoubleQuoteUsage` sniff which is included in the WP-Core ruleset.
Ref: https://github.com/WordPress/WordPress-Coding-Standards/blob/48e59e97eb950dc011d25a6759feb949afd802a0/WordPress-Core/ruleset.xml#L58-L60
* The `Generic.WhiteSpace.HereNowdocIdentifierSpacing` sniff required that there is no space between the `<<<` and the heredoc/nowdoc identifier.
Both seem like useful additions to me,
I also think both sniffs should be regarded as candidates for moving them to the WPCS Core ruleset if/when a next update proposal is posted on Make.
GaryJones
approved these changes
Jun 16, 2025
rodrigoprimo
approved these changes
Jun 17, 2025
dingo-d
approved these changes
Jun 18, 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.
Two new sniffs were introduced in PHPCS 3.11.0:
Generic.Strings.UnnecessaryHeredocsniff recommends using nowdoc syntax for heredocs which don't contain interpolation or expressions. This is similar to theSquiz.Strings.DoubleQuoteUsagesniff which is included in the WP-Core ruleset. Ref:WordPress-Coding-Standards/WordPress-Core/ruleset.xml
Lines 58 to 60 in 48e59e9
Generic.WhiteSpace.HereNowdocIdentifierSpacingsniff required that there is no space between the<<<and the heredoc/nowdoc identifier.Both seem like useful additions to me,
I also think both sniffs should be regarded as candidates for moving them to the WPCS Core ruleset if/when a next update proposal is posted on Make.