Squiz/Heredoc: make sniff more modular #1009
Merged
+13
−2
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
Until now, the sniff would blindly forbid both heredoc and nowdoc syntax. With the change as proposed in this PR, the sniff still does so, but now uses different error codes for encountered heredocs vs nowdocs, which allows for selectively ignoring one or the other, either from the ruleset or inline. Includes updating the error message to be more specific for each error code as well. Fixes squizlabs/PHP_CodeSniffer 2318
fredden
approved these changes
Apr 15, 2025
jrfnl
deleted the
phpcs-4.0/feature/sq-2318-squiz-heredoc-split-errorcode
branch
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
Until now, the sniff would blindly forbid both heredoc and nowdoc syntax.
With the change as proposed in this PR, the sniff still does so, but now uses different error codes for encountered heredocs vs nowdocs, which allows for selectively ignoring one or the other, either from the ruleset or inline.
Includes updating the error message to be more specific for each error code as well.
Suggested changelog entry
Squiz.PHP.Heredoc.NotAllowedhas been replaced bySquiz.PHP.Heredoc.HeredocNotAllowedandSquiz.PHP.Heredoc.NowdocNotAllowed.Related issues/external references
Fixes squizlabs/PHP_CodeSniffer#2318