PHPCS: Use PHPCompatibilityWP and use it correctly #1974
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 PR:
* Switches the repo over to use `PHPCompatibilityWP` rather than `PHPCompatibility`.
As this repo and ruleset is aimed at a WordPress project, using the `PHPCompatibilityWP` ruleset is the better choice to prevent false positives for PHP functions and constants which are back-filled by WP.
* Switches the dependency over to use the repo in the `PHPCompatibility` GitHub organisation rather than the one in `wimg`'s personal account.
* Removes a PHPCS annotation to suppress a notice about a back-filled function, which is no longer needed.
* Adds a `testVersion` config directive to the PHPCS ruleset to tell PHPCompatibility with which PHP versions the code should be compatible.
Without this directive, PHPCompatibility only throws errors/warnings about deprecated/removed PHP features. Not about the use of new features not supported in older PHP versions.
Adding the directive fixes this.
* Add relevant links to the inline documentation of the Travis script and the ruleset.
### References:
* https://github.com/PHPCompatibility/PHPCompatibilityWP
* https://github.com/PHPCompatibility/PHPCompatibility#sniffing-your-code-for-compatibility-with-specific-php-versions
* PHPCompatibility/PHPCompatibility#688
* https://github.com/PHPCompatibility/PHPCompatibility/releases/tag/8.2.0
Codecov Report
@@ Coverage Diff @@
## develop #1974 +/- ##
=========================================
Coverage 5.38% 5.38%
Complexity 1802 1802
=========================================
Files 143 143
Lines 6257 6257
=========================================
Hits 337 337
Misses 5920 5920
Continue to review full report at Codecov.
|
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 PR:
PHPCompatibilityWPrather thanPHPCompatibility.As this repo and ruleset is aimed at a WordPress project, using the
PHPCompatibilityWPruleset is the better choice to prevent false positives for PHP functions and constants which are back-filled by WP.PHPCompatibilityGitHub organisation rather than the one inwimg's personal account.testVersionconfig directive to the PHPCS ruleset to tell PHPCompatibility with which PHP versions the code should be compatible.Without this directive, PHPCompatibility only throws errors/warnings about deprecated/removed PHP features. Not about the use of new features not supported in older PHP versions.
Adding the directive fixes this.
References: