Generic/OpeningFunctionBraceKernighanRitchie: improve error message #736
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
Follow up on 707 When there are multiple tabs between the end of the function signature and the open brace, the "found: $length" part of the error message would refer to the number of tabs found. This is inconsistent with other sniffs and confusing. This commit fixes this, while still maintaining the previous behaviour - as introduced via squizlabs/PHP_CodeSniffer@c4b9807 - of special casing the messaging for a single tab - independently of whether or not tab replacement is in effect. Example for line 10 of test case file 2: ``` // Before: Expected 1 space before opening brace; found 3 // After: Expected 1 space before opening brace; found 11 ``` Covered via pre-existing tests in both test case files + some additional new tests.
rodrigoprimo
approved these changes
Nov 27, 2024
jrfnl
deleted the
feature/generic-openingfunctionbracekernighanritchie-improve-tab-handling
branch
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.
Description
Follow up on #707
When there are multiple tabs between the end of the function signature and the open brace, the "found: $length" part of the error message would refer to the number of tabs found.
This is inconsistent with other sniffs and confusing.
This commit fixes this, while still maintaining the previous behaviour - as introduced via squizlabs/PHP_CodeSniffer@c4b9807 - of special casing the messaging for a single tab - independently of whether or not tab replacement is in effect.
Example for line 10 of test case file 2:
Covered via pre-existing tests in both test case files + some additional new tests.
Suggested changelog entry
Generic.Functions.OpeningFunctionBraceKernighanRitchie: minor improvement to the error message wording