Add option to return rendered message when compiling via BSP

backend/src/main/scala/bloop/reporter/Reporter.scala

@@ -102,6 +102,7 @@ abstract class Reporter(
           p.message,
           mappedPos,
           p.category,
+          p.rendered(),
           p.diagnosticCode(),
           p.diagnosticRelatedInformation(),
           p.actions()

frontend/src/main/scala/bloop/bsp/BloopBspServices.scala

@@ -529,6 +529,7 @@ final class BloopBspServices(
 
     val isPipeline = compileArgs.exists(_ == "--pipeline")
     val bestEffortAllowed = compileArgs.exists(_ == "--best-effort")
+    val showRenderedMessage = compileArgs.exists(_ == "--show-rendered-message")
     def compile(projects: List[Project]): Task[State] = {
       val config = ReporterConfig.defaultFormat.copy(reverseOrder = false)
 
@@ -553,7 +554,8 @@ final class BloopBspServices(
           inputs.logger,
           inputs.cwd,
           config,
-          reportAllPreviousProblems
+          reportAllPreviousProblems,
+          showRenderedMessage
         )
       }
 

frontend/src/main/scala/bloop/logging/BspServerLogger.scala

@@ -185,7 +185,11 @@ final class BspServerLogger private (
   }
 
   def diagnostic(event: CompilationEvent.Diagnostic): Unit = {
-    val message = event.problem.message
+    val message0 = event.problem.message
+    val message =
+      if (event.showRenderedMessage)
+        InterfaceUtil.toOption(event.problem.rendered()).getOrElse(message0)
+      else message0
     val problemPos = event.problem.position
     val problemSeverity = event.problem.severity
     val sourceFile = InterfaceUtil.toOption(problemPos.sourceFile())

frontend/src/main/scala/bloop/reporter/BspProjectReporter.scala

@@ -22,6 +22,7 @@ final class BspProjectReporter(
     cwd: AbsolutePath,
     config: ReporterConfig,
     reportAllPreviousProblems: Boolean,
+    showRenderedMessage: Boolean,
     override val _problems: Reporter.Buffer[ProblemPerPhase]
 ) extends Reporter(logger, cwd, config, _problems) {
 
@@ -30,14 +31,16 @@ final class BspProjectReporter(
       logger: BspServerLogger,
       cwd: AbsolutePath,
       config: ReporterConfig,
-      reportAllPreviousProblems: Boolean
+      reportAllPreviousProblems: Boolean,
+      showRenderedMessage: Boolean
   ) =
     this(
       project,
       logger,
       cwd,
       config,
       reportAllPreviousProblems,
+      showRenderedMessage,
       createBuffer[ProblemPerPhase](project)
     )
 
@@ -59,8 +62,13 @@ final class BspProjectReporter(
       case Some(file) =>
         // If it's the first diagnostic for this file, set clear to true
         val clear = clearedFilesForClient.putIfAbsent(file, true).isEmpty
-        logger.diagnostic(CompilationEvent.Diagnostic(project.bspUri, problem, clear))
-      case None => logger.diagnostic(CompilationEvent.Diagnostic(project.bspUri, problem, false))
+        logger.diagnostic(
+          CompilationEvent.Diagnostic(project.bspUri, problem, clear, showRenderedMessage)
+        )
+      case None =>
+        logger.diagnostic(
+          CompilationEvent.Diagnostic(project.bspUri, problem, false, showRenderedMessage)
+        )
     }
   }
 
@@ -248,7 +256,12 @@ final class BspProjectReporter(
                     case ProblemPerPhase(problem, _) =>
                       val clear = clearedFilesForClient.putIfAbsent(sourceFile, true).isEmpty
                       logger.diagnostic(
-                        CompilationEvent.Diagnostic(project.bspUri, problem, clear)
+                        CompilationEvent.Diagnostic(
+                          project.bspUri,
+                          problem,
+                          clear,
+                          showRenderedMessage
+                        )
                       )
                   }
                 }
@@ -265,7 +278,9 @@ final class BspProjectReporter(
     problems.foreach {
       case ProblemPerPhase(problem, _) =>
         val clear = clearedFilesForClient.putIfAbsent(sourceFile, true).isEmpty
-        logger.diagnostic(CompilationEvent.Diagnostic(project.bspUri, problem, clear))
+        logger.diagnostic(
+          CompilationEvent.Diagnostic(project.bspUri, problem, clear, showRenderedMessage)
+        )
     }
   }
 
@@ -335,7 +350,12 @@ final class BspProjectReporter(
                   case ProblemPerPhase(problem, _) =>
                     val clear = clearedFilesForClient.putIfAbsent(sourceFile, true).isEmpty
                     logger.diagnostic(
-                      CompilationEvent.Diagnostic(project.bspUri, problem, clear)
+                      CompilationEvent.Diagnostic(
+                        project.bspUri,
+                        problem,
+                        clear,
+                        showRenderedMessage
+                      )
                     )
                 }
               }

frontend/src/test/scala/bloop/bsp/BspClientTest.scala

@@ -341,8 +341,7 @@ trait BspClientTest {
                 val canonical = pathString.replace(File.separatorChar, '/')
                 val report = diagnostics.map(
                   _.copy(source = Some("_"), code = Some("_")).toString
-                    .replace("\n", " ")
-                    .replace(END_OF_LINE_MATCHER, " ")
+                    .replaceAll(END_OF_LINE_MATCHER, " ")
                 )
                 builder
                   .++=(s"#${compileIteration()}: $canonical\n")

frontend/src/test/scala/bloop/bsp/BspCompileSpec.scala

@@ -1,5 +1,6 @@
 package bloop.bsp
 
+import java.io.File
 import java.nio.file.Files
 import java.nio.file.attribute.FileTime
 import java.time.Instant
@@ -1423,6 +1424,41 @@ class BspCompileSpec(
     }
   }
 
+  test("compile and return rendered message") {
+    TestUtil.withinWorkspace { workspace =>
+      val sources = List(
+        """/main/scala/Foo.scala
+          |def foo(s: String): Int = s
+          """.stripMargin
+      )
+
+      val logger = new RecordingLogger(ansiCodesSupported = false)
+      val `A` = TestProject(workspace, "a", sources, scalaVersion = Some("3.3.7"))
+      val projects = List(`A`)
+
+      loadBspState(workspace, projects, logger) { state =>
+        val compiledState = state.compile(`A`, arguments = Some(List("--show-rendered-message")))
+        assertExitStatus(compiledState, ExitStatus.CompilationError)
+        val sep = File.separator
+        assertNoDiff(
+          // Remove ANSI escape codes
+          compiledState.lastDiagnostics(`A`).replaceAll("\u001B\\[[;\\d]*m", ""),
+          s"""
+             |#1: task start 1
+             |  -> Msg: Compiling a (1 Scala source)
+             |  -> Data kind: compile-task
+             |#1: a/src/main/scala/Foo.scala
+             |  -> List(Diagnostic(Range(Position(0,26),Position(0,27)),Some(Error),Some(_),Some(_),-- [E007] Type Mismatch Error: $workspace${sep}a${sep}src${sep}main${sep}scala${sep}Foo.scala:1:26  1 |def foo(s: String): Int = s   |                          ^   |                          Found:    (s : String)   |                          Required: Int   |   | longer explanation available when compiling with `-explain`,None,None,Some({"actions":[]})))
+             |  -> reset = true
+             |#1: task finish 1
+             |  -> errors 1, warnings 0, noop false
+             |  -> Msg: Compiled 'a'
+             |  -> Data kind: compile-report """.stripMargin
+        )
+      }
+    }
+  }
+
   test("task notifications are sent when compiling project with dependency") {
     TestUtil.withinWorkspace { workspace =>
       val sourcesA = List(

shared/src/main/scala/bloop/io/Environment.scala

@@ -51,7 +51,7 @@ object Environment {
    *  - "\r\n"
    *  - "\r"
    */
-  def END_OF_LINE_MATCHER = "\r\n|\n"
+  def END_OF_LINE_MATCHER = "\r\n|\n|\r"
 
   /*
    * A list of valid shell paths.  The SHELL environment variable must

shared/src/main/scala/bloop/logging/CompilationEvent.scala

@@ -97,7 +97,8 @@ object CompilationEvent {
   case class Diagnostic(
       projectUri: bsp.Uri,
       problem: xsbti.Problem,
-      clear: Boolean
+      clear: Boolean,
+      showRenderedMessage: Boolean
   ) extends CompilationEvent
 
   /**

shared/src/main/scala/bloop/reporter/Problem.scala

@@ -16,6 +16,8 @@ final case class Problem private (
     position: xsbti.Position,
     /** The category of this problem. */
     category: String,
+    /** If present, the string shown to the user when displaying this Problem */
+    override val rendered: Optional[String],
     /** Unique code attatched to the diagnostic being reported */
     override val diagnosticCode: Optional[xsbti.DiagnosticCode],
     override val diagnosticRelatedInforamation: java.util.List[xsbti.DiagnosticRelatedInformation],
@@ -30,6 +32,7 @@ object Problem {
       problem.message(),
       problem.position(),
       problem.category(),
+      problem.rendered(),
       problem.diagnosticCode(),
       problem.diagnosticRelatedInformation(),
       problem.actions()