Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

AnnotationSuppressor now resolves Full Qualified Annotation Names without type solving #4570

Merged
merged 12 commits into from Feb 23, 2022
Merged

AnnotationSuppressor now resolves Full Qualified Annotation Names without type solving #4570

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
e81fb00
Simplify AnnotationExcluderSpec
BraisGabin Feb 6, 2022
b8ba1f1
Improve tests
BraisGabin Feb 6, 2022
2c02374
Improve tests
BraisGabin Feb 6, 2022
3ddefba
Fix FullQualifiedNameGuesser
BraisGabin Feb 6, 2022
95d2bc0
Allow List<Regex> inside AnnotationExcluder to give more options to t…
BraisGabin Feb 6, 2022
9e1e90b
Test with and without type-solving
BraisGabin Feb 6, 2022
de08d9c
Make AnnotationExcluder use the BindingContext when available
BraisGabin Feb 6, 2022
320a26e
AnnotationSuppressor works with Full Qualified names without type sol…
BraisGabin Feb 6, 2022
1908a88
Address PR comments
BraisGabin Feb 9, 2022
d46e3a0
Update detekt-psi-utils/src/test/kotlin/io/github/detekt/psi/internal…
BraisGabin Feb 21, 2022
550fb86
Support star imports
BraisGabin Feb 21, 2022
30ce1c7
Improve readability
BraisGabin Feb 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 4 additions & 1 deletion detekt-psi-utils/src/main/kotlin/io/github/detekt/psi/internal/FullQualifiedNameGuesser.kt
View file
Open in desktop
Expand Up @@ -39,13 +39,16 @@ class FullQualifiedNameGuesser internal constructor(
if (packageName != null) {
add("$packageName.$name")
}
if (name.first().isLowerCase()) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the reason for this check?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For that reason we use a heuristic here: If the first character is lower case we assume it's a package name. Therefore I think this is to handle cases like dagger\..*. First uppercase indicates a class name and Component\..* would not be a valid case.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry @schalkms, I didn't see this comment before.

Yes the reason was that heuristic... but now that I think about that I'm not sure if this class needs to know about this. We could assume that any string that we can't match with an import could be a FullQualifiedName. But I don't know if that's better or worse... That's the issue with this mixed behaviour. The "general use cases" are easy to manage but all this edge cases are really difficult to manage because we can't know for sure.

add(name)
}
}
}
}

private fun findName(name: String): String? {
val searchName = name.substringBefore('.')
val resolvedName = resolvedNames[searchName]
val resolvedName = resolvedNames[searchName] ?: return null
return if (name == searchName) {
resolvedName
} else {
Expand Down
6 changes: 6 additions & 0 deletions ...t-psi-utils/src/test/kotlin/io/github/detekt/psi/internal/FullQualifiedNameGuesserSpec.kt
View file
Open in desktop
Expand Up @@ -61,6 +61,12 @@ class FullQualifiedNameGuesserSpec {
assertThat(sut.getFullQualifiedName("Static.Factory"))
.containsExactlyInAnyOrder("kotlin.jvm.JvmStatic.Factory")
}

@Test
fun `when don't use the import`() {
BraisGabin marked this conversation as resolved.
Show resolved Hide resolved
assertThat(sut.getFullQualifiedName("kotlin.jvm.JvmField"))
.containsExactlyInAnyOrder("kotlin.jvm.JvmField", "foo.kotlin.jvm.JvmField")
}
}

@Nested
Expand Down