Add debug flag.

Author: pikinier20

scaladoc-testcases/src/tests/snippetCompilerTest.scala

@@ -7,6 +7,12 @@ package snippetCompiler
   * a
   * ```
   *
+  * ```scala sc:compile&debug
+  * def a = 2
+  * val x = 1 + List()
+  * a
+  * ```
+  *
   * ```scala sc:compile&failing
   * def a = 2
   * ```

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

@@ -26,4 +26,5 @@ enum MessageLevel(val text: String):
   case Info extends MessageLevel("Info")
   case Warning extends MessageLevel("Warning")
   case Error extends MessageLevel("Error")
+  case Debug extends MessageLevel("Debug")
 

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

@@ -60,9 +60,14 @@ class SnippetCompiler(
     errorMessages
   }
 
-  private def additionalMessages(arg: SnippetCompilerArg, context: Context): Seq[SnippetCompilerMessage] = {
-    Option.when(arg.is(SCFlags.Fail) && !context.reporter.hasErrors)(
-      SnippetCompilerMessage(None, "Snippet should not compile but compiled succesfully", MessageLevel.Error)
+  private def additionalMessages(wrappedSnippet: WrappedSnippet, arg: SnippetCompilerArg, context: Context): Seq[SnippetCompilerMessage] = {
+    (
+      Option.when(arg.is(SCFlags.Fail) && !context.reporter.hasErrors)(
+        SnippetCompilerMessage(None, "Snippet should not compile but compiled succesfully", MessageLevel.Error)
+      ) ++
+      Option.when(arg.is(SCFlags.Debug))(
+        SnippetCompilerMessage(None, s"\n${wrappedSnippet.snippet}", MessageLevel.Debug)
+      )
     ).toList
   }
 
@@ -86,7 +91,7 @@ class SnippetCompiler(
 
     val messages =
       createReportMessage(context.reporter.pendingMessages(using context), wrappedSnippet.lineOffset, wrappedSnippet.columnOffset) ++
-      additionalMessages(arg, context)
+      additionalMessages(wrappedSnippet, arg, context)
 
     val t = Option.when(!context.reporter.hasErrors)(target)
     SnippetCompilationResult(isSuccessful(arg, context), t, messages)

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

@@ -9,10 +9,15 @@ object SnippetCompilerArg:
     Set(SCFlags.NoCompile)
   )
 
-enum SCFlags(val flagName: String, val forbiddenFlags: Set[SCFlags]):
-  case Compile extends SCFlags("compile", Set())
-  case NoCompile extends SCFlags("nocompile", Set())
-  case Fail extends SCFlags("failing", Set())
+sealed trait SCFlags(val flagName: String, val forbiddenFlags: Set[SCFlags])
+
+object SCFlags:
+  case object Compile extends SCFlags("compile", Set(NoCompile))
+  case object NoCompile extends SCFlags("nocompile", Set(Compile))
+  case object Fail extends SCFlags("failing", Set())
+  case object Debug extends SCFlags("debug", Set())
+
+  def values: Seq[SCFlags] = Seq(Compile, NoCompile, Fail, Debug)
 
 case class SnippetCompilerArgs(scArgs: PathBased[SnippetCompilerArg]):
   def get(member: Member): Option[SnippetCompilerArg] = member.sources.flatMap(s => scArgs.get(s.path).map(_.elem))
@@ -58,15 +63,19 @@ object SnippetCompilerArgParser extends ArgParser[SnippetCompilerArg]:
       )
     ).partition(_.isRight)
 
+
     val (flags, errors2) = parsed.collect {
       case Right(flag) => flag
     } match {
-      case list => list.map(f =>
-        list.find(elem => f.forbiddenFlags.contains(elem)) match {
-          case Some(forbiddenElem) => Left(s"${f.flagName}: Cannot be used with flag: ${forbiddenElem.flagName}")
-          case None => Right(f)
-        }
-      ).partition(_.isRight)
+      case list =>
+        list.map(f =>
+          list.find(elem =>
+            f.forbiddenFlags.contains(elem)
+          ) match {
+              case Some(forbiddenElem) => Left(s"${f.flagName}: Cannot be used with flag: ${forbiddenElem.flagName}")
+              case None => Right(f)
+            }
+        ).partition(_.isRight)
     }
 
     val checkedFlags = flags.collect {