NamingConventions/NamespaceName: add support for strict PSR-4 compliance checking #348
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
…nce checking
As the Yoast plugin test directories will start to follow PSR-4. the `NamespaceName` 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 namespace names will be enforced.
The differences between the "old-style" enforcement and PSR-4 are in case-sensitivity and in how characters which are allowed in paths, but not allowed in namespace names are handled.
* Includes updated error message/code for the "missing prefix" check when the file is in a PSR-4 path.
* Includes updated/adjusted logic for the "not counting of `Tests`/`Doubles`" directories as the `Tests` may be part of the PSR-4 namespace.
Also note that when both a `psr4_paths` as well as the `src_directory` and `prefixes` properties are set, the `psr4_paths` property will take precedence and the sniff will only fall back to the previous logic if the file is not in a path matching one of the PSR-4 directories.
Includes ample tests for this new functionality.
Includes updated XML documentation.
Includes updating the YoastCS native PHPCS ruleset to indicate that the YoastCS repo follows PSR-4 (as per the PHPCS file name rules).
Note: if the name in use in the file is causing a problematic parse error (like in the test with the `#` in the namespace name), the sniff will stay silent. This is the normal behaviour for a PHPCS check when encountering parse errors.
:point_right: The sniff changes are probably easiest to review while ignoring whitespace.
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
NamespaceNamesniff will need to be able to enforce this.This commit adds this ability to the sniff.
Notes:
publicpsr4_pathsruleset property via thePSR4PathsTraitutility.Tests/Doubles" directories as theTestsmay be part of the PSR-4 namespace.Also note that when both a
psr4_pathsas well as thesrc_directoryandprefixesproperties are set, thepsr4_pathsproperty will take precedence and the sniff will only fall back to the previous logic if the file is not in a path matching one of the PSR-4 directories.Includes ample tests for this new functionality.
Includes updated XML documentation.
Includes updating the YoastCS native PHPCS ruleset to indicate that the YoastCS repo follows PSR-4 (as per the PHPCS file name rules).
Note: if the name in use in the file is causing a problematic parse error (like in the test with the
#in the namespace name), the sniff will stay silent. This is the normal behaviour for a PHPCS check when encountering parse errors.👉 The sniff changes are probably easiest to review while ignoring whitespace.