Add configuration to add alternate trimming methods (#6063)

detekt · May 3, 2023 · f8f6105 · f8f6105
1 parent 93f6f57
commit f8f6105
Show file tree

Hide file tree

Showing 4 changed files with 70 additions and 26 deletions.
diff --git a/detekt-core/src/main/resources/default-detekt-config.yml b/detekt-core/src/main/resources/default-detekt-config.yml
@@ -641,6 +641,9 @@ style:
   MultilineRawStringIndentation:
     active: false
     indentSize: 4
+    trimmingMethods:
+      - 'trimIndent'
+      - 'trimMargin'
   NestedClassesVisibility:
     active: true
   NewLineAtEndOfFile:
@@ -693,6 +696,9 @@ style:
     active: false
   TrimMultilineRawString:
     active: false
+    trimmingMethods:
+      - 'trimIndent'
+      - 'trimMargin'
   UnderscoresInNumericLiterals:
     active: false
     acceptableLength: 4

diff --git a/.../src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/MultilineRawStringIndentation.kt b/.../src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/MultilineRawStringIndentation.kt
@@ -62,10 +62,13 @@ class MultilineRawStringIndentation(config: Config) : Rule(config) {
     @Configuration("indentation size")
     private val indentSize by config(4)
 
+    @Configuration("allows to provide a list of multiline string trimming methods")
+    private val trimmingMethods: List<String> by config(listOf("trimIndent", "trimMargin"))
+
     override fun visitStringTemplateExpression(expression: KtStringTemplateExpression) {
         super.visitStringTemplateExpression(expression)
 
-        if (!expression.isRawStringWithLineBreak() || !expression.isTrimmed()) return
+        if (!expression.isRawStringWithLineBreak() || !expression.isTrimmed(trimmingMethods)) return
 
         if (!expression.isSurroundedByLineBreaks()) {
             report(

diff --git a/...s-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/TrimMultilineRawString.kt b/...s-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/TrimMultilineRawString.kt
@@ -7,6 +7,8 @@ import io.gitlab.arturbosch.detekt.api.Entity
 import io.gitlab.arturbosch.detekt.api.Issue
 import io.gitlab.arturbosch.detekt.api.Rule
 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.rules.isConstant
 import io.gitlab.arturbosch.detekt.rules.safeAs
 import org.jetbrains.kotlin.psi.KtAnnotationEntry
@@ -54,10 +56,16 @@ class TrimMultilineRawString(val config: Config) : Rule(config) {
         Debt.FIVE_MINS
     )
 
+    @Configuration("allows to provide a list of multiline string trimming methods")
+    private val trimmingMethods: List<String> by config(listOf("trimIndent", "trimMargin"))
+
     override fun visitStringTemplateExpression(expression: KtStringTemplateExpression) {
         super.visitStringTemplateExpression(expression)
 
-        if (expression.isRawStringWithLineBreak() && !expression.isTrimmed() && !expression.isExpectedAsConstant()) {
+        if (expression.isRawStringWithLineBreak() &&
+            !expression.isTrimmed(trimmingMethods) &&
+            !expression.isExpectedAsConstant()
+        ) {
             report(
                 CodeSmell(
                     issue,
@@ -75,14 +83,14 @@ fun KtStringTemplateExpression.isRawStringWithLineBreak(): Boolean =
         literalText != null && "\n" in literalText
     }
 
-fun KtStringTemplateExpression.isTrimmed(): Boolean {
+fun KtStringTemplateExpression.isTrimmed(trimmingMethods: List<String>): Boolean {
     val nextCall = getQualifiedExpressionForReceiver()
         ?.selectorExpression
         ?.safeAs<KtCallExpression>()
         ?.calleeExpression
         ?.text
 
-    return nextCall in trimFunctions
+    return nextCall in trimmingMethods
 }
 
 @Suppress("ReturnCount")
@@ -103,5 +111,3 @@ private fun KtStringTemplateExpression.isExpectedAsConstant(): Boolean {
 
     return false
 }
-
-private val trimFunctions = listOf("trimIndent", "trimMargin")
diff --git a/...yle/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/TrimMultilineRawStringSpec.kt b/...yle/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/TrimMultilineRawStringSpec.kt
@@ -3,6 +3,7 @@
 package io.gitlab.arturbosch.detekt.rules.style
 
 import io.gitlab.arturbosch.detekt.api.Config
+import io.gitlab.arturbosch.detekt.test.TestConfig
 import io.gitlab.arturbosch.detekt.test.compileAndLint
 import org.assertj.core.api.Assertions.assertThat
 import org.junit.jupiter.api.Test
@@ -13,18 +14,46 @@ class TrimMultilineRawStringSpec {
     @Test
     fun `raises multiline raw strings without trim`() {
         val code = """
-            val a = ${TQ}
+            val a = $TQ
             Hello world!
-            ${TQ}
+            $TQ
         """.trimIndent()
         subject.compileAndLint(code)
         assertThat(subject.findings).hasSize(1)
     }
 
     @Test
-    fun `raises multiline raw strings with lenght`() {
+    fun `doesn't raise multiline raw strings with custom default configured trimIndent method`() {
+        fun String.trimIndent() = this
         val code = """
-            val a = ${TQ}
+            val a = $TQ
+            Hello world!
+            $TQ.trimIndent()
+        """.trimIndent()
+        subject.compileAndLint(code)
+        assertThat(subject.findings).isEmpty()
+    }
+
+    @Test
+    fun `doesn't raise multiline raw strings with custom configured customTrim method`() {
+        val code = """
+            fun String.customTrim() = this
+            val a = $TQ
+            Hello world!
+            $TQ.customTrim()
+        """.trimIndent()
+        val findings = TrimMultilineRawString(
+            TestConfig(
+                "trimmingMethods" to "customTrim"
+            )
+        ).compileAndLint(code)
+        assertThat(findings).isEmpty()
+    }
+
+    @Test
+    fun `raises multiline raw strings with length`() {
+        val code = """
+            val a = $TQ
             Hello world!
             ${TQ}.length
         """.trimIndent()
@@ -33,9 +62,9 @@ class TrimMultilineRawStringSpec {
     }
 
     @Test
-    fun `doesn't raise multiline raw strings without trimIndent`() {
+    fun `doesn't raise multiline raw strings with trimIndent`() {
         val code = """
-            val a = ${TQ}
+            val a = $TQ
             Hello world!
             ${TQ}.trimIndent()
         """.trimIndent()
@@ -44,9 +73,9 @@ class TrimMultilineRawStringSpec {
     }
 
     @Test
-    fun `doesn't raise multiline raw strings without trimMargin`() {
+    fun `doesn't raise multiline raw strings with trimMargin`() {
         val code = """
-            val a = ${TQ}
+            val a = $TQ
             |Hello world!
             ${TQ}.trimMargin()
         """.trimIndent()
@@ -55,9 +84,9 @@ class TrimMultilineRawStringSpec {
     }
 
     @Test
-    fun `doesn't raise multiline raw strings without trimMargin with parameter`() {
+    fun `doesn't raise multiline raw strings with trimMargin with parameter`() {
         val code = """
-            val a = ${TQ}
+            val a = $TQ
             >Hello world!
             ${TQ}.trimMargin(">")
         """.trimIndent()
@@ -99,11 +128,11 @@ class TrimMultilineRawStringSpec {
         val code = """
             object O {
                 const val s =
-                    ${TQ}
+                    $TQ
                         Given something
                         When something
                         Then something
-                    ${TQ}
+                    $TQ
             }
         """.trimIndent()
         subject.compileAndLint(code)
@@ -115,11 +144,11 @@ class TrimMultilineRawStringSpec {
         val code = """
             annotation class DisplayName(val s: String)
             @DisplayName(
-                ${TQ}
+                $TQ
                     Given something
                     When something
                     Then something
-                ${TQ}
+                $TQ
             )
             class Foo
         """.trimIndent()
@@ -132,11 +161,11 @@ class TrimMultilineRawStringSpec {
         val code = """
             annotation class DisplayName(
                 val s: String =
-                    ${TQ}
+                    $TQ
                         Given something
                         When something
                         Then something
-                    ${TQ}
+                    $TQ
             )
         """.trimIndent()
         subject.compileAndLint(code)
@@ -148,11 +177,11 @@ class TrimMultilineRawStringSpec {
         val code = """
             fun foo(s: String) {}
             val bar = foo(
-                ${TQ}
+                $TQ
                     Given something
                     When something
                     Then something
-                ${TQ}
+                $TQ
             )
             class Foo
         """.trimIndent()
@@ -165,11 +194,11 @@ class TrimMultilineRawStringSpec {
         val code = """
             class Foo(
                 val s: String =
-                    ${TQ}
+                    $TQ
                         Given something
                         When something
                         Then something
-                    ${TQ}
+                    $TQ
             )
         """.trimIndent()
         subject.compileAndLint(code)