PHP/NoSilencedErrors: implement PHPCSUtils methods #2162
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
... to cover a previously uncovered condition (and ensure that the configurable `$context_length` parameter is handled correctly).
As the methods from `GetTokensAsString` work slightly differently from the PHPCS native `File::getTokensAsString()` method, this would result in a "one token longer" code snippet. The `-1` in the function call in line 225 has been added to prevent this change in behaviour without the need for people to update the `context_length` property value in their custom ruleset (which would be an unnecessary BC-break). Functionally, using the `GetTokensAsString::compact()` method will result in the code snippet in the error message being "cleaner" as those will no longer contain comments found in the code. The PHPCSUtils method will also "compact" the whitespace, so no need for the `str_replace()` call anymore. No additional tests added, the existing tests (line 58) already cover this. Note: it is still the intention for a similar sniff to become available via PHPCSExtra, but that will be in a later release.
dingo-d
approved these changes
Dec 20, 2022
19 tasks
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.
PHP/NoSilencedErrors: add extra test
... to cover a previously uncovered condition (and ensure that the configurable
$context_lengthparameter is handled correctly).PHP/NoSilencedErrors: implement PHPCSUtils methods
As the methods from
GetTokensAsStringwork slightly differently from the PHPCS nativeFile::getTokensAsString()method, this would result in a "one token longer" code snippet. The-1in the function call in line 225 has been added to prevent this change in behaviour without the need for people to update thecontext_lengthproperty value in their custom ruleset (which would be an unnecessary BC-break).Functionally, using the
GetTokensAsString::compact()method will result in the code snippet in the error message being "cleaner" as those will no longer contain comments found in the code. The PHPCSUtils method will also "compact" the whitespace, so no need for thestr_replace()call anymore.No additional tests added, the existing tests (line 58) already cover this.
Note: it is still the intention for a similar sniff to become available via PHPCSExtra, but that will be in a later release.