Rule S1125: Boolean literals should not be redundant #2267
Merged
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
ghost
assigned
sonaranalyzer-dotnet/src/SonarAnalyzer.VisualBasic/Rules/BooleanLiteralUnnecessary.cs
Show resolved
Hide resolved
andrei-epure-sonarsource
force-pushed
the
andrei/vb-s1125
branch
from
8478b6f
to
c9f7ea5
Compare
Evangelink
reviewed
Feb 7, 2019
sonaranalyzer-dotnet/src/SonarAnalyzer.Common/Rules/BooleanLiteralUnnecessaryBase.cs
Outdated
Show resolved
Hide resolved
sonaranalyzer-dotnet/src/SonarAnalyzer.Common/Rules/BooleanLiteralUnnecessaryBase.cs
Outdated
Show resolved
Hide resolved
sonaranalyzer-dotnet/src/SonarAnalyzer.Common/Rules/BooleanLiteralUnnecessaryBase.cs
Outdated
Show resolved
Hide resolved
sonaranalyzer-dotnet/src/SonarAnalyzer.Common/Rules/BooleanLiteralUnnecessaryBase.cs
Outdated
Show resolved
Hide resolved
sonaranalyzer-dotnet/src/SonarAnalyzer.Common/Rules/BooleanLiteralUnnecessaryBase.cs
Outdated
Show resolved
Hide resolved
sonaranalyzer-dotnet/src/SonarAnalyzer.Common/Rules/BooleanLiteralUnnecessaryBase.cs
Outdated
Show resolved
Hide resolved
sonaranalyzer-dotnet/src/SonarAnalyzer.Common/Rules/BooleanLiteralUnnecessaryBase.cs
Outdated
Show resolved
Hide resolved
sonaranalyzer-dotnet/src/SonarAnalyzer.Common/Rules/BooleanLiteralUnnecessaryBase.cs
Outdated
Show resolved
Hide resolved
sonaranalyzer-dotnet/src/SonarAnalyzer.Common/Rules/BooleanLiteralUnnecessaryBase.cs
Outdated
Show resolved
Hide resolved
sonaranalyzer-dotnet/src/SonarAnalyzer.Common/Rules/BooleanLiteralUnnecessaryBase.cs
Outdated
Show resolved
Hide resolved
andrei-epure-sonarsource
force-pushed
the
andrei/vb-s1125
branch
from
2adce83
to
0026dee
Compare
Evangelink
suggested changes
Feb 7, 2019
| internal const string DiagnosticId = "S1125"; | ||
| protected const string MessageFormat = "Remove the unnecessary Boolean literal(s)."; | ||
|
|
||
| protected abstract TSyntaxKind TrueLiteral { get; } |
There was a problem hiding this comment.
Instead of asking sub-classes to provide TrueLiteral, FalseLiteral and IsKind you could require only IsTrueLiteralKind and IsFalseLiteralKind methods
There was a problem hiding this comment.
The TSyntaxKind is passed as argument to many methods: CheckForBooleanConstantOnLeft, CheckForBooleanConstantOnRight and CheckForBooleanConstant. I think the code is readable enough as is
sonaranalyzer-dotnet/src/SonarAnalyzer.Common/Rules/BooleanLiteralUnnecessaryBase.cs
Outdated
Show resolved
Hide resolved
sonaranalyzer-dotnet/src/SonarAnalyzer.Common/Rules/BooleanLiteralUnnecessaryBase.cs
Outdated
Show resolved
Hide resolved
sonaranalyzer-dotnet/src/SonarAnalyzer.Common/Rules/BooleanLiteralUnnecessaryBase.cs
Outdated
Show resolved
Hide resolved
sonaranalyzer-dotnet/src/SonarAnalyzer.VisualBasic/Rules/BooleanLiteralUnnecessary.cs
Outdated
Show resolved
Hide resolved
sonaranalyzer-dotnet/src/SonarAnalyzer.VisualBasic/Rules/BooleanLiteralUnnecessary.cs
Outdated
Show resolved
Hide resolved
| x = false; // Fixed | ||
| x = Foo(); // Fixed | ||
| x = Foo(); // Fixed | ||
| x = Foo(); // Fixed |
There was a problem hiding this comment.
[cosmetic] Could you align the // Fixed comments. This will means that the // Noncompliant are also aligned.
There was a problem hiding this comment.
Actually, it is not possible for both //Noncompliant and //Fixed to be aligned.
- the
// Noncompliantare aligned - the
// Fixedare not aligned because code is being cut out, andFalsehas 5 letters,Truehas 4 letters, thus the lines cannot be aligned between themselves in both files
| Dim exp = True | ||
| Dim exp2 = True | ||
|
|
||
| Dim z = True OrElse ((True)) ' Noncompliant (also S1764) |
There was a problem hiding this comment.
Could you also add a check with And and Or (the operators forcing both parts to be evaluated).
There was a problem hiding this comment.
really good catch, thanks!!!
sonaranalyzer-dotnet/tests/SonarAnalyzer.UnitTest/TestCases/BooleanLiteralUnnecessary.vb
Show resolved
Hide resolved
andrei-epure-sonarsource
force-pushed
the
andrei/vb-s1125
branch
from
60f7501
to
bd5d123
Compare
Evangelink
approved these changes
Feb 7, 2019
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.
Fix #2061