Refactor debug flag

Author: pikinier20

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

@@ -34,4 +34,4 @@ class SnippetChecker()(using ctx: DocContext):
 
 object SnippetChecker:
   type LineOffset = Int
-  type SnippetCheckingFunc = (String, LineOffset, Option[SCFlags]) => Unit
+  type SnippetCheckingFunc = (String, LineOffset, Option[SCFlags]) => Option[SnippetCompilationResult]

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

@@ -8,6 +8,7 @@ case class Position(line: Int, column: Int, sourceLine: String)
 case class SnippetCompilerMessage(position: Option[Position], message: String, level: MessageLevel)
 
 case class SnippetCompilationResult(
+  wrappedSnippet: String,
   isSuccessful: Boolean,
   result: Option[AbstractFile],
   messages: Seq[SnippetCompilerMessage]

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

@@ -61,14 +61,9 @@ class SnippetCompiler(
   }
 
   private def additionalMessages(wrappedSnippet: WrappedSnippet, arg: SnippetCompilerArg, context: Context): Seq[SnippetCompilerMessage] = {
-    (
       Option.when(arg.flag == SCFlags.Fail && !context.reporter.hasErrors)(
         SnippetCompilerMessage(None, "Snippet should not compile but compiled succesfully", MessageLevel.Error)
-      ) ++
-      Option.when(arg.debug && !isSuccessful(arg, context))(
-        SnippetCompilerMessage(None, s"\n${wrappedSnippet.snippet}", MessageLevel.Debug)
-      )
-    ).toList
+      ).toList
   }
 
   private def isSuccessful(arg: SnippetCompilerArg, context: Context): Boolean = {
@@ -94,5 +89,5 @@ class SnippetCompiler(
       additionalMessages(wrappedSnippet, arg, context)
 
     val t = Option.when(!context.reporter.hasErrors)(target)
-    SnippetCompilationResult(isSuccessful(arg, context), t, messages)
+    SnippetCompilationResult(wrappedSnippet.snippet, isSuccessful(arg, context), t, messages)
   }

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

@@ -4,7 +4,7 @@ package tasty.comments
 import scala.collection.immutable.SortedMap
 import scala.util.Try
 
-import com.vladsch.flexmark.util.{ast => mdu}
+import com.vladsch.flexmark.util.{ast => mdu, sequence}
 import com.vladsch.flexmark.{ast => mda}
 import com.vladsch.flexmark.formatter.Formatter
 import com.vladsch.flexmark.util.options.MutableDataSet
@@ -40,8 +40,7 @@ case class Comment (
   groupNames:              SortedMap[String, DocPart],
   groupPrio:               SortedMap[String, Int],
   /** List of conversions to hide - containing e.g: `scala.Predef.FloatArrayOps` */
-  hideImplicitConversions: List[DocPart],
-  snippetCompilerData:     SnippetCompilerData
+  hideImplicitConversions: List[DocPart]
 )
 
 case class PreparsedComment(
@@ -183,13 +182,15 @@ 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 {
               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 _ =>
             }
           }
+          res
       }
     }
 
@@ -216,12 +217,11 @@ abstract class MarkupConversion[T](val repr: Repr, snippetChecker: SnippetChecke
       groupDesc               = filterEmpty(preparsed.groupDesc).view.mapValues(markupToDokka).to(SortedMap),
       groupNames              = filterEmpty(preparsed.groupNames).view.mapValues(markupToDokka).to(SortedMap),
       groupPrio               = preparsed.groupPrio,
-      hideImplicitConversions = filterEmpty(preparsed.hideImplicitConversions).map(markupToDokka),
-      snippetCompilerData     = getSnippetCompilerData(owner)
+      hideImplicitConversions = filterEmpty(preparsed.hideImplicitConversions).map(markupToDokka)
     )
 }
 
-class MarkdownCommentParser(repr: Repr, snippetChecker: SnippetChecker)(using DocContext)
+class MarkdownCommentParser(repr: Repr, snippetChecker: SnippetChecker)(using dctx: DocContext)
     extends MarkupConversion[mdu.Node](repr, snippetChecker) {
 
   def stringToMarkup(str: String) =
@@ -264,7 +264,16 @@ class MarkdownCommentParser(repr: Repr, snippetChecker: SnippetChecker)(using Do
             .map(_.stripPrefix("sc:"))
             .map(snippets.SCFlagsParser.parse)
             .flatMap(_.toOption)
-        checkingFunc(snippet, lineOffset, argOverride)
+        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 _ =>
+        }
       }
     }
     root