Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New CodeCoverageIgnoreDeprecated sniff #96

Merged
merged 1 commit into from
Sep 21, 2018

Commits on Sep 20, 2018

  1. ✨ New CodeCoverageIgnoreDeprecated sniff

    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>
    ```
    jrfnl committed Sep 20, 2018
    Configuration menu
    Copy the full SHA
    04b8e94 View commit details
    Browse the repository at this point in the history