Files/FileName: add ability to check PSR-4-style file names #347
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
As the Yoast plugin test directories will start to follow PSR-4. the `FileName` sniff will need to be able to enforce this. This commit adds this ability to the sniff. Notes: * It adds a new `public` `psr4_paths` ruleset property via the `PSR4PathsTrait` utility. * If the file being examined is in a path indicated as a PSR-4 path, PSR-4 based file names will be enforced. * For PSR-4 compliant file names, the file name has to match the OO name. This also means that "oo prefixes" should not be stripped and that the "excluded files" property will be ignored. * For non-OO files in a PSR-4 path, the _normal_ file name rules apply, i.e. lowercase and hyphenathed and if the file contains functions, the file name should have a `-functions` suffix. Includes ample tests for this new functionality. Includes updated XML documentation. Includes updating the YoastCS native PHPCS ruleset to enable the sniff as the YoastCS repo follows PSR-4 completely (as per the PHPCS file name rules). :point_right: The changes to the pre-existing code in the sniff will be easiest to review while ignoring whitespace changes.
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.
As the Yoast plugin test directories will start to follow PSR-4. the
FileNamesniff will need to be able to enforce this.This commit adds this ability to the sniff.
Notes:
publicpsr4_pathsruleset property via thePSR4PathsTraitutility.-functionssuffix.Includes ample tests for this new functionality.
Includes updated XML documentation.
Includes updating the YoastCS native PHPCS ruleset to enable the sniff as the YoastCS repo follows PSR-4 completely (as per the PHPCS file name rules).
👉 The changes to the pre-existing code in the sniff will be easiest to review while ignoring whitespace changes.