IDE: Use MarkedString in hover

Author: Duhemm

language-server/src/dotty/tools/languageserver/DottyLanguageServer.scala

@@ -19,7 +19,7 @@ import scala.io.Codec
 import dotc._
 import ast.{Trees, tpd}
 import core._, core.Decorators.{sourcePos => _, _}
-import Contexts._, Flags._, Names._, NameOps._, Symbols._, SymDenotations._, Trees._, Types._
+import Comments.Comment, Contexts._, Flags._, Names._, NameOps._, Symbols._, SymDenotations._, Trees._, Types._
 import classpath.ClassPathEntries
 import reporting._, reporting.diagnostic.MessageContainer
 import util._
@@ -346,9 +346,9 @@ class DottyLanguageServer extends LanguageServer
     else {
       import dotty.tools.dotc.core.Comments._
       val symbol = Interactive.enclosingSourceSymbol(trees, pos)
-      val doc = ctx.docCtx.flatMap(_.docstring(symbol)).map(_.raw + " / ").getOrElse("")
-      val str = tpw.show.toString
-      new Hover(List(JEither.forLeft(doc + str)).asJava, null)
+      val docComment = ctx.docCtx.flatMap(_.docstring(symbol))
+      val markedString = docMarkedString(docComment, tpw.show.toString)
+      new Hover(List(JEither.forRight(markedString)).asJava, null)
     }
   }
 
@@ -465,6 +465,21 @@ object DottyLanguageServer {
     item
   }
 
+  private def docMarkedString(comment: Option[Comment], info: String): lsp4j.MarkedString = {
+
+    val formattedComment = comment.map { comment =>
+      s"""```scala
+         |${comment.raw}
+         |```
+         |""".stripMargin
+    }.getOrElse("")
+
+    val markedString = new lsp4j.MarkedString()
+    markedString.setValue(formattedComment + info)
+    markedString
+  }
+
+
   /** Create an lsp4j.SymbolInfo from a Symbol and a SourcePosition */
   def symbolInfo(sym: Symbol, pos: SourcePosition)(implicit ctx: Context): lsp4j.SymbolInformation = {
     def symbolKind(sym: Symbol)(implicit ctx: Context): lsp4j.SymbolKind = {

language-server/test/dotty/tools/languageserver/HoverTest.scala

@@ -12,7 +12,10 @@ class HoverTest {
   @Test def hoverOnClassShowsDoc: Unit = {
     code"""$m1 /** foo */ ${m2}class Foo $m3 $m4""".withSource
       .hover(m1 to m2, "")
-      .hover(m2 to m3, "/** foo */ / Foo")
+      .hover(m2 to m3, """```scala
+                         |/** foo */
+                         |```
+                         |Foo""".stripMargin)
       .hover(m3 to m4, "")
   }
 

language-server/test/dotty/tools/languageserver/util/actions/CodeHover.scala

@@ -21,8 +21,9 @@ class CodeHover(override val range: CodeRange, expected: String) extends ActionO
     else {
       assertEquals(1, result.getContents.size)
       val content = result.getContents.get(0)
-      assertTrue(content.isLeft)
-      assertEquals(expected, content.getLeft)
+      assertTrue(content.isRight)
+      val markedString = content.getRight.getValue
+      assertEquals(expected, markedString)
     }
   }