Generic/EmptyStatementSniff: Allow comments to be considered non-empty #3409
Conversation
|
Is there a way to document the new option in |
src/Standards/Generic/Sniffs/CodeAnalysis/EmptyStatementSniff.php
Outdated
Show resolved
Hide resolved
| * | ||
| * @var string[] | ||
| */ | ||
| public $allowComment = []; |
There was a problem hiding this comment.
Hmm.. I had to look at the docblock to understand what this property does. Trying to think whether I can come up with a more self-explanatory name, but not sure whether any of the names I came up with are any better... $notEmptyOnComment, $skipForComment etc
Might be more in line with the general direction I see for other sniffs to handle this with differentiation in the error code instead.
What I mean by that is, that for completely empty control structure bodies, the error code would remain the same as it is now, but when a comment is detected, but no code, the error code would be changed to something like Generic.CodeAnalysis.EmptyStatement.DetectedElseifOnlyComment.
This would be a breaking change as rulesets which currently ignore Generic.CodeAnalysis.EmptyStatement.DetectedElseif, would now get notifications again under the new error code if there is a comment.
So all in all, not sure what would be best. I think @gsherwood needs to weight in.
There was a problem hiding this comment.
I indeed struggled a bit with the naming here. PhpStorm calls it "Comments count as content", but that doesn't make it clear that the variable should contain statement names.
I like the idea of separate error codes, that would allow using error severity for empty bodies and warning for comment-only bodies. However, I'll rely on maintainers to decide if there should be a BC break here.
src/Standards/Generic/Sniffs/CodeAnalysis/EmptyStatementSniff.php
Outdated
Show resolved
Hide resolved
jlherren
force-pushed
the
empty-statements-with-comments
branch
from
16b86c0
to
010fafd
Compare
|
While doing some PR triage I suddenly realized this is a (nearly exact) duplicate of #2240 |
Add an option to EmptyStatementSniff to allow a comment in an otherwise empty block to be considered non-empty.