Adds ForbiddenSuppress rule #4899
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
gfreivasc
force-pushed
the
gabrielfv/forbidden-suppress
branch
from
6c66b9a
to
f8a363e
Compare
gfreivasc
force-pushed
the
gabrielfv/forbidden-suppress
branch
from
f8a363e
to
e9d6e91
Compare
Codecov Report
@@ Coverage Diff @@
## main #4899 +/- ##
============================================
+ Coverage 84.80% 84.82% +0.02%
- Complexity 3488 3511 +23
============================================
Files 495 497 +2
Lines 11464 11549 +85
Branches 2122 2139 +17
============================================
+ Hits 9722 9797 +75
- Misses 685 687 +2
- Partials 1057 1065 +8
Continue to review full report at Codecov.
|
cortinico
reviewed
Jun 2, 2022
detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenSuppress.kt
Outdated
Show resolved
Hide resolved
cortinico
reviewed
Jun 2, 2022
| override val issue = Issue( | ||
| javaClass.simpleName, | ||
| Severity.Maintainability, | ||
| "", |
There was a problem hiding this comment.
This should not be left empty 👍
detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenSuppress.kt
Outdated
Show resolved
Hide resolved
detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenSuppress.kt
Outdated
Show resolved
Hide resolved
| .find { it is KtStringTemplateExpression } | ||
| ?.children | ||
| ?.find { it is KtLiteralStringTemplateEntry } | ||
| val text = stringTemplate?.text |
There was a problem hiding this comment.
This can be chained with the rest?
There was a problem hiding this comment.
I extracted that because I was following along debugging the code, will add to the chain.
gfreivasc
force-pushed
the
gabrielfv/forbidden-suppress
branch
3 times, most recently
from
848c6f8
to
cdac21c
Compare
gfreivasc
force-pushed
the
gabrielfv/forbidden-suppress
branch
from
cdac21c
to
7aac082
Compare
schalkms
reviewed
Jun 2, 2022
Comment on lines
19
to
21
| * This rule allows to set a list of rules whose suppression is forbidden. This can be used to discourage abuse of the | ||
| * `Suppress` and `SuppressWarnings` annotations. Detekt will report suppression of all forbidden rules. This rule is | ||
| * not capable of reporting suppression of itself, as that's a language feature with precedence. |
There was a problem hiding this comment.
minor formatting and grammar
Suggested change
| * This rule allows to set a list of rules whose suppression is forbidden. This can be used to discourage abuse of the | |
| * `Suppress` and `SuppressWarnings` annotations. Detekt will report suppression of all forbidden rules. This rule is | |
| * not capable of reporting suppression of itself, as that's a language feature with precedence. | |
| * This rule allows to set a list of rules whose suppression is forbidden. | |
| * This can be used to discourage the abuse of the `Suppress` and `SuppressWarnings` annotations. | |
| * Detekt will report the suppression of all forbidden rules. | |
| * This rule is not capable of reporting the suppression of itself, as that's a language feature with precedence. |
gfreivasc
force-pushed
the
gabrielfv/forbidden-suppress
branch
from
7aac082
to
e439cc7
Compare
This rule is based on discussion detekt#4890. Checks for suppression of one or more rules that have been decided to never be suppressed within a code base. For example, if we've set MaximumLineLength to a value, every file must be compliant, and if there is a special case where compliance is discouraged, we can simply exclude this file within YML configuration. This rule cannot prevent itself from being suppressed, but should serve to discourage the over use of `@Suppress` annotations.
gfreivasc
force-pushed
the
gabrielfv/forbidden-suppress
branch
from
e439cc7
to
d0c9ffc
Compare
|
@cortinico @schalkms addressed your comments. |
cortinico
approved these changes
Jun 3, 2022
schalkms
approved these changes
Jun 3, 2022
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.
This rule is based on discussion #4890. It has been added to the "style"
rule set, since I believe it is opinionated and usage would vary across code
bases.
Checks for suppression of one or more rules that have been decided to
never be suppressed within a code base. For example, if we've set
MaximumLineLength to a value, every file must be compliant, and if there
is a special case where compliance is discouraged, we can simply exclude
this file within YML configuration.
This rule cannot prevent itself from being suppressed, but should serve
to discourage the over use of
@Suppressannotations.