Fix issue of missing whitespaces after link tags in KDoc

Summary: This is a smarter way to deal with KDoc, ignore exactly one space after an asterisk. Otherwise keep them. Reviewed By: cgrushko Differential Revision: D19844836 fbshipit-source-id: 1fefe459354e1f944f68d28af53e0006de2d7a14
facebook · Feb 12, 2020 · 0ef289e · 0ef289e
1 parent 733c7d9
commit 0ef289e
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 8 deletions.
diff --git a/core/src/main/java/com/facebook/ktfmt/kdoc/KDocFormatter.kt b/core/src/main/java/com/facebook/ktfmt/kdoc/KDocFormatter.kt
@@ -58,17 +58,19 @@ object KDocFormatter {
     var previousType: IElementType? = null
     while (kDocLexer.tokenType != null) {
       val tokenType = kDocLexer.tokenType
-      val tokenText = kDocLexer.tokenText
+      val tokenText = with(kDocLexer.tokenText) {
+        if (previousType == KDocTokens.LEADING_ASTERISK && first() == ' ') substring(1) else this
+      }
+
       if (tokenType === KDocTokens.START) {
         newTokensBuilder.add(Token(BEGIN_KDOC, tokenText))
       } else if (tokenType === KDocTokens.LEADING_ASTERISK) {
-        // ignore
+        // Ignore, no need to output anything
       } else if (tokenType === KDocTokens.END) {
         newTokensBuilder.add(Token(END_KDOC, tokenText))
       } else if (tokenType === KDocTokens.TEXT) {
-        val trimmedText = tokenText.trim { it <= ' ' }
-        if (!trimmedText.isEmpty()) {
-          val words = trimmedText.split(" +".toRegex()).dropLastWhile { it.isEmpty() }.toTypedArray()
+        if (!tokenText.isEmpty()) {
+          val words = tokenText.split(" +".toRegex()).dropLastWhile { it.isEmpty() }
           var first = true
           for (word in words) {
             if (first) {
@@ -82,10 +84,9 @@ object KDocFormatter {
           }
         }
       } else if (tokenType === KDocTokens.TAG_NAME) {
-        newTokensBuilder.add(Token(LITERAL, tokenText.trim { it <= ' ' }))
+        newTokensBuilder.add(Token(LITERAL, tokenText))
       } else if (tokenType === KDocTokens.CODE_BLOCK_TEXT) {
-        val trimmedFirstSpaceText = if (tokenText.first() == ' ') tokenText.substring(1) else tokenText
-        newTokensBuilder.add(Token(LITERAL, trimmedFirstSpaceText))
+        newTokensBuilder.add(Token(LITERAL, tokenText))
       } else if (tokenType === KDocTokens.MARKDOWN_INLINE_LINK) {
         newTokensBuilder.add(Token(LITERAL, tokenText))
       } else if (tokenType === KDocTokens.MARKDOWN_LINK) {

diff --git a/core/src/test/java/com/facebook/ktfmt/FormatterKtTest.kt b/core/src/test/java/com/facebook/ktfmt/FormatterKtTest.kt
@@ -1712,6 +1712,13 @@ class FormatterKtTest {
       |class MyClass {}
       |""".trimMargin())
 
+  @Test
+  fun `handle KDoc with link reference`() = assertFormatted(
+      """
+      |/** Doc line with a reference to [AnotherClass] in the middle of a sentence */
+      |class MyClass {}
+      |""".trimMargin())
+
   /** Verifies the given code passes through formatting, and stays the same at the end */
   private fun assertFormatted(code: String, maxWidth: Int = DEFAULT_MAX_WIDTH) {
     assertThatFormatting(code, maxWidth).isEqualTo(code)