Display snippet compilation messages in scaladoc

Author: KacperFKorban

scaladoc-js/resources/scaladoc-searchbar.css

@@ -105,27 +105,33 @@
 
 .snippet-comment-button {
     position: absolute;
+    display: inline-block;
     left: 50%;
     width: 24px;
     height: 24px;
-}
-
-.show-snippet-comments-button {
-    -ms-transform: translate(calc(-50% + 5em), -50%);
-    transform: translate(calc(-50% + 5em), -50%);
-    background-image: url("data:image/svg+xml,%3Csvg width='24' height='24' viewBox='0 0 24 24' fill='none' xmlns='http://www.w3.org/2000/svg'%3E %3Ccircle cx='12' cy='12' r='12' fill='white'/%3E %3Cpath fill-rule='evenodd' clip-rule='evenodd' d='M19 11.0053L19 13.1085H12.9873L12.988 19H10.8714L10.8721 13.1085L5 13.1085L5 11.0053L10.8721 11.0053V5L12.9865 5.00074L12.988 11.0045L19 11.0053Z' fill='%2327282C' fill-opacity='0.75'/%3E %3C/svg%3E");
-}
-
-.show-snippet-comments-button:hover {
-    background-image: url("data:image/svg+xml,%3Csvg width='24' height='24' viewBox='0 0 24 24' fill='none' xmlns='http://www.w3.org/2000/svg'%3E %3Ccircle cx='12' cy='12' r='12' fill='light grey'/%3E %3Cpath fill-rule='evenodd' clip-rule='evenodd' d='M19 11.0053L19 13.1085H12.9873L12.988 19H10.8714L10.8721 13.1085L5 13.1085L5 11.0053L10.8721 11.0053V5L12.9865 5.00074L12.988 11.0045L19 11.0053Z' fill='%2327282C' fill-opacity='0.75'/%3E %3C/svg%3E");
+    background:
+        linear-gradient(#fff, #fff),
+        linear-gradient(#fff, #fff),
+        #aaa;
+    background-position: center;
+    background-size: 50% 2px, 2px 50%;
+    background-repeat: no-repeat;
+    border-radius: 12px;
+    box-shadow: 0 0 2px black;
+}
+
+.snippet-comment-button:hover {
+    background:
+        linear-gradient(#444, #444),
+        linear-gradient(#444, #444),
+        #ddd;
+    background-position: center;
+    background-size: 50% 2px, 2px 50%;
+    background-repeat: no-repeat;
 }
 
 .hide-snippet-comments-button {
-    -ms-transform: translate(calc(-50% + 5em), -50%) rotate(45deg);
-    transform: translate(calc(-50% + 5em), -50%) rotate(45deg);
-    background-image: url("data:image/svg+xml,%3Csvg width='24' height='24' viewBox='0 0 24 24' fill='none' xmlns='http://www.w3.org/2000/svg'%3E %3Ccircle cx='12' cy='12' r='12' fill='white'/%3E %3Cpath fill-rule='evenodd' clip-rule='evenodd' d='M19 11.0053L19 13.1085H12.9873L12.988 19H10.8714L10.8721 13.1085L5 13.1085L5 11.0053L10.8721 11.0053V5L12.9865 5.00074L12.988 11.0045L19 11.0053Z' fill='%2327282C' fill-opacity='0.75'/%3E %3C/svg%3E");
+    -ms-transform: rotate(45deg);
+    transform: rotate(45deg);
 }
 
-.hide-snippet-comments-button:hover {
-    background-image: url("data:image/svg+xml,%3Csvg width='24' height='24' viewBox='0 0 24 24' fill='none' xmlns='http://www.w3.org/2000/svg'%3E %3Ccircle cx='12' cy='12' r='12' fill='light grey'/%3E %3Cpath fill-rule='evenodd' clip-rule='evenodd' d='M19 11.0053L19 13.1085H12.9873L12.988 19H10.8714L10.8721 13.1085L5 13.1085L5 11.0053L10.8721 11.0053V5L12.9865 5.00074L12.988 11.0045L19 11.0053Z' fill='%2327282C' fill-opacity='0.75'/%3E %3C/svg%3E");
-}

scaladoc-js/src/searchbar/code-snippets/CodeSnippets.scala

@@ -4,19 +4,6 @@ import org.scalajs.dom._
 import org.scalajs.dom.ext._
 
 class CodeSnippets:
-  val replacePatternsAndResults: Seq[(String, String)] = Seq(
-    """(\/\/{{\n)((.|\n)*?)(\/\/}}\n)""" -> """<span class="hideable">$2</span>""", // wrap content of block directives
-    """(\/\/.*?)(\n|\$)""" -> """<span class="hideable">$1</span>$2""", // wrap single line comment
-    """(\/\*)((.|\n)*?)(\*\/)""" -> """<span class="hideable">$0</span>""", // wrap multi line comment
-  )
-
-  document.querySelectorAll("code").foreach {
-    case e: html.Element => e.innerHTML = replacePatternsAndResults.foldLeft(e.innerHTML) {
-      case (acc, (pattern, result)) =>
-        acc.replaceAll(pattern, result)
-    }
-  }
-
   def toggleHide(e: html.Element | html.Document) = e.querySelectorAll("code span.hideable").foreach {
     case e: html.Element if e.style.getPropertyValue("display").isEmpty => e.style.setProperty("display", "none")
     case e: html.Element => e.style.removeProperty("display")
@@ -29,15 +16,12 @@ class CodeSnippets:
       val a = document.createElement("a")
       a.addEventListener("click", { (_: MouseEvent) =>
         if(a.classList.contains("hide-snippet-comments-button")) {
-          a.classList.add("show-snippet-comments-button")
           a.classList.remove("hide-snippet-comments-button")
         } else {
           a.classList.add("hide-snippet-comments-button")
-          a.classList.remove("show-snippet-comments-button")
         }
         toggleHide(e)
       })
       a.classList.add("snippet-comment-button")
-      a.classList.add("show-snippet-comments-button")
       e.insertBefore(a, e.firstChild)
   }

scaladoc-testcases/src/tests/snippetCompilerTest.scala

@@ -2,9 +2,29 @@ package snippetCompiler
 
 /**
   * ```scala sc:compile
+  * //{
+  * import scala.collection.Seq
+  * //}
+  *
   * def a = 2
   * val x = 1 + List()
   * a
+  *
+  * try {
+  *   2+3
+  * }
+  *
+  * /*
+  *   Huge comment
+  * */
+  * val xd: String = 42
+  *
+  * def a(i: Int): Boolean = i match // This is a function
+  *   case 1 => true
+  *
+  * val b: Int = 2.3 /* Also quite a big comment */
+  *
+  * val d: Long = "asd"
   * ```
   *
   * ```scala sc:failing
@@ -23,3 +43,11 @@ package snippetCompiler
   * ```
   */
 class A { }
+
+/**
+ *
+ * ```scala sc:compile
+ * val c: Int = 4.5
+ * ```
+ */
+class B { }

scaladoc/resources/dotty_res/styles/scalastyle.css

@@ -93,22 +93,57 @@ code {
   padding: 0 .3em;
 }
 pre {
-  overflow-x: auto;
   scrollbar-width: thin;
+  margin: 0px;
 }
 pre code, pre code.hljs {
   font-size: 1em;
   padding: 0;
 }
-pre, .symbol.monospace {
+.snippet {
   padding: 12px 8px 10px 12px;
+  background: var(--code-bg);
+  margin: 1em 0px;
+  border-radius: 2px;
+  box-shadow: 0 0 2px #888;
+}
+.snippet-error {
+  border-bottom: 2px dotted red;
+}
+.snippet-warn {
+  border-bottom: 2px dotted orange;
+}
+.snippet-info {
+  border-bottom: 2px dotted teal;
+}
+.snippet-debug {
+  border-bottom: 2px dotted pink;
+}
+.tooltip {
+  position: relative;
+}
+.tooltip:hover:after {
+  content: attr(label);
+  padding: 4px 8px;
+  color: white;
+  background-color:black;
+  position: absolute;
+  left: 0;
+  z-index:10;
+  box-shadow:0 0 3px #444;
+  opacity: 0.8;
+}
+pre, .symbol.monospace {
   font-weight: 500;
   font-size: 12px;
 }
 pre .hljs-comment {
   /* Fold comments in snippets */
   white-space: normal;
 }
+.symbol.monospace {
+  padding: 12px 8px 10px 12px;
+}
 a, a:visited, span[data-unresolved-link] {
   text-decoration: none;
   color: var(--link-fg);

scaladoc/src/dotty/tools/scaladoc/snippets/SnippetCompilationResult.scala

@@ -3,25 +3,21 @@ package snippets
 
 import dotty.tools.io.{ AbstractFile }
 
-case class Position(line: Int, column: Int, sourceLine: String)
+case class Position(line: Int, column: Int, sourceLine: String, relativeLine: Int)
 
-case class SnippetCompilerMessage(position: Option[Position], message: String, level: MessageLevel)
+case class SnippetCompilerMessage(position: Option[Position], message: String, level: MessageLevel):
+  def getSummary: String =
+    position.fold(s"${level.text}: ${message}") { pos =>
+      s"At ${pos.line}:${pos.column}:\n${pos.sourceLine}${level.text}: ${message}"
+    }
 
 case class SnippetCompilationResult(
   wrappedSnippet: String,
   isSuccessful: Boolean,
   result: Option[AbstractFile],
   messages: Seq[SnippetCompilerMessage]
 ):
-  def getSummary: String =
-    messages.map(m =>
-      m.position.fold(
-        s"${m.level.text}: ${m.message}"
-      )(pos =>
-        s"At ${pos.line}:${pos.column}:\n${pos.sourceLine}${m.level.text}: ${m.message}"
-      )
-    ).mkString("\n")
-
+  def getSummary: String = messages.map(_.getSummary).mkString("\n")
 
 enum MessageLevel(val text: String):
   case Info extends MessageLevel("Info")

scaladoc/src/dotty/tools/scaladoc/snippets/SnippetCompiler.scala

@@ -48,7 +48,7 @@ class SnippetCompiler(
       case diagnostic if diagnostic.position.isPresent =>
         val diagPos = diagnostic.position.get
         val pos = Some(
-          Position(diagPos.line + line, diagPos.column + column, diagPos.lineContent)
+          Position(diagPos.line + line, diagPos.column + column, diagPos.lineContent, diagPos.line)
         )
         val msg = nullableMessage(diagnostic.message)
         val level = MessageLevel.fromOrdinal(diagnostic.level)

scaladoc/src/dotty/tools/scaladoc/tasty/comments/Comments.scala

@@ -10,6 +10,7 @@ import com.vladsch.flexmark.formatter.Formatter
 import com.vladsch.flexmark.util.options.MutableDataSet
 
 import scala.quoted._
+import dotty.tools.scaladoc.tasty.comments.markdown.ExtendedFencedCodeBlock
 import dotty.tools.scaladoc.tasty.comments.wiki.Paragraph
 import dotty.tools.scaladoc.DocPart
 import dotty.tools.scaladoc.tasty.SymOpsWithLinkCache
@@ -183,15 +184,13 @@ abstract class MarkupConversion[T](val repr: Repr, snippetChecker: SnippetChecke
       (str: String, lineOffset: SnippetChecker.LineOffset, argOverride: Option[SCFlags]) => {
           val arg = argOverride.fold(pathBasedArg)(pathBasedArg.overrideFlag(_))
 
-          val res = snippetChecker.checkSnippet(str, Some(data), arg, lineOffset)
-          snippetChecker.checkSnippet(str, Some(data), arg, lineOffset).foreach { _ match {
+          snippetChecker.checkSnippet(str, Some(data), arg, lineOffset).collect {
               case r: SnippetCompilationResult if !r.isSuccessful =>
                 val msg = s"In member ${s.name} (${s.dri.location}):\n${r.getSummary}"
                 report.error(msg)(using dctx.compilerContext)
-              case _ =>
-            }
+                r
+              case r => r
           }
-          res
       }
     }
 
@@ -253,29 +252,44 @@ class MarkdownCommentParser(repr: Repr, snippetChecker: SnippetChecker)(using dc
     val nodes = root.getDescendants().asScala.collect {
       case fcb: mda.FencedCodeBlock => fcb
     }.toList
-    if !nodes.isEmpty then {
-      val checkingFunc: SnippetChecker.SnippetCheckingFunc = snippetCheckingFunc(owner)
-      nodes.foreach { node =>
-        val snippet = node.getContentChars.toString
-        val lineOffset = node.getStartLineNumber
-        val info = node.getInfo.toString
-        val argOverride =
-          info.split(" ")
-            .find(_.startsWith("sc:"))
-            .map(_.stripPrefix("sc:"))
-            .map(snippets.SCFlagsParser.parse)
-            .flatMap(_.toOption)
-        checkingFunc(snippet, lineOffset, argOverride) match {
-          case Some(SnippetCompilationResult(wrapped, _, _, _)) if dctx.snippetCompilerArgs.debug =>
-            val s = sequence.BasedSequence.EmptyBasedSequence()
-              .append(wrapped)
-              .append(sequence.BasedSequence.EOL)
-            val content = mdu.BlockContent()
-            content.add(s, 0)
-            node.setContent(content)
-          case _ =>
-        }
+    val checkingFunc: SnippetChecker.SnippetCheckingFunc = snippetCheckingFunc(owner)
+    nodes.foreach { node =>
+      val snippet = node.getContentChars.toString
+      val lineOffset = node.getStartLineNumber
+      val info = node.getInfo.toString
+      val argOverride =
+        info.split(" ")
+          .find(_.startsWith("sc:"))
+          .map(_.stripPrefix("sc:"))
+          .map(snippets.SCFlagsParser.parse)
+          .flatMap(_.toOption)
+      val snippetCompilationResult = checkingFunc(snippet, lineOffset, argOverride) match {
+        case result@Some(SnippetCompilationResult(wrapped, _, _, _)) if dctx.snippetCompilerArgs.debug =>
+          val s = sequence.BasedSequence.EmptyBasedSequence()
+            .append(wrapped)
+            .append(sequence.BasedSequence.EOL)
+          val content = mdu.BlockContent()
+          content.add(s, 0)
+          node.setContent(content)
+          result
+        case result =>
+          // result.modify(_.each.messages.each.position.each.relativeLine).using(_ - 2)
+          result.map { r =>
+            r.copy(
+              messages = r.messages.map { m =>
+                m.copy(
+                  position = m.position.map { p =>
+                    p.copy(
+                      relativeLine = p.relativeLine - 2
+                    )
+                  }
+                )
+              }
+            )
+          }
       }
+      node.insertBefore(new ExtendedFencedCodeBlock(node, snippetCompilationResult))
+      node.unlink()
     }
     root
   }

scaladoc/src/dotty/tools/scaladoc/tasty/comments/markdown/DocFlexmarkExtension.scala

@@ -10,13 +10,21 @@ import com.vladsch.flexmark.ext.wikilink.internal.WikiLinkLinkRefProcessor
 import com.vladsch.flexmark.util.ast._
 import com.vladsch.flexmark.util.options._
 import com.vladsch.flexmark.util.sequence.BasedSequence
+import com.vladsch.flexmark._
 
+import dotty.tools.scaladoc.snippets._
+import scala.collection.JavaConverters._
 
 class DocLinkNode(
   val target: DocLink,
   val body: String,
   seq: BasedSequence
-  ) extends WikiNode(seq, false, false, false, false)
+) extends WikiNode(seq, false, false, false, false)
+
+case class ExtendedFencedCodeBlock(
+  codeBlock: ast.FencedCodeBlock,
+  compilationResult: Option[SnippetCompilationResult]
+) extends WikiNode(codeBlock.getChars, false, false, false, false)
 
 class DocFlexmarkParser(resolveLink: String => DocLink) extends Parser.ParserExtension:
 
@@ -49,13 +57,25 @@ case class DocFlexmarkRenderer(renderLink: (DocLink, String) => String)
   extends HtmlRenderer.HtmlRendererExtension:
     def rendererOptions(opt: MutableDataHolder): Unit = () // noop
 
+    object ExtendedFencedCodeBlockHandler extends CustomNodeRenderer[ExtendedFencedCodeBlock]:
+      override def render(node: ExtendedFencedCodeBlock, c: NodeRendererContext, html: HtmlWriter): Unit =
+        html.raw(
+          SnippetRenderer.renderSnippetWithMessages(
+            node.codeBlock.getContentChars.toString.split("\n").map(_ + "\n").toSeq,
+            node.compilationResult.toSeq.flatMap(_.messages)
+          )
+        )
+
     object Handler extends CustomNodeRenderer[DocLinkNode]:
       override def render(node: DocLinkNode, c: NodeRendererContext, html: HtmlWriter): Unit =
         html.raw(renderLink(node.target, node.body))
 
     object Render extends NodeRenderer:
       override def getNodeRenderingHandlers: JSet[NodeRenderingHandler[_]] =
-        JSet(new NodeRenderingHandler(classOf[DocLinkNode], Handler))
+        JSet(
+          new NodeRenderingHandler(classOf[DocLinkNode], Handler),
+          new NodeRenderingHandler(classOf[ExtendedFencedCodeBlock], ExtendedFencedCodeBlockHandler),
+        )
 
     object Factory extends NodeRendererFactory:
       override def create(options: DataHolder): NodeRenderer = Render