ForbiddenAnnotation rule #2719 #5515

ov7a · 2022-11-07T12:30:47Z

As discussed in #2719, this rule could be sometimes useful for cases when an annotation does not require import: java.lang.SuppressWarnings, kotlin.jvm.Transient, etc. These cases can't be caught with the ForbiddenImport rule.
Also, this rule can be useful for pushing people towards the Kotlin implementations (see this issue for an example).

More specifically, forbidding kotlin.jvm.Transient can be useful in applications with kotlinx.serialization: kotlin.jvm.Transient does not affect @Serializable classes. ForbiddenAnnotation can be a quick-fix for that.

github-actions · 2022-11-07T12:31:29Z

	Messages
📖	Thanks for adding a new rule to Detekt ❤️

Generated by 🚫 dangerJS against 717f891

BraisGabin

Good contribution! I really like this one!

I'm blocking this PR because we are really near to cut a new version and it's a bit late to add a new rule to it after 3 RC but it should be inside the next version :)

...les-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenAnnotationSpec.kt

detekt-core/src/main/resources/default-detekt-config.yml

...t-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenAnnotation.kt

...les-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenAnnotationSpec.kt

...t-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenAnnotation.kt

TWiStErRob · 2022-11-22T22:41:09Z

@BraisGabin we can unblock this, right? Unless we need to keep main clean for a few days/weeks for 1.22.1?

BraisGabin · 2022-11-23T07:49:43Z

No need to block it any longer.

...t-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenAnnotation.kt

...les-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenAnnotationSpec.kt

codecov · 2022-11-23T15:46:44Z

Codecov Report

Merging #5515 (73de1f8) into main (64df1ff) will increase coverage by 85.84%.
The diff coverage is 80.43%.

❗ Current head 73de1f8 differs from pull request most recent head 717f891. Consider uploading reports for the commit 717f891 to get more accurate results

@@             Coverage Diff             @@
##             main    #5515       +/-   ##
===========================================
+ Coverage        0   85.84%   +85.84%     
- Complexity      0     3640     +3640     
===========================================
  Files           0      516      +516     
  Lines           0    12179    +12179     
  Branches        0     2176     +2176     
===========================================
+ Hits            0    10455    +10455     
- Misses          0      630      +630     
- Partials        0     1094     +1094

Impacted Files	Coverage Δ
...turbosch/detekt/rules/style/ForbiddenAnnotation.kt	`80.00% <80.00%> (ø)`
...rturbosch/detekt/rules/style/StyleGuideProvider.kt	`100.00% <100.00%> (ø)`
...osch/detekt/rules/complexity/ComplexityProvider.kt	`100.00% <0.00%> (ø)`
...sch/detekt/rules/coroutines/SleepInsteadOfDelay.kt	`75.86% <0.00%> (ø)`
...ab/arturbosch/detekt/rules/style/UnnecessaryLet.kt	`84.00% <0.00%> (ø)`
...ch/detekt/rules/style/ExplicitItLambdaParameter.kt	`100.00% <0.00%> (ø)`
.../gitlab/arturbosch/detekt/rules/bugs/UnsafeCast.kt	`94.11% <0.00%> (ø)`
...bosch/detekt/formatting/wrappers/ImportOrdering.kt	`100.00% <0.00%> (ø)`
...itlab/arturbosch/detekt/rules/style/MagicNumber.kt	`91.20% <0.00%> (ø)`
...urbosch/detekt/formatting/wrappers/NoSemicolons.kt	`100.00% <0.00%> (ø)`
... and 507 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

…otlin code

cortinico

LGTM 👍 Mostly minor nits

...les-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenAnnotationSpec.kt

cortinico · 2022-11-25T15:24:07Z

...t-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenAnnotation.kt

+ * <noncompliant>
+ * @@SuppressWarnings("unused")
+ * class SomeClass()
+ * </noncompliant>


I would keep both a compliant and a noncompliant block here.
Maybe show the @Deprecated one or others

...les-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenAnnotationSpec.kt

TWiStErRob

Sorry, every time I look, I'm in a different mindset :)

Most comments are preference now, take them as you wish.

...t-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenAnnotation.kt

TWiStErRob · 2022-11-25T21:15:29Z

...t-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenAnnotation.kt

+        if (annotations.isEmpty()) {
+            return
+        }


Is this permature optimization? (same in above method) why would this rule be active if there are no configured annotations. @BraisGabin /@cortinico is there a way to easily check this during configuration phase? Can ConfigValidator be on a rule level? (btw. ConfigValidator has no docs.)

I agree, there's not need for this if. I don't care that much about it either... but if we have this ifs we should also have a test to check what happen with annotations is empty. So I would say that it's better to remove it. But if you, @ov7a, prefer to keep it just add a test for it.

I just removed it. I agree with @TWiStErRob that it would be nice to have some example of config validation.

TWiStErRob · 2022-11-25T21:19:54Z

...t-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenAnnotation.kt

+    private fun KtTypeReference.fqNameOrNull(): FqName? {
+        return if (bindingContext != BindingContext.EMPTY) {
+            bindingContext[BindingContext.TYPE, this]?.fqNameOrNull()
+        } else {
+            null
+        }
+    }
+
+    private fun KtExpression.expressionTypeOrNull(): KotlinType? {
+        return if (bindingContext != BindingContext.EMPTY) {
+            bindingContext[BindingContext.EXPRESSION_TYPE_INFO, this]?.type
+        } else {
+            null
+        }
+    }


@RequiresTypeResolution guarantees non-empty binding context. @BraisGabin this looks like another one for the rule-authors ruleset.

Suggested change

private fun KtTypeReference.fqNameOrNull(): FqName? {

return if (bindingContext != BindingContext.EMPTY) {

bindingContext[BindingContext.TYPE, this]?.fqNameOrNull()

} else {

null

}

}

private fun KtExpression.expressionTypeOrNull(): KotlinType? {

return if (bindingContext != BindingContext.EMPTY) {

bindingContext[BindingContext.EXPRESSION_TYPE_INFO, this]?.type

} else {

null

}

}

private fun KtTypeReference.fqNameOrNull(): FqName? =

bindingContext[BindingContext.TYPE, this]?.fqNameOrNull()

private fun KtExpression.expressionTypeOrNull(): KotlinType? =

bindingContext[BindingContext.EXPRESSION_TYPE_INFO, this]?.type

leaving it open, curious what @BraisGabin thinks

Yes, I think that any check of bindingContext != BindingContext.EMPTY or bindingContext == BindingContext.EMPTY should be flagged as a code smell. That should be an easy rule to implement. @TWiStErRob do you want to create the issue for it (or the PR)

...les-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenAnnotationSpec.kt

Co-authored-by: Róbert Papp <papp.robert.s@gmail.com>

github-actions bot added the rules label Nov 7, 2022

vercel bot deployed to Preview November 7, 2022 12:37 View deployment

BraisGabin added this to the 1.23.0 milestone Nov 7, 2022

BraisGabin approved these changes Nov 7, 2022

View reviewed changes

...les-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenAnnotationSpec.kt Show resolved Hide resolved

BraisGabin added the blocked label Nov 7, 2022

vercel bot deployed to Preview November 7, 2022 13:37 View deployment

vercel bot deployed to Preview November 7, 2022 14:22 View deployment

TWiStErRob reviewed Nov 22, 2022

View reviewed changes

...t-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenAnnotation.kt Outdated Show resolved Hide resolved

BraisGabin removed the blocked label Nov 23, 2022

vercel bot deployed to Preview November 23, 2022 15:32 View deployment

github-advanced-security bot found potential problems Nov 23, 2022

View reviewed changes

TWiStErRob reviewed Nov 23, 2022

View reviewed changes

...les-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenAnnotationSpec.kt Show resolved Hide resolved

TWiStErRob reviewed Nov 23, 2022

View reviewed changes

...les-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenAnnotationSpec.kt Show resolved Hide resolved

TWiStErRob reviewed Nov 23, 2022

View reviewed changes

...les-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenAnnotationSpec.kt Show resolved Hide resolved

vercel bot deployed to Preview November 23, 2022 19:45 View deployment

ov7a added 10 commits November 23, 2022 23:02

adds ForbiddenAnnotation rule detekt#2719

bce8c52

Unnecessary test removed

2cf641d

Fixed code snippets in ForbiddenAnnotationSpec.kt so they are valid K…

dbab804

…otlin code

Report only annotation, parameters shouldn't be included

767dd24

add more annotations to defaults

f844005

more concise message

c9d47c2

nested annotations support

aece73d

alias test

e4ecc73

a test for expressions

eecf38d

a test for code blocks

2783e03

ov7a requested a review from TWiStErRob November 23, 2022 20:15

cortinico mentioned this pull request Nov 25, 2022

New Rule: Forbidden Annotation #2719

Closed

cortinico approved these changes Nov 25, 2022

View reviewed changes

vercel bot deployed to Preview November 25, 2022 18:27 View deployment

vercel bot deployed to Preview November 25, 2022 18:53 View deployment

TWiStErRob reviewed Nov 25, 2022

View reviewed changes

...les-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenAnnotationSpec.kt Outdated Show resolved Hide resolved

ov7a added 2 commits November 26, 2022 00:25

minor: style in code snippets

d2bf031

minor: compliant code in docs

3e0bcaf

ov7a force-pushed the forbidden-annotation branch from 7ce3ebd to 3e0bcaf Compare November 25, 2022 21:29

TWiStErRob approved these changes Nov 25, 2022

View reviewed changes

vercel bot deployed to Preview November 25, 2022 21:33 View deployment

ov7a and others added 3 commits November 26, 2022 00:35

bindingContext is guaranteed to be not null

2351af5

Co-authored-by: Róbert Papp <papp.robert.s@gmail.com>

minor: redundant suppression

29b4fbb

Co-authored-by: Róbert Papp <papp.robert.s@gmail.com>

minor: docs

10844f8

vercel bot deployed to Preview November 25, 2022 21:50 View deployment

simplify

ac2cf80

vercel bot deployed to Preview November 25, 2022 22:08 View deployment

vercel bot deployed to Preview November 26, 2022 07:47 View deployment

use text location where possible

83bc85f

ov7a force-pushed the forbidden-annotation branch from 414ffad to 83bc85f Compare November 26, 2022 11:27

vercel bot deployed to Preview November 26, 2022 11:33 View deployment

explicit import to avoid confusion with java annotation

73de1f8

vercel bot deployed to Preview November 26, 2022 13:06 View deployment

remove unnecessary check

717f891

vercel bot deployed to Preview November 29, 2022 14:54 View deployment

BraisGabin enabled auto-merge (squash) November 29, 2022 22:13

BraisGabin disabled auto-merge November 29, 2022 22:13

BraisGabin enabled auto-merge (squash) November 29, 2022 22:15

BraisGabin merged commit 028f69e into detekt:main Nov 29, 2022

cortinico added the notable changes Marker for notable changes in the changelog label Apr 6, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ForbiddenAnnotation rule #2719 #5515

ForbiddenAnnotation rule #2719 #5515

ov7a commented Nov 7, 2022

github-actions bot commented Nov 7, 2022 •

edited

BraisGabin left a comment

TWiStErRob commented Nov 22, 2022

BraisGabin commented Nov 23, 2022

codecov bot commented Nov 23, 2022 •

edited

cortinico left a comment

cortinico Nov 25, 2022

TWiStErRob left a comment

TWiStErRob Nov 25, 2022

BraisGabin Nov 28, 2022

ov7a Nov 29, 2022

TWiStErRob Nov 25, 2022

TWiStErRob Nov 25, 2022

BraisGabin Nov 28, 2022 •

edited

ForbiddenAnnotation rule #2719 #5515

ForbiddenAnnotation rule #2719 #5515

Conversation

ov7a commented Nov 7, 2022

github-actions bot commented Nov 7, 2022 • edited

BraisGabin left a comment

Choose a reason for hiding this comment

TWiStErRob commented Nov 22, 2022

BraisGabin commented Nov 23, 2022

codecov bot commented Nov 23, 2022 • edited

Codecov Report

cortinico left a comment

Choose a reason for hiding this comment

cortinico Nov 25, 2022

Choose a reason for hiding this comment

TWiStErRob left a comment

Choose a reason for hiding this comment

TWiStErRob Nov 25, 2022

Choose a reason for hiding this comment

BraisGabin Nov 28, 2022

Choose a reason for hiding this comment

ov7a Nov 29, 2022

Choose a reason for hiding this comment

TWiStErRob Nov 25, 2022

Choose a reason for hiding this comment

TWiStErRob Nov 25, 2022

Choose a reason for hiding this comment

BraisGabin Nov 28, 2022 • edited

Choose a reason for hiding this comment

github-actions bot commented Nov 7, 2022 •

edited

codecov bot commented Nov 23, 2022 •

edited

BraisGabin Nov 28, 2022 •

edited