New CodeCoverageIgnoreDeprecated sniff
#96
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
This sniff will check that functions which have a `@deprecated` tag in the function docblock, also have a `@codeCoverageIgnore` tag in the same docblock.
If a `codeCoverageIgnore` text is found without the `@` sign, it will be recognized by the sniff and can be auto-fixed.
Individual plugins may have certain files `exclude`d for codeCoverage in the PHPUnit configuration file.
For those plugins a corresponding `exclude`s needs to be added to the PHPCS configuration file to ignore those files completely for the purposes of this sniff.
Example:
```xml
<rule ref="Yoast.Commenting.CodeCoverageIgnoreDeprecated">
<exclude-pattern>*/deprecated/*\.php$</exclude-pattern>
</rule>
```
|
Looks good to me 👍 |
afercia
reviewed
Sep 21, 2018
afercia
reviewed
Sep 21, 2018
afercia
reviewed
Sep 21, 2018
afercia
reviewed
Sep 21, 2018
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.
This sniff will check that functions which have a
@deprecatedtag in the function docblock, also have a@codeCoverageIgnoretag in the same docblock.If a
codeCoverageIgnoretext is found without the@sign, it will be recognized by the sniff and can be auto-fixed.Individual plugins may have certain files
excluded for codeCoverage in the PHPUnit configuration file.For those plugins corresponding
excludes need to be added to the PHPCS configuration file to ignore those files completely for the purposes of this sniff.Example:
Fixes #95