✨ New Universal.CodeAnalysis.NoDoubleNegative sniff
#277
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 detect double negatives (`!!`) and advise to use a boolean cast instead. The sniff will correctly handle a situation where even more consecutive not operators are found. In the case, the number of operators is uneven, it will auto-fix to a single not operator. And when a double not operator is found before an expression involving `instanceof`, the error will still be thrown, but not auto-fix as the `instanceof` operator is nested right between the `!` operator and a `(bool)` cast operator precedence wise, so auto-fixing without also adding parentheses would change the behaviour of the code. Includes fixer. Includes unit tests. Includes documentation. Ref: https://www.php.net/manual/en/language.operators.precedence.php
jrfnl
force-pushed
the
universal/new-nodoublenegative-sniff
branch
from
5133267 to
8ec8a17
Compare
diedexx
approved these changes
Sep 24, 2023
Comment on lines
+52
to
+58
| // Collect all the operators only once. | ||
| $this->operatorsWithLowerPrecedence = Tokens::$assignmentTokens; | ||
| $this->operatorsWithLowerPrecedence += Tokens::$booleanOperators; | ||
| $this->operatorsWithLowerPrecedence += Tokens::$comparisonTokens; | ||
| $this->operatorsWithLowerPrecedence += Tokens::$operators; | ||
| $this->operatorsWithLowerPrecedence[\T_INLINE_THEN] = \T_INLINE_THEN; | ||
| $this->operatorsWithLowerPrecedence[\T_INLINE_ELSE] = \T_INLINE_ELSE; |
There was a problem hiding this comment.
Out of curiosity: why not use the constructor for this?
There was a problem hiding this comment.
It's rare for a sniff to have a constructor and the register() method is normally only called once anyway, so as good a place as any to do this in.
Good point and no, the sniff would not flag that, but I'm not sure the sniff should catch that... |
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.
... to detect double negatives (
!!) and advise to use a boolean cast instead.The sniff will correctly handle a situation where even more consecutive not operators are found.
In the case, the number of operators is uneven, it will auto-fix to a single not operator.
And when a double not operator is found before an expression involving
instanceof, the error will still be thrown, but not auto-fix as theinstanceofoperator is nested right between the!operator and a(bool)cast operator precedence wise, so auto-fixing without also adding parentheses would change the behaviour of the code.Includes fixer.
Includes unit tests.
Includes documentation.
Ref: https://www.php.net/manual/en/language.operators.precedence.php