Composer/PHPCS: update to YoastCS 3.0.0 #155
Merged
+68
−34
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
YoastCS 3.0.0 has been released and is based on WordPressCS 3.0.0.
This commit makes the necessary updates for that:
* Composer: update the requirements.
* PHPCS ruleset:
- Update a few sniff/property names for new names in WordPressCS 3.0.
- Exclude code modernization sniffs which can't be applied to this package yet.
- Enforce strict PSR-4 for the tests.
- Remove a few exclusions which are no longer needed.
- Add a few selective exclusions for specific situations.
* GHA CS workflow:
- Run the CS check on the latest PHP version.
No need to run on PHP 7.4 any more as the deprecations previously encountered were all fixed.
- Change the CS check from a "normal" PHPCS run to a run using the Thresholds report and only reporting on issues found in files changed in the branch.
There are currently 8 (documentation) issues which still need to be fixed, so hopefully, the threshold can go back to 0 soon.
* Add one selective ignore annotation for a class name containing an acronym.
* Make one more minor CS fix (`@return void`).
While YoastCS 3.0.0 contains lots of goodies, it also has a downside: a minimum PHP requirement of PHP 7.2, which conflicts with the minimum supported PHP version of this package.
This causes two issues:
1. A plain `composer install` will no longer work on PHP < 7.2.
This means the YoastCS package will need to be removed for the CI test workflow.
2. As the (Parallel) linting packages are "inherited" from YoastCS, removing YoastCS would break the linting command in CI, so we need to `require-dev` the Parallel Lint packages in WHIP itself to allow the workflow to continue to work.
With those two work-arounds in place, everything should work again.
Refs:
* https://github.com/Yoast/yoastcs/releases/tag/3.0.0
* https://github.com/WordPress/WordPress-Coding-Standards/releases/tag/3.0.0
Pull Request Test Coverage Report for Build 7216525553
💛 - Coveralls |
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.
YoastCS 3.0.0 has been released and is based on WordPressCS 3.0.0.
This commit makes the necessary updates for that:
No need to run on PHP 7.4 any more as the deprecations previously encountered were all fixed.
There are currently 8 (documentation) issues which still need to be fixed, so hopefully, the threshold can go back to 0 soon.
@return void).While YoastCS 3.0.0 contains lots of goodies, it also has a downside: a minimum PHP requirement of PHP 7.2, which conflicts with the minimum supported PHP version of this package.
This causes two issues:
composer installwill no longer work on PHP < 7.2.This means the YoastCS package will need to be removed for the CI test workflow.
require-devthe Parallel Lint packages in WHIP itself to allow the workflow to continue to work.With those two work-arounds in place, everything should work again.
Refs: