ReturnCount.excludedFunctions should be a List<String> (detekt#5081)

VitalyVPinchuk · Jul 25, 2022 · 671b6a5 · 671b6a5
1 parent a5db5ee
commit 671b6a5
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/detekt-core/src/main/resources/default-detekt-config.yml b/detekt-core/src/main/resources/default-detekt-config.yml
@@ -629,7 +629,8 @@ style:
   ReturnCount:
     active: true
     max: 2
-    excludedFunctions: 'equals'
+    excludedFunctions:
+      - 'equals'
     excludeLabeled: false
     excludeReturnFromLambda: true
     excludeGuardClauses: false

diff --git a/detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ReturnCount.kt b/detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ReturnCount.kt
@@ -59,8 +59,8 @@ class ReturnCount(config: Config = Config.empty) : Rule(config) {
     @Configuration("define the maximum number of return statements allowed per function")
     private val max: Int by config(2)
 
-    @Configuration("define a free-form comma separated list of function names to be ignored by this check")
-    private val excludedFunctions: SplitPattern by config("equals") { SplitPattern(it) }
+    @Configuration("define a list of function names to be ignored by this check")
+    private val excludedFunctions: SplitPattern by config(listOf("equals")) { SplitPattern(it.joinToString(",")) }
 
     @Configuration("if labeled return statements should be ignored")
     private val excludeLabeled: Boolean by config(false)

diff --git a/...kt-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ReturnCountSpec.kt b/...kt-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ReturnCountSpec.kt
@@ -347,7 +347,7 @@ class ReturnCountSpec {
                 TestConfig(
                     mapOf(
                         MAX to "2",
-                        EXCLUDED_FUNCTIONS to "test1,test2"
+                        EXCLUDED_FUNCTIONS to listOf("test1", "test2")
                     )
                 )
             ).compileAndLint(code)