MySource.PHP.AjaxNullComparison throws error when first function has no doc comment #2368
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
MariusLab
force-pushed
the
fix-ajaxnullcomparison-sniff
branch
from
1639c8f
to
825594c
Compare
MariusLab
force-pushed
the
fix-ajaxnullcomparison-sniff
branch
from
825594c
to
5cbef5e
Compare
jrfnl
reviewed
Jan 17, 2019
| @@ -47,7 +47,12 @@ public function process(File $phpcsFile, $stackPtr) | |||
| // Make sure it is an API function. We know this by the doc comment. | |||
| $commentEnd = $phpcsFile->findPrevious(T_DOC_COMMENT_CLOSE_TAG, $stackPtr); | |||
| $commentStart = $phpcsFile->findPrevious(T_DOC_COMMENT_OPEN_TAG, ($commentEnd - 1)); | |||
| $comment = $phpcsFile->getTokensAsString($commentStart, ($commentEnd - $commentStart)); | |||
| // If function doesn't contain any doc comments - skip it. | |||
There was a problem hiding this comment.
Based on the above lines, you could already short-circuit the sniff after the $commentEnd assignment as $commentStart will always be false if no $commentEnd could be found.
Also, the way the findPrevious() for $commentEnd is done now, it could accidentally pick up an unrelated docblock when there are two functions, the first with a docblock, the second without one.
When the sniff is triggered for the second function, the docblock of the first function will be examined.
12 tasks
gsherwood
changed the title
gsherwood
added a commit
that referenced
this pull request
Apr 3, 2019
|
Thanks for this fix. If you'd like me to credit you in the changelog, please let me know what name you'd like me to use. |
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.
A RuntimeException is thrown in File::getTokensAsString() if the first parameter is not an int or if the supplied int does not exist as a position in the token stack.
AjaxNullComparisonSniff ends up throwing this exception on every file that contains functions with no comment blocks.