Add comments with a list of regexes to ForbiddenComment

detekt-rules-style/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenComment.kt

@@ -166,23 +166,18 @@ class ForbiddenComment(config: Config = Config.empty) : Rule(config) {
     private fun PsiComment.getContent(): String = text.getCommentContent()
 
     private fun getErrorMessage(comment: Comment): String =
-        comment.reason
-            ?.let { reason -> String.format(DEFAULT_ERROR_MESSAGE, comment.value.pattern, reason) }
-            ?: String.format(DEFAULT_ERROR_MESSAGE_WITH_NO_REASON, comment.value.pattern)
+        comment.reason ?: String.format(DEFAULT_ERROR_MESSAGE, comment.value.pattern)
 
     @Suppress("DEPRECATION")
     private fun getErrorMessage(value: String): String =
         customMessage.takeUnless { it.isEmpty() }
-            ?: String.format(DEFAULT_ERROR_MESSAGE_WITH_NO_REASON, value)
+            ?: String.format(DEFAULT_ERROR_MESSAGE, value)
 
     private data class Comment(val value: Regex, val reason: String?)
 
     companion object {
-        const val DEFAULT_ERROR_MESSAGE_WITH_NO_REASON = "This comment contains '%s' " +
-            "that has been defined as forbidden in detekt."
-
         const val DEFAULT_ERROR_MESSAGE = "This comment contains '%s' " +
-            "that has been forbidden: %s"
+            "that has been defined as forbidden in detekt."
     }
 }
 

detekt-rules-style/src/test/kotlin/io/gitlab/arturbosch/detekt/rules/style/ForbiddenCommentSpec.kt

@@ -2,6 +2,7 @@
 
 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.assertThat
 import io.gitlab.arturbosch.detekt.test.compileAndLint
@@ -28,13 +29,7 @@ class ForbiddenCommentSpec {
         fun reportTodoColon() {
             val findings = ForbiddenComment().compileAndLint("// TODO: I need to fix this.")
             assertThat(findings).hasSize(1)
-            assertThat(findings[0]).hasMessage(
-                String.format(
-                    ForbiddenComment.DEFAULT_ERROR_MESSAGE,
-                    "TODO:",
-                    "Forbidden TODO todo marker in comment, please do the changes."
-                )
-            )
+            assertThat(findings[0]).hasMessage("Forbidden TODO todo marker in comment, please do the changes.")
         }
 
         @Test
@@ -62,11 +57,7 @@ class ForbiddenCommentSpec {
             val findings = ForbiddenComment().compileAndLint("// STOPSHIP: I need to fix this.")
             assertThat(findings).hasSize(1)
             assertThat(findings[0]).hasMessage(
-                String.format(
-                    ForbiddenComment.DEFAULT_ERROR_MESSAGE,
-                    "STOPSHIP:",
-                    "Forbidden STOPSHIP todo marker in comment, please address the problem before shipping the code."
-                )
+                "Forbidden STOPSHIP todo marker in comment, please address the problem before shipping the code."
             )
         }
 
@@ -258,15 +249,26 @@ class ForbiddenCommentSpec {
     @Nested
     inner class `custom message is not configured` {
         private val messageConfig = TestConfig(VALUES to "Comment")
+        private val messageConfigWithReason = ForbiddenComment(
+            ValueWithReason("Comment", "Comment is disallowed")
+        )
 
         @Test
         fun `should report a Finding with default Message`() {
             val comment = "// Comment"
             val findings = ForbiddenComment(messageConfig).compileAndLint(comment)
-            val expectedMessage = String.format(ForbiddenComment.DEFAULT_ERROR_MESSAGE_WITH_NO_REASON, "Comment")
+            val expectedMessage = String.format(ForbiddenComment.DEFAULT_ERROR_MESSAGE, "Comment")
             assertThat(findings).hasSize(1)
             assertThat(findings.first().message).isEqualTo(expectedMessage)
         }
+
+        @Test
+        fun `should report a Finding with reason`() {
+            val comment = "// Comment"
+            val findings = ForbiddenComment(messageConfigWithReason).compileAndLint(comment)
+            assertThat(findings).hasSize(1)
+            assertThat(findings.first().message).isEqualTo("Comment is disallowed")
+        }
     }
 
     @Nested
@@ -289,7 +291,7 @@ class ForbiddenCommentSpec {
             val findings = ForbiddenComment(messageConfig).compileAndLint(comment)
             assertThat(findings).hasSize(1)
             assertThat(findings[0])
-                .hasMessage(String.format(ForbiddenComment.DEFAULT_ERROR_MESSAGE_WITH_NO_REASON, "STOPSHIP"))
+                .hasMessage(String.format(ForbiddenComment.DEFAULT_ERROR_MESSAGE, "STOPSHIP"))
         }
 
         @Test
@@ -298,7 +300,7 @@ class ForbiddenCommentSpec {
             val findings = ForbiddenComment(messageConfig).compileAndLint(comment)
             assertThat(findings).hasSize(1)
             assertThat(findings[0])
-                .hasMessage(String.format(ForbiddenComment.DEFAULT_ERROR_MESSAGE_WITH_NO_REASON, patternStr))
+                .hasMessage(String.format(ForbiddenComment.DEFAULT_ERROR_MESSAGE, patternStr))
         }
 
         @Test
@@ -307,7 +309,7 @@ class ForbiddenCommentSpec {
             val findings = ForbiddenComment(messageConfig).compileAndLint(comment)
             assertThat(findings).hasSize(1)
             assertThat(findings[0])
-                .hasMessage(String.format(ForbiddenComment.DEFAULT_ERROR_MESSAGE_WITH_NO_REASON, patternStr))
+                .hasMessage(String.format(ForbiddenComment.DEFAULT_ERROR_MESSAGE, patternStr))
         }
 
         @Test
@@ -1023,3 +1025,7 @@ class ForbiddenCommentSpec {
 @Suppress("TestFunctionName") // This is a factory function for ForbiddenComment
 private fun ForbiddenComment(vararg comments: String): ForbiddenComment =
     ForbiddenComment(TestConfig(COMMENTS to comments.toList()))
+
+@Suppress("TestFunctionName")
+private fun ForbiddenComment(vararg comments: ValueWithReason): ForbiddenComment =
+    ForbiddenComment(TestConfig(COMMENTS to comments.map { mapOf("value" to it.value, "reason" to it.reason) }))