Various sniffs: simplify skipping the rest of the file + update docs about skipping rest of file #363
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
11 tasks
rodrigoprimo
approved these changes
Feb 26, 2024
As the tokens stack indexes are 0-based and a token count is 1-based, it is sufficient to return the token count to skip the rest of the file.
This commit updates various sniffs to use `return $phpcsFile->numTokens` instead of `return ($phpcsFile->numTokens + 1)`. If a sniff file contains 50 tokens, the last `$stackPtr` will be 49, so returning `50` will already get us passed the end of the token stack and the `+ 1` is redundant.
jrfnl
force-pushed
the
feature/various-sniff-update-skip-to-end-code
branch
from
aecb4f6
to
dd80edb
Compare
|
Rebased without changes. Merging once the build passes. |
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
Inspired by #360
*Sniff::process(): update documentation
As the tokens stack indexes are 0-based and a token count is 1-based, it is sufficient to return the token count to skip the rest of the file.
Various sniffs: simplify skipping the rest of the file
This commit updates various sniffs to use
return $phpcsFile->numTokensinstead ofreturn ($phpcsFile->numTokens + 1).If a sniff file contains 50 tokens, the last
$stackPtrwill be 49, so returning50will already get us passed the end of the token stack and the+ 1is redundant.Suggested changelog entry
N/A