feat: use the new ScalaAction from BSP4J

This is a simplified version of
VirtusLab#1969 that gets rid of the
`ActionableDiagnostic` that is used internally and instead just ensures
that any time a `TextEdit` is created there is a `title`. Then we take
all the information already contained in the `Diagnostic` and make a
`ScalaAction` from it to be forwarded via the diagnostic data.

Author: ckipp01

.gitignore

@@ -7,3 +7,4 @@ out/
 .bsp
 .scala-build
 dest/
+target/

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

@@ -1,6 +1,8 @@
 package scala.build.bsp
 
+import ch.epfl.scala.bsp4j.{ScalaAction, ScalaDiagnostic, ScalaTextEdit, ScalaWorkspaceEdit}
 import ch.epfl.scala.bsp4j as b
+import com.google.gson.Gson
 
 import java.lang.Boolean as JBoolean
 import java.net.URI
@@ -229,9 +231,16 @@ class BspClient(
           new b.Diagnostic(range, diag.message)
 
         diag.textEdit.foreach { textEdit =>
-          val bTextEdit = TextEdit(range, textEdit.newText)
-          bDiag.setData(bTextEdit.toJsonTree())
+          val bScalaTextEdit      = new ScalaTextEdit(range, textEdit.newText)
+          val bScalaWorkspaceEdit = new ScalaWorkspaceEdit(List(bScalaTextEdit).asJava)
+          val bAction             = new ScalaAction(textEdit.title)
+          bAction.setEdit(bScalaWorkspaceEdit)
+          val bScalaDiagnostic = new ScalaDiagnostic
+          bScalaDiagnostic.setActions(List(bAction).asJava)
+          bDiag.setData("scala")
+          bDiag.setData(new Gson().toJsonTree(bScalaDiagnostic))
         }
+
         bDiag.setSeverity(diag.severity.toBsp4j)
         bDiag.setSource("scala-cli")
         val params = new b.PublishDiagnosticsParams(

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

@@ -1,10 +1,17 @@
 package scala.build
 
-import ch.epfl.scala.bsp4j.SourcesItem
+import ch.epfl.scala.bsp4j.{
+  ScalaAction,
+  ScalaDiagnostic,
+  ScalaTextEdit,
+  ScalaWorkspaceEdit,
+  SourcesItem
+}
 import ch.epfl.scala.bsp4j as b
 
 import java.util.concurrent.CompletableFuture
 
+import scala.build.errors.Diagnostic
 import scala.jdk.CollectionConverters.*
 
 package object bsp {

modules/build/src/test/scala/scala/build/tests/ActionableDiagnosticTests.scala

@@ -10,7 +10,7 @@ import scala.build.actionable.ActionableDiagnostic.*
 import scala.build.Position.File
 import coursier.core.Version
 
-import scala.build.errors.{BuildException, CompositeBuildException, UnsupportedAmmoniteImportError}
+import scala.build.errors.{BuildException, CompositeBuildException}
 
 class ActionableDiagnosticTests extends munit.FunSuite {
 

modules/core/src/main/scala/scala/build/errors/Diagnostic.scala

@@ -11,7 +11,7 @@ trait Diagnostic {
 }
 
 object Diagnostic {
-  case class TextEdit(newText: String)
+  case class TextEdit(title: String, newText: String)
   object Messages {
     val bloopTooOld =
       "JVM that is hosting bloop is older than the requested runtime. Please run command `bloop exit`, and then use `--jvm` flag to restart Bloop"

modules/core/src/main/scala/scala/build/errors/UnsupportedAmmoniteImportError.scala

@@ -1345,16 +1345,22 @@ abstract class BspTestDefinitions(val scalaVersionOpt: Option[String])
             strictlyCheckMessage = false
           )
 
-          val textEdit = new Gson().fromJson[TextEdit](
+          val scalaDiagnostic = new Gson().fromJson[b.ScalaDiagnostic](
             updateActionableDiagnostic.getData().asInstanceOf[JsonElement],
-            classOf[TextEdit]
+            classOf[b.ScalaDiagnostic]
           )
 
-          expect(textEdit.newText.contains("com.lihaoyi::os-lib:"))
-          expect(textEdit.range.getStart.getLine == 0)
-          expect(textEdit.range.getStart.getCharacter == 15)
-          expect(textEdit.range.getEnd.getLine == 0)
-          expect(textEdit.range.getEnd.getCharacter == 40)
+          val actions = scalaDiagnostic.getActions().asScala
+          assert(actions.size == 1)
+          val changes = actions.head.getEdit().getChanges().asScala
+          assert(changes.size == 1)
+          val textEdit = changes.head
+
+          expect(textEdit.getNewText().contains("com.lihaoyi::os-lib:"))
+          expect(textEdit.getRange().getStart.getLine == 0)
+          expect(textEdit.getRange().getStart.getCharacter == 15)
+          expect(textEdit.getRange().getEnd.getLine == 0)
+          expect(textEdit.getRange().getEnd.getCharacter == 40)
         }
     }
   }

modules/integration/src/test/scala/scala/cli/integration/BspTestDefinitions.scala

@@ -6,17 +6,6 @@ import scala.build.Position
 import scala.build.errors.Diagnostic.TextEdit
 import scala.build.errors.{Diagnostic, Severity}
 
-abstract class ActionableDiagnostic extends Diagnostic {
-
-  /** Provide the new content which will be replaced by actionable diagnostic
-    */
-  def suggestion: String
-
-  override def severity = Severity.Hint
-
-  override def textEdit: Option[TextEdit] = Some(TextEdit(suggestion))
-}
-
 object ActionableDiagnostic {
 
   case class ActionableDependencyUpdateDiagnostic(
@@ -25,9 +14,13 @@ object ActionableDiagnostic {
     newVersion: String,
     dependencyModuleName: String,
     suggestion: String
-  ) extends ActionableDiagnostic {
+  ) extends Diagnostic {
     override def message: String =
       s"""|"$dependencyModuleName is outdated, update to $newVersion"
           |     $dependencyModuleName $currentVersion -> $suggestion""".stripMargin
+
+    override def textEdit: Option[TextEdit] = Some(TextEdit(message, suggestion))
+
+    override def severity: Severity = Severity.Hint
   }
 }

modules/options/src/main/scala/scala/build/actionable/ActionableDiagnostic.scala

@@ -2,10 +2,10 @@ package scala.build.actionable
 
 import scala.build.Logger
 import scala.build.Ops.*
-import scala.build.errors.{BuildException, CompositeBuildException}
+import scala.build.errors.{BuildException, CompositeBuildException, Diagnostic}
 import scala.build.options.BuildOptions
 
-trait ActionableHandler[A <: ActionableDiagnostic] {
+trait ActionableHandler[A <: Diagnostic] {
 
   /** Type of setting used to generate actionable diagnostic
     */

modules/options/src/main/scala/scala/build/actionable/ActionableHandler.scala

@@ -11,7 +11,7 @@ object ActionablePreprocessor {
 
   def generateActionableDiagnostics(
     options: BuildOptions
-  ): Either[BuildException, Seq[ActionableDiagnostic]] =
+  ): Either[BuildException, Seq[Diagnostic]] =
     actionableHandlers
       .map(handler => handler.createActionableDiagnostics(options))
       .sequence