jlengrand/detekt
1
0
Fork 0
mirror of https://github.com/jlengrand/detekt.git synced 2026-03-10 08:11:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add support for reasons in ForbiddenImport

Browse Source
This commit is contained in:
Brais Gabín
2022-06-04 12:28:53 +02:00
parent 9af651df23
commit 9d69fc1710
2 changed files with 37 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenImport.kt
View File

@@ -10,6 +10,7 @@ import io.gitlab.arturbosch.detekt.api.Severity
import io.gitlab.arturbosch.detekt.api.config
import io.gitlab.arturbosch.detekt.api.internal.Configuration
import io.gitlab.arturbosch.detekt.api.simplePatternToRegex
import io.gitlab.arturbosch.detekt.api.valuesWithReason
import org.jetbrains.kotlin.psi.KtImportDirective
/**
@@ -33,8 +34,8 @@ class ForbiddenImport(config: Config = Config.empty) : Rule(config) {
)
@Configuration("imports which should not be used")
private val imports: List<Regex> by config(emptyList<String>()) {
it.distinct().map(String::simplePatternToRegex)
private val imports: List<Forbidden> by config(valuesWithReason()) { list ->
list.map { Forbidden(it.value.simplePatternToRegex(), it.reason) }
}
@Configuration("reports imports which match the specified regular expression. For example `net.*R`.")
@@ -44,17 +45,29 @@ class ForbiddenImport(config: Config = Config.empty) : Rule(config) {
super.visitImportDirective(importDirective)
val import = importDirective.importedFqName?.asString().orEmpty()
if (imports.any { it.matches(import) } || containsForbiddenPattern(import)) {
report(
CodeSmell(
issue,
Entity.from(importDirective),
"The import `$import` has been forbidden in the Detekt config."
)
)
val forbidden = imports.find { it.import.matches(import) }
val reason = if (forbidden != null) {
if (forbidden.reason != null) {
"The import `$import` has been forbidden: ${forbidden.reason}"
} else {
defaultReason(import)
}
} else {
if (containsForbiddenPattern(import)) defaultReason(import) else null
}
if (reason != null) {
report(CodeSmell(issue, Entity.from(importDirective), reason))
}
}
private fun defaultReason(forbiddenImport: String): String {
return "The import `$forbiddenImport` has been forbidden in the Detekt config."
}
private fun containsForbiddenPattern(import: String): Boolean =
forbiddenPatterns.pattern.isNotEmpty() && forbiddenPatterns.containsMatchIn(import)
}
private class Forbidden(val import: Regex, val reason: String?)

14
detekt-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenImportSpec.kt
View File

@@ -1,7 +1,9 @@
package io.gitlab.arturbosch.detekt.rules.style
import io.gitlab.arturbosch.detekt.api.ValueWithReason
import io.gitlab.arturbosch.detekt.test.TestConfig
import io.gitlab.arturbosch.detekt.test.lint
import io.gitlab.arturbosch.detekt.test.toConfig
import org.assertj.core.api.Assertions.assertThat
import org.junit.jupiter.api.DisplayName
import org.junit.jupiter.api.Test
@@ -50,6 +52,18 @@ class ForbiddenImportSpec {
.isEqualTo("The import `kotlin.SinceKotlin` has been forbidden in the Detekt config.")
}
@Test
@DisplayName("should report kotlin.* when imports are kotlin.* with reasons")
fun reportKotlinWildcardImports2() {
val config = TestConfig(mapOf(IMPORTS to listOf(ValueWithReason("kotlin.*", "I'm just joking!").toConfig())))
val findings = ForbiddenImport(config).lint(code)
assertThat(findings).hasSize(2)
assertThat(findings[0].message)
.isEqualTo("The import `kotlin.jvm.JvmField` has been forbidden: I'm just joking!")
assertThat(findings[1].message)
.isEqualTo("The import `kotlin.SinceKotlin` has been forbidden: I'm just joking!")
}
@Test
@DisplayName("should report kotlin.SinceKotlin when specified via fully qualified name")
fun reportKotlinSinceKotlinWhenFqdnSpecified() {