✨ New Generic.Strings.UnnecessaryHeredoc sniff
#633
Merged
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
New `Generic.Strings.UnnecessaryHeredoc` sniff which encourages the use of nowdocs instead of heredocs, when there is no interpolation or expressions in the body text. This sniff will hopefully help with the PERCS work as it intends to cover the following PER rule: > A nowdoc SHOULD be used wherever possible. Heredoc MAY be used when a nowdoc does not satisfy requirements. Includes fixer. Includes tests. Includes XML docs.
jrfnl
force-pushed
the
feature/new-unnecessaryheredoc-sniff
branch
2 times, most recently
from
c73d112 to
1cbb4c0
Compare
This commit adds metrics to the new `Generic.Strings.UnnecessaryHeredoc` sniff to allow for collecting statistical information on how often a heredoc is used without expressions or interpolation.
jrfnl
force-pushed
the
feature/new-unnecessaryheredoc-sniff
branch
from
1cbb4c0 to
a9d0457
Compare
jrfnl
added a commit
that referenced
this pull request
Oct 29, 2024
New `Generic.Strings.UnnecessaryHeredoc` sniff which encourages the use of nowdocs instead of heredocs, when there is no interpolation or expressions in the body text. This sniff will hopefully help with the PERCS work as it intends to cover the following PER rule: > A nowdoc SHOULD be used wherever possible. Heredoc MAY be used when a nowdoc does not satisfy requirements. Includes fixer. Includes tests. Includes metrics. Includes XML docs.
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
New
Generic.Strings.UnnecessaryHeredocsniff which encourages the use of nowdocs instead of heredocs, when there is no interpolation or expressions in the body text.This sniff will hopefully help with the PERCS work as it intends to cover the following PER rule:
Includes fixer.
Includes tests.
Includes XML docs.
Includes metrics.
Suggested changelog entry
New
Generic.Strings.UnnecessaryHeredocsniff which warns about heredocs without interpolation or expressions in the body text and can auto-fix these to nowdocs.Types of changes
PR checklist