nit: Improve formatting of changes files

tgodzik · tgodzik · commit 2f1d6d45a9c4 · 2025-12-15T16:56:47.000+01:00
diff --git a/presentation-compiler/src/main/dotty/tools/pc/DiagnosticProvider.scala b/presentation-compiler/src/main/dotty/tools/pc/DiagnosticProvider.scala
@@ -24,15 +24,16 @@ class DiagnosticProvider(driver: InteractiveDriver, params: VirtualFileParams):
 
   private def toLsp(diag: Diagnostic)(using Context): Option[lsp4j.Diagnostic] =
     Option.when(diag.pos.exists):
-      val message = 
-        if Diagnostic.shouldExplain(diag) then 
-          diag.msg.message + "\n\n# Explanation (enabled by `-explain`)\n\n" + diag.msg.explanation 
-        else diag.msg.message
+      val explanation =
+        if Diagnostic.shouldExplain(diag)
+        then
+          "\n\n# Explanation (enabled by `-explain`)\n\n" + diag.msg.explanation
+        else ""
       val lspDiag = lsp4j.Diagnostic(
         diag.pos.toLsp,
-        message,
+        diag.msg.message + explanation,
         toDiagnosticSeverity(diag.level),
-        "presentation compiler",
+        "presentation compiler"
       )
       lspDiag.setCode(diag.msg.errorId.errorNumber)
 
@@ -48,7 +49,8 @@ class DiagnosticProvider(driver: InteractiveDriver, params: VirtualFileParams):
     val lspAction = lsp4j.CodeAction(action.title)
     lspAction.setKind(lsp4j.CodeActionKind.QuickFix)
     lspAction.setIsPreferred(true)
-    val edits = action.patches.groupBy(_.srcPos.source.path)
+    val edits = action.patches
+      .groupBy(_.srcPos.source.path)
       .map((path, actions) => path -> (actions.map(toLspTextEdit).asJava))
       .asJava
 
@@ -57,8 +59,12 @@ class DiagnosticProvider(driver: InteractiveDriver, params: VirtualFileParams):
     lspAction
 
   private def toLspTextEdit(actionPatch: ActionPatch): lsp4j.TextEdit =
-    val startPos = lsp4j.Position(actionPatch.srcPos.startLine, actionPatch.srcPos.startColumn)
-    val endPos   = lsp4j.Position(actionPatch.srcPos.endLine, actionPatch.srcPos.endColumn)
+    val startPos = lsp4j.Position(
+      actionPatch.srcPos.startLine,
+      actionPatch.srcPos.startColumn
+    )
+    val endPos =
+      lsp4j.Position(actionPatch.srcPos.endLine, actionPatch.srcPos.endColumn)
     val range = lsp4j.Range(startPos, endPos)
     lsp4j.TextEdit(range, actionPatch.replacement)
 
diff --git a/presentation-compiler/test/dotty/tools/pc/base/BaseDiagnosticsSuite.scala b/presentation-compiler/test/dotty/tools/pc/base/BaseDiagnosticsSuite.scala
@@ -14,26 +14,49 @@ import scala.meta.pc.CancelToken
 import scala.meta.pc.VirtualFileParams
 
 class BaseDiagnosticsSuite extends PcAssertions:
-  case class TestDiagnostic(startIndex: Int, endIndex: Int, msg: String, severity: DiagnosticSeverity)
+  case class TestDiagnostic(
+      startIndex: Int,
+      endIndex: Int,
+      msg: String,
+      severity: DiagnosticSeverity
+  )
 
-  def options : List[String] = Nil
-  
-  val pc = RawScalaPresentationCompiler().newInstance("", TestResources.classpath.asJava, options.asJava)
+  def options: List[String] = Nil
 
-  case class TestVirtualFileParams(uri: URI, text: String) extends VirtualFileParams {
+  val pc = RawScalaPresentationCompiler().newInstance(
+    "",
+    TestResources.classpath.asJava,
+    options.asJava
+  )
+
+  case class TestVirtualFileParams(uri: URI, text: String)
+      extends VirtualFileParams {
     override def shouldReturnDiagnostics: Boolean = true
     override def token: CancelToken = EmptyCancelToken
   }
 
   def check(
-    text: String,
-    expected: List[TestDiagnostic],
-    additionalChecks: List[Diagnostic] => Unit = identity
+      text: String,
+      expected: List[TestDiagnostic],
+      additionalChecks: List[Diagnostic] => Unit = identity
   ): Unit =
     val diagnostics = pc
-      .didChange(TestVirtualFileParams(URI.create("file:/Diagnostic.scala"), text))
+      .didChange(
+        TestVirtualFileParams(URI.create("file:/Diagnostic.scala"), text)
+      )
       .asScala
 
-    val actual = diagnostics.map(d => TestDiagnostic(d.getRange().getStart().getOffset(text), d.getRange().getEnd().getOffset(text), d.getMessage(), d.getSeverity()))
-    assertEquals(expected, actual, s"Expected [${expected.mkString(", ")}] but got [${actual.mkString(", ")}]")
+    val actual = diagnostics.map(d =>
+      TestDiagnostic(
+        d.getRange().getStart().getOffset(text),
+        d.getRange().getEnd().getOffset(text),
+        d.getMessage(),
+        d.getSeverity()
+      )
+    )
+    assertEquals(
+      expected,
+      actual,
+      s"Expected [${expected.mkString(", ")}] but got [${actual.mkString(", ")}]"
+    )
     additionalChecks(diagnostics.toList)
diff --git a/presentation-compiler/test/dotty/tools/pc/tests/DiagnosticProviderSuite.scala b/presentation-compiler/test/dotty/tools/pc/tests/DiagnosticProviderSuite.scala
@@ -16,15 +16,29 @@ class DiagnosticProviderSuite extends BaseDiagnosticsSuite {
       """|object M:
          |  Int.maaxValue
          |""".stripMargin,
-      List(TestDiagnostic(12,25, "value maaxValue is not a member of object Int - did you mean Int.MaxValue?", DiagnosticSeverity.Error))
-    )  
+      List(
+        TestDiagnostic(
+          12,
+          25,
+          "value maaxValue is not a member of object Int - did you mean Int.MaxValue?",
+          DiagnosticSeverity.Error
+        )
+      )
+    )
 
   @Test def warning =
     check(
       """|object M:
          |  1 + 1
          |""".stripMargin,
-      List(TestDiagnostic(12, 17, "A pure expression does nothing in statement position", DiagnosticSeverity.Warning))
+      List(
+        TestDiagnostic(
+          12,
+          17,
+          "A pure expression does nothing in statement position",
+          DiagnosticSeverity.Warning
+        )
+      )
     )
 
   @Test def mixed =
@@ -34,8 +48,18 @@ class DiagnosticProviderSuite extends BaseDiagnosticsSuite {
          |  1 + 1
          |""".stripMargin,
       List(
-        TestDiagnostic(12,25, "value maaxValue is not a member of object Int - did you mean Int.MaxValue?", DiagnosticSeverity.Error),
-        TestDiagnostic(28, 33, "A pure expression does nothing in statement position", DiagnosticSeverity.Warning)
+        TestDiagnostic(
+          12,
+          25,
+          "value maaxValue is not a member of object Int - did you mean Int.MaxValue?",
+          DiagnosticSeverity.Error
+        ),
+        TestDiagnostic(
+          28,
+          33,
+          "A pure expression does nothing in statement position",
+          DiagnosticSeverity.Warning
+        )
       )
     )
 
@@ -45,12 +69,29 @@ class DiagnosticProviderSuite extends BaseDiagnosticsSuite {
          |  private private class Test
          |""".stripMargin,
       List(
-        TestDiagnostic(20, 27, "Repeated modifier private", DiagnosticSeverity.Error),
+        TestDiagnostic(
+          20,
+          27,
+          "Repeated modifier private",
+          DiagnosticSeverity.Error
+        )
       ),
       diags =>
-        val action = diags.head.getData().asInstanceOf[java.util.List[CodeAction]].asScala.head
-        assertWithDiff("Remove repeated modifier: \"private\"", action.getTitle(), false)
-        assertEquals(1, action.getEdit().getChanges().size(), "There should be one change")
+        val action = diags.head
+          .getData()
+          .asInstanceOf[java.util.List[CodeAction]]
+          .asScala
+          .head
+        assertWithDiff(
+          "Remove repeated modifier: \"private\"",
+          action.getTitle(),
+          false
+        )
+        assertEquals(
+          1,
+          action.getEdit().getChanges().size(),
+          "There should be one change"
+        )
     )
 
 }
diff --git a/presentation-compiler/test/dotty/tools/pc/tests/ExplainDiagnosticProviderSuite.scala b/presentation-compiler/test/dotty/tools/pc/tests/ExplainDiagnosticProviderSuite.scala
@@ -11,7 +11,7 @@ import scala.meta.internal.jdk.CollectionConverters.*
 
 class ExplainDiagnosticProviderSuite extends BaseDiagnosticsSuite {
 
-  override def options : List[String] = List("-explain")
+  override def options: List[String] = List("-explain")
 
   @Test def error1 =
     check(
@@ -24,8 +24,9 @@ class ExplainDiagnosticProviderSuite extends BaseDiagnosticsSuite {
          |""".stripMargin,
       List(
         TestDiagnostic(
-        64,65,
-        """|Reference to m is ambiguous.
+          64,
+          65,
+          """|Reference to m is ambiguous.
            |It is both defined in object C
            |and inherited subsequently in object T
            |
@@ -48,8 +49,7 @@ class ExplainDiagnosticProviderSuite extends BaseDiagnosticsSuite {
            | - When importing, you can avoid naming conflicts by renaming:
            |   import scala.{m => mTick}
            |""".stripMargin,
-        DiagnosticSeverity.Error
-        
+          DiagnosticSeverity.Error
         )
       )
     )
