Remove comparison to true for booleans #51723
Merged
Conversation
This file contains hidden or 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
While we use `== false` as a more visible form of boolean negation (instead of `!`), the true case is implied and the true value does not need to explicitly checked. This commit converts cases that have slipped into the code checking for `== true`.
rjernst
added
>non-issue
:Core/Infra/Core
|
Pinging @elastic/es-core-infra (:Core/Infra/Core) |
pugnascotia
approved these changes
Jan 31, 2020
There was a problem hiding this comment.
LGTM.
I did a CheckStyle experiment, and you can forbid such comparisons with this:
<!-- Forbid equality comparisons with `true` -->
<module name="DescendantToken">
<property name="tokens" value="EQUAL"/>
<property name="limitedTokens" value="LITERAL_TRUE"/>
<property name="maximumNumber" value="0"/>
<property name="maximumDepth" value="1"/>
<message key="descendant.token.max" value="Do not check for equality with 'true', since it is implied"/>
</module>The minor irritation with that is that it doesn't detect all the violations in one go, rather (1) CheckStyle finds some, (2) you fix them, (3) GOTO 1. What do you think? If it's worth creating a PR to remove these, it's probably worth preventing them from being added in the first place.
|
@pugnascotia If the check isn't too expensive, I do think it would be worthwhile to add. Could we also add the case to not allow |
rjernst
added a commit
that referenced
this pull request
Feb 1, 2020
While we use `== false` as a more visible form of boolean negation (instead of `!`), the true case is implied and the true value does not need to explicitly checked. This commit converts cases that have slipped into the code checking for `== true`.
pugnascotia
added a commit
to pugnascotia/elasticsearch
that referenced
this pull request
Feb 3, 2020
Add a Checkstyle rule to forbid equality checks against a literal 'true' value, since this is redundant. Follow up to elastic#51723.
pugnascotia
added a commit
that referenced
this pull request
Feb 4, 2020
Add a Checkstyle rule to forbid equality checks against a literal 'true' value, since this is redundant. Follow up to #51723.
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.
While we use
== falseas a more visible form of boolean negation(instead of
!), the true case is implied and the true value does notneed to explicitly checked. This commit converts cases that have slipped
into the code checking for
== true.