Squiz/PostStatementComment: use a different error code for annotations #627
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
This commit changes `Squiz.Commenting.PostStatementComment` to use a different error code when an annotation is found. This will allow ruleset maintainers to selectively exclude the flagging of trailing annotations from their ruleset. For example, for PHPCS itself, this will make it possible to use the `// @codeCoverageIgnore` annotation where needed. An annotation is defined as any comment that starts with an optional space, followed by a `@` and any character, as long as it is not a whitespace. For now, only `//` comments are supported as this is the only type of comment supported by this sniff. This change only applies to PHP code as support for JS will be dropped soon, and JS doesn't seem to follow the same convention of annotations starting with `@`.
jrfnl
reviewed
Oct 28, 2024
src/Standards/Squiz/Sniffs/Commenting/PostStatementCommentSniff.php
Outdated
Show resolved
Hide resolved
jrfnl
reviewed
Oct 28, 2024
src/Standards/Squiz/Tests/Commenting/PostStatementCommentUnitTest.inc
Outdated
Show resolved
Hide resolved
|
Thanks for your review, @jrfnl! I pushed a new commit to implement the changes you suggested and replied to your comments. Could you please take another look? |
jrfnl
approved these changes
Oct 29, 2024
There was a problem hiding this comment.
@rodrigoprimo Thanks for the PR and fixing the regex (and updating the tests to match). Definitely better now.
Realized only when prepping for merge that the comments in the test case files could be made a little more descriptive. Left two suggestions in-line. Other than that all good.
If you like, I can fix up those comments when merging. Let me know.
src/Standards/Squiz/Tests/Commenting/PostStatementCommentUnitTest.inc
Outdated
Show resolved
Hide resolved
src/Standards/Squiz/Tests/Commenting/PostStatementCommentUnitTest.inc
Outdated
Show resolved
Hide resolved
Co-authored-by: Juliette <663378+jrfnl@users.noreply.github.com>
rodrigoprimo
force-pushed
the
post-statement-comment-annotation
branch
from
5c83003 to
e28bf06
Compare
|
@jrfnl, I went ahead and committed your suggestions. Thanks. |
jrfnl
pushed a commit
that referenced
this pull request
Oct 30, 2024
#627) This commit changes `Squiz.Commenting.PostStatementComment` to use a different error code when an annotation is found. This will allow ruleset maintainers to selectively exclude the flagging of trailing annotations from their ruleset. For example, for PHPCS itself, this will make it possible to use the `// @codeCoverageIgnore` annotation where needed. An annotation is defined as any comment that starts with an optional space, followed by a `@` and any character, as long as it is not a whitespace. For now, only `//` comments are supported as this is the only type of comment supported by this sniff. This change only applies to PHP code as support for JS will be dropped soon, and JS doesn't seem to follow the same convention of annotations starting with `@`.
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
As discussed in #560, this PR changes
Squiz.Commenting.PostStatementCommentto use a different error code when an annotation is found. This will allow ruleset maintainers to selectively exclude the flagging of trailing annotations from their ruleset. For example, for PHPCS itself, this will make it possible to use the// @codeCoverageIgnoreannotation where needed.An annotation is defined as any comment that starts with an optional space, followed by a
@and any character, as long as it is not a whitespace. For now, only//comments are supported as this is the only type of comment supported by this sniff.This change only applies to PHP code as support for JS will be dropped soon, and JS doesn't seem to follow the same convention of annotations starting with
@.Suggested changelog entry
Squiz.Commenting.PostStatementComment: use a different error code for annotationsRelated issues/external references
Fixes #560
Types of changes
PR checklist