Merge pull request #54 from sourcegraph/nsc/empty-kdoc-fix

fix outofbounds exception when kdoc line is empty
sourcegraph · Apr 17, 2023 · f1035f5 · f1035f5
2 parents 51b3e0d + 4d77f55
commit f1035f5
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 1 deletion.
diff --git a/...tlinc/src/main/kotlin/com/sourcegraph/semanticdb_kotlinc/SemanticdbTextDocumentBuilder.kt b/...tlinc/src/main/kotlin/com/sourcegraph/semanticdb_kotlinc/SemanticdbTextDocumentBuilder.kt
@@ -133,6 +133,7 @@ class SemanticdbTextDocumentBuilder(
         if (kdoc.isEmpty()) return kdoc
         val out = StringBuilder().append("\n\n").append("----").append("\n")
         kdoc.lineSequence().forEach { line ->
+            if (line.isEmpty()) return@forEach
             var start = 0
             while (start < line.length && line[start].isWhitespace()) {
                 start++

diff --git a/...-kotlinc/src/test/kotlin/com/sourcegraph/semanticdb_kotlinc/test/SemanticdbSymbolsTest.kt b/...-kotlinc/src/test/kotlin/com/sourcegraph/semanticdb_kotlinc/test/SemanticdbSymbolsTest.kt
@@ -1,6 +1,8 @@
 package com.sourcegraph.semanticdb_kotlinc.test
 
 import com.sourcegraph.semanticdb_kotlinc.*
+import com.sourcegraph.semanticdb_kotlinc.Semanticdb.Documentation.Format
+import com.sourcegraph.semanticdb_kotlinc.Semanticdb.Language
 import com.sourcegraph.semanticdb_kotlinc.Semanticdb.SymbolOccurrence.Role
 import com.sourcegraph.semanticdb_kotlinc.test.ExpectedSymbols.SemanticdbData
 import com.sourcegraph.semanticdb_kotlinc.test.ExpectedSymbols.SymbolCacheData
@@ -590,4 +592,44 @@ class SemanticdbSymbolsTest {
                                         }
                                     }))))
             .mapCheckExpectedSymbols()
+
+    @TestFactory
+    fun kdoc() =
+        listOf(
+            ExpectedSymbols(
+                "empty kdoc line",
+                SourceFile.testKt(
+                    """
+                    |/**
+                    |
+                    |hello world
+                    |* test content
+                    |*/
+                    |val x = ""
+                    |""".trimMargin()),
+                semanticdb = SemanticdbData(
+                    expectedSymbols =
+                        listOf(
+                            SymbolInformation {
+                                symbol = "TestKt#x."
+                                displayName = "x"
+                                language = Language.KOTLIN
+                                documentation {
+                                    message = "```kt\npublic val x: kotlin.String\n```\n\n----\n\n\nhello world\n test content\n"
+                                    format = Format.MARKDOWN
+                                }
+                            },
+                            SymbolInformation {
+                                symbol = "TestKt#getX()."
+                                displayName = "x"
+                                language = Language.KOTLIN
+                                documentation {
+                                    message = "```kt\npublic val x: kotlin.String\n```\n\n----\n\n\nhello world\n test content\n"
+                                    format = Format.MARKDOWN
+                                }
+                            }
+                        )
+                )
+            )
+        ).mapCheckExpectedSymbols()
 }
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -1,4 +1,3 @@
-
 rootProject.name = "lsif-kotlin"
 
 include(
Original file line number	Diff line number	Diff line change
		@@ -1,4 +1,3 @@

		rootProject.name = "lsif-kotlin"

		include(
Expand Down