Don't exclude tests in WildcardImport Rule (#5121)

* Use MagicNumber as sample for the tests * There is not a good reason to allow Wildcard imports inside the tests if you don't want them in your production code * Remove exceptions in the WildcardImport rule
detekt · Jul 25, 2022 · bcb245e · bcb245e
1 parent c46b9ec
commit bcb245e
Show file tree

Hide file tree

Showing 8 changed files with 10 additions and 9 deletions.
diff --git a/config/detekt/detekt.yml b/config/detekt/detekt.yml
@@ -274,3 +274,6 @@ style:
   VarCouldBeVal:
     active: true
     ignoreAnnotated: ['Parameter']
+  WildcardImport:
+    active: true
+    excludeImports: []
diff --git a/detekt-core/src/main/resources/default-detekt-config.yml b/detekt-core/src/main/resources/default-detekt-config.yml
@@ -716,6 +716,5 @@ style:
     ignoreLateinitVar: false
   WildcardImport:
     active: true
-    excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']
     excludeImports:
       - 'java.util.*'
diff --git a/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/KtLintMultiRule.kt b/detekt-formatting/src/main/kotlin/io/gitlab/arturbosch/detekt/formatting/KtLintMultiRule.kt
@@ -60,7 +60,7 @@ import org.jetbrains.kotlin.com.intellij.lang.ASTNode
 import org.jetbrains.kotlin.com.intellij.psi.impl.source.JavaDummyElement
 import org.jetbrains.kotlin.com.intellij.psi.impl.source.JavaDummyHolder
 import org.jetbrains.kotlin.psi.KtFile
-import java.util.*
+import java.util.LinkedList
 
 /**
  * Runs all KtLint rules.

diff --git a/.../src/main/kotlin/io/gitlab/arturbosch/detekt/generator/printer/defaultconfig/Exclusion.kt b/.../src/main/kotlin/io/gitlab/arturbosch/detekt/generator/printer/defaultconfig/Exclusion.kt
@@ -27,7 +27,6 @@ private object TestExclusions : Exclusions() {
     override val ruleSets = emptySet<String>()
     override val rules = setOf(
         "FunctionNaming",
-        "WildcardImport",
         "LateinitUsage",
         "StringLiteralDuplication",
         "SpreadOperator",

diff --git a/...or/src/test/kotlin/io/gitlab/arturbosch/detekt/generator/printer/DeprecatedPrinterSpec.kt b/...or/src/test/kotlin/io/gitlab/arturbosch/detekt/generator/printer/DeprecatedPrinterSpec.kt
@@ -10,8 +10,8 @@ class DeprecatedPrinterSpec {
     fun `prints the correct properties`() {
         val markdownString = DeprecatedPrinter.print(listOf(createRuleSetPage()))
         val expectedMarkdownString = """
-            style>WildcardImport>conf2=use conf1 instead
-            style>WildcardImport>conf4=use conf3 instead
+            style>MagicNumber>conf2=use conf1 instead
+            style>MagicNumber>conf4=use conf3 instead
             
         """.trimIndent()
         assertThat(markdownString).isEqualTo(expectedMarkdownString)

diff --git a/...enerator/src/test/kotlin/io/gitlab/arturbosch/detekt/generator/util/RuleSetPageCreator.kt b/...enerator/src/test/kotlin/io/gitlab/arturbosch/detekt/generator/util/RuleSetPageCreator.kt
@@ -59,7 +59,7 @@ internal fun createRuleSetPage(): RuleSetPage {
 
 internal fun createRules(): List<Rule> {
     val rule1 = Rule(
-        name = "WildcardImport",
+        name = "MagicNumber",
         description = "a wildcard import",
         nonCompliantCodeExample = "import foo.*",
         compliantCodeExample = "import foo.bar",

diff --git a/detekt-generator/src/test/resources/RuleSet.md b/detekt-generator/src/test/resources/RuleSet.md
@@ -1,6 +1,6 @@
 style rule set
 
-### WildcardImport
+### MagicNumber
 
 a wildcard import
 

diff --git a/detekt-generator/src/test/resources/RuleSetConfig.yml b/detekt-generator/src/test/resources/RuleSetConfig.yml
@@ -7,9 +7,9 @@ style:
   rulesetconfig3:
     - 'first'
     - 'se*cond'
-  WildcardImport:
+  MagicNumber:
     active: true
-    excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**']
+    excludes: ['**/test/**', '**/androidTest/**', '**/commonTest/**', '**/jvmTest/**', '**/jsTest/**', '**/iosTest/**', '**/*.kts']
     conf1: 'foo'
     conf3:
       - 'a'