EndOfSentenceFormat: fix HTML tag heuristic (#5313)

detekt · Sep 18, 2022 · 8c11aaf · 8c11aaf
1 parent 783a623
commit 8c11aaf
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/...on/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/documentation/EndOfSentenceFormat.kt b/...on/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/documentation/EndOfSentenceFormat.kt
@@ -29,7 +29,7 @@ class EndOfSentenceFormat(config: Config = Config.empty) : Rule(config) {
     @Configuration("regular expression which should match the end of the first sentence in the KDoc")
     private val endOfSentenceFormat: Regex by config("""([.?!][ \t\n\r\f<])|([.?!:]$)""") { it.toRegex() }
 
-    private val htmlTag = Regex("<.+>")
+    private val htmlTag = Regex("^<.+>")
 
     override fun visitDeclaration(dcl: KtDeclaration) {
         super.visitDeclaration(dcl)

diff --git a/...rc/test/kotlin/io/gitlab/arturbosch/detekt/rules/documentation/EndOfSentenceFormatSpec.kt b/...rc/test/kotlin/io/gitlab/arturbosch/detekt/rules/documentation/EndOfSentenceFormatSpec.kt
@@ -142,6 +142,21 @@ class EndOfSentenceFormatSpec {
         assertThat(subject.compileAndLint(code)).isEmpty()
     }
 
+    @Test
+    fun `reports invalid KDoc even when it looks like it contains html tags`() {
+        val code = """
+        /**
+         * < is the less-than sign --
+         * ```
+         * <code>this contains HTML, but doesn't start with a tag</code>
+         * ```
+         */
+        class Test {
+        }
+        """.trimIndent()
+        assertThat(subject.compileAndLint(code)).hasSize(1)
+    }
+
     @Test
     fun `does not report KDoc ending with periods`() {
         val code = """