refactor: change data in bsp.Diagnostic to contain a workspaceEdit

This change is part of the discussion that we had at the Scala Tooling
Summit where we decided that using a `WorkspaceEdit` rather than a
`TextEdit` provided a more future-proof way of actionable diagnostics
since it's richer. This PR makes that changes, but in a limited way.

- It only actually changes this when we go from the `Diagnostic` to a
  BSP Diagnostic. It doesn't for example change the `TextEdit` that the
  internal representation of Diagnostic has. That's left as is to
  minimize changes internally.
- Right now really only `changes` are supported in the `WorkspaceEdit`
  mainly because that's all we really need at this time. In the future
  this could be expanded to use the richer `documentChanges` if the BSP
  client supports it.
- This also changes the structure of `data` slightly to not have the
  actual edit be at the top level and instead nests it under an `edit`
  key. There is no gaurauntee that we won't have other keys in `data` in
  the future, so this sort of allows for that and ensures that we don't
  get stuck with only being able to have the actual `WorkspaceEdit` at
  the top level in the `data` object.

Fixes #1957

Author: ckipp01

modules/build/src/main/scala/scala/build/bsp/BspClient.scala

@@ -8,7 +8,7 @@ import java.nio.file.Paths
 import java.util.concurrent.{ConcurrentHashMap, ExecutorService}
 
 import scala.build.Position.File
-import scala.build.bsp.protocol.TextEdit
+import scala.build.bsp.protocol.*
 import scala.build.errors.{BuildException, CompositeBuildException, Diagnostic, Severity}
 import scala.build.postprocessing.LineConversion
 import scala.build.{BloopBuildClient, GeneratedSource, Logger}
@@ -223,7 +223,10 @@ class BspClient(
 
         diag.textEdit.foreach { textEdit =>
           val bTextEdit = TextEdit(range, textEdit.newText)
-          bDiag.setData(bTextEdit.toJsonTree())
+          val workspaceEdit =
+            WorkspaceEdit(changes = Map(path.toNIO.toUri().toString() -> Array(bTextEdit)))
+          val data = DiagnosticData(edits = Array(workspaceEdit))
+          bDiag.setData(data.toJsonTree())
         }
         bDiag.setSeverity(diag.severity.toBsp4j)
         bDiag.setSource("scala-cli")

modules/build/src/main/scala/scala/build/bsp/protocol/DiagnosticData.scala

@@ -0,0 +1,50 @@
+package scala.build.bsp.protocol
+
+import ch.epfl.scala.bsp4j as b
+import com.google.gson.{Gson, JsonElement}
+
+/** Representation for the data field in a bsp.Diagnostic.
+  *
+  * For now this only contains an edit, but there is nothing from keeping it having more field in
+  * the future.
+  * @param edit
+  *   The Workspace edit attatched to the Diagnostic.
+  */
+case class DiagnosticData(edits: Array[WorkspaceEdit]) {
+
+  /** Go from the DiagnosticData to Json. This will result in each param being a field in the
+    * object.
+    *
+    * @return
+    *   the JsonElement
+    */
+  def toJsonTree(): JsonElement = new Gson().toJsonTree(this)
+}
+
+/** A WorkspaceEdit meant to mimic the LSP WorkspaceEdit.
+  *
+  * https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#workspaceEdit
+  *
+  * For now this only utilizes changes, hence the default empty for both documentChanges and
+  * changeAnnotations. In the future when we support more operations like, CreateFile, RenameFile,
+  * etc we can expand on this and change the type of documentChanges to actually be an
+  * Array[TextDocumentEdit] | Array[TextDocumentEditTypes].
+  *
+  * @param changes
+  *   A Map of the URI that contains the diagnostic to the TextEdits that it contains.
+  * @param documentChanges
+  *   NOT CURRENTLY USED
+  * @param changeAnnotations
+  *   NOT CURRENTLY USED
+  */
+case class WorkspaceEdit(
+  changes: Map[String, Array[TextEdit]],
+  documentChanges: Array[Object] = Array.empty,
+  changeAnnotations: Map[String, Object] = Map.empty
+)
+
+/** A TextEdit meant to mimic the LSP TextEdit.
+  *
+  * https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textEdit
+  */
+case class TextEdit(range: b.Range, newText: String)

modules/build/src/main/scala/scala/build/bsp/protocol/TextEdit.scala

@@ -9,7 +9,7 @@ import org.scalajs.logging.{Level => ScalaJsLevel, Logger => ScalaJsLogger, Scal
 
 import java.io.PrintStream
 
-import scala.build.bsp.protocol.TextEdit
+import scala.build.bsp.protocol.*
 import scala.build.errors.{BuildException, CompositeBuildException, Diagnostic, Severity}
 import scala.build.internal.CustomProgressBarRefreshDisplay
 import scala.build.{ConsoleBloopBuildClient, Logger, Position}
@@ -83,9 +83,15 @@ class CliLogger(
         diag.setSeverity(severity.toBsp4j)
         diag.setSource("scala-cli")
 
-        for (textEdit <- textEditOpt) {
-          val bTextEdit = TextEdit(range, textEdit.newText)
-          diag.setData(bTextEdit.toJsonTree())
+        (textEditOpt, f.path) match {
+          case (Some(textEdit), Right(path)) =>
+            val bTextEdit = TextEdit(range, textEdit.newText)
+            val workspaceEdit = WorkspaceEdit(changes =
+              Map(path.toNIO.toUri().toString() -> Array(bTextEdit))
+            )
+            val data = DiagnosticData(edits = Array(workspaceEdit))
+            diag.setData(data.toJsonTree())
+          case _ => ()
         }
 
         for (file <- f.path) {