Properly comply with PHPCS naming conventions #2
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
Note: I've not changed the `composer.json` file, but it could also be considered to leave the sniff namespace the same and to change the `"Exercism\\": "src",` config in the `composer.json` file to `"Exercism\\": "src\\Exercism",`.
The class name is already translated to a sniff name, so no need to duplicate it. Also not a good idea to use backslashes in the error code as that makes configuration in the XML file more fiddly.
4 tasks
tomasnorre
approved these changes
Nov 15, 2024
tomasnorre
merged commit ed8d16a
into
tomasnorre:ci-fix-strict-types-sniff
13 checks passed
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.
👉 Note: the first commit is the only one necessary to fix the issue you were experiencing. The second and third commits are "best practice" fixes as I had the repo open now anyway.
Properly comply with PHPCS naming conventions
Note: I've not changed the
composer.jsonfile, but it could also be considered to leave the sniff namespace the same and to change the"Exercism\\": "src",config in thecomposer.jsonfile to"Exercism\\": "src\\Exercism",.ExplainStrictTypesSniff: use proper error code
The class name is already translated to a sniff name, so no need to duplicate it. Also not a good idea to use backslashes in the error code as that makes configuration in the XML file more fiddly.
PHPCS config: include sniff from installed standard by name