refactor: Migrate Metals server to Scala 3

This mostly involved: - changing imports - moving things between MtagsEnrichements variants - adding () - fixing bugs reported now as warning or errors (things previously not reported at all)
scalameta · Aug 16, 2024 · c3b94dc · c3b94dc
1 parent fcb65af
commit c3b94dc
Show file tree

Hide file tree

Showing 199 changed files with 929 additions and 756 deletions.
diff --git a/.scalafix.conf b/.scalafix.conf
@@ -1,19 +1,15 @@
 rules = [
-  OrganizeImports,
-  ExplicitResultTypes,
-  RemoveUnused
+  OrganizeImports
 ]
 
-ExplicitResultTypes.rewriteStructuralTypesToNamedSubclass = false
-
-RemoveUnused.imports = false
-
 OrganizeImports.groupedImports = Explode
 OrganizeImports.expandRelative = true
-OrganizeImports.removeUnused = true
+OrganizeImports.removeUnused = false
 OrganizeImports.groups = [
   "re:javax?\\."
   "scala."
   "scala.meta."
   "*"
 ]
+
+OrganizeImports.targetDialect = StandardLayout
diff --git a/.scalafix2.conf b/.scalafix2.conf
@@ -0,0 +1,19 @@
+rules = [
+  OrganizeImports,
+  ExplicitResultTypes,
+  RemoveUnused
+]
+
+ExplicitResultTypes.rewriteStructuralTypesToNamedSubclass = false
+
+RemoveUnused.imports = false
+
+OrganizeImports.groupedImports = Explode
+OrganizeImports.expandRelative = true
+OrganizeImports.removeUnused = true
+OrganizeImports.groups = [
+  "re:javax?\\."
+  "scala."
+  "scala.meta."
+  "*"
+]
diff --git a/.scalafix3.conf b/.scalafix3.conf
diff --git a/.scalafmt.conf b/.scalafmt.conf
@@ -1,5 +1,5 @@
 version = "3.8.3"
-runner.dialect = scala213source3
+runner.dialect = scala3
 project.git = true
 align.preset = none
 align.stripMargin = true
@@ -37,6 +37,7 @@ fileOverride {
   },
   "glob:**/mtags*/**" {
     trailingCommas = never
+    runner.dialect = scala213
   }
   "glob:**/tests/cross/src/**" {
     trailingCommas = never

diff --git a/build.sbt b/build.sbt
@@ -36,16 +36,16 @@ def crossSetting[A](
 logo := Welcome.logo
 usefulTasks := Welcome.tasks
 
-ThisBuild / scalafixScalaBinaryVersion := scalaBinaryVersion.value
+ThisBuild / scalafixScalaBinaryVersion := "2.13"
 
 inThisBuild(
   List(
     version ~= { dynVer =>
       if (isCI) dynVer
       else localSnapshotVersion // only for local publishing
     },
-    scalaVersion := V.scala213,
-    crossScalaVersions := List(V.scala213),
+    scalaVersion := V.scala3,
+    crossScalaVersions := List(V.scala3),
     organization := "org.scalameta",
     licenses := Seq(
       "Apache-2.0" -> url("http://www.apache.org/licenses/LICENSE-2.0")
@@ -128,7 +128,7 @@ commands ++= Seq(
       runMtagsPublishLocal(st, v, localSnapshotVersion)
     }
     "interfaces/publishLocal" ::
-      s"++${V.scala213} metals/publishLocal" ::
+      s"++${V.scala3} metals/publishLocal" ::
       "mtags-java/publishLocal" ::
       publishMtags
   },
@@ -218,6 +218,27 @@ val sharedSettings = sharedJavacOptions ++ sharedScalacOptions ++ List(
       )
     ),
   ),
+  excludeDependencies ++= crossSetting(
+    scalaVersion.value,
+    if3 = {
+      // Exclude cross published version dependencies leading to conflicts in Scala 3 vs 2.13
+      // When using Scala 3 exclude Scala 2.13 standard native libraries,
+      // when using Scala 2.13 exclude Scala 3 standard native libraries
+      // Use full name, Maven style published artifacts cannot use artifact/cross version for exclusion rules
+      List(
+        ExclusionRule()
+          .withOrganization("org.scala-lang.modules")
+          .withName(
+            "scala-collection-compat_2.13"
+          ),
+        ExclusionRule()
+          .withOrganization("org.scala-lang.modules")
+          .withName(
+            "scala-xml_2.13"
+          ),
+      )
+    },
+  ),
   scalacOptions ++= lintingOptions(scalaVersion.value),
 )
 
@@ -299,6 +320,10 @@ def withExcludes(moduleId: ModuleID) =
       "com.lihaoyi",
       "sourcecode_2.13",
     ) // avoid 2.13 and 3 on the classpath since it comes in via pprint
+    .exclude(
+      "org.scala-lang.modules",
+      "scala-parallel-collections_2.13",
+    ) // avoid 2.13 and 3 on the classpath since it comes in via pprint
 
 def scala3SemanticdbDependency: ModuleID = withExcludes(
   ("org.scalameta" % s"semanticdb-shared_${V.scala213}" % V.scalameta)
@@ -309,6 +334,10 @@ def scala3ScalametaDependency: ModuleID = withExcludes(
     .cross(CrossVersion.for3Use2_13)
 )
 
+def scala3MetapDependency: ModuleID = withExcludes(
+  "org.scalameta" % s"semanticdb-metap_${V.scala213}" % V.scalameta
+)
+
 val mtagsSettings = List(
   crossScalaVersions := V.supportedScalaVersions,
   crossTarget := target.value / s"scala-${scalaVersion.value}",
@@ -370,22 +399,22 @@ val mtagsSettings = List(
   },
 )
 
-lazy val mtags3 = project
+lazy val mtags2 = project
   .in(file(".mtags"))
   .settings(
     Compile / unmanagedSourceDirectories := Seq(),
     sharedSettings,
     mtagsSettings,
     Compile / unmanagedSourceDirectories += (ThisBuild / baseDirectory).value / "mtags" / "src" / "main" / "scala",
     Compile / unmanagedSourceDirectories += (ThisBuild / baseDirectory).value / "mtags-shared" / "src" / "main" / "scala",
-    Compile / unmanagedSourceDirectories += (ThisBuild / baseDirectory).value / "mtags-shared" / "src" / "main" / "scala-3",
-    moduleName := "mtags3",
-    scalaVersion := V.scala3,
-    target := (ThisBuild / baseDirectory).value / "mtags" / "target" / "target3",
+    Compile / unmanagedSourceDirectories += (ThisBuild / baseDirectory).value / "mtags-shared" / "src" / "main" / "scala-2.13",
+    moduleName := "mtags2",
+    scalaVersion := V.scala213,
+    target := (ThisBuild / baseDirectory).value / "mtags" / "target" / "target2",
     publish / skip := true,
     libraryDependencies += V.guava,
     scalafixConfig := Some(
-      (ThisBuild / baseDirectory).value / ".scalafix3.conf"
+      (ThisBuild / baseDirectory).value / ".scalafix2.conf"
     ),
   )
   .dependsOn(interfaces)
@@ -433,26 +462,34 @@ lazy val metals = project
       // for BSP
       "org.scala-sbt.ipcsocket" % "ipcsocket" % "1.6.2",
       "ch.epfl.scala" % "bsp4j" % V.bsp,
-      "ch.epfl.scala" %% "bloop-rifle" % V.bloop,
+      ("ch.epfl.scala" %% "bloop-rifle" % V.bloop)
+        .cross(CrossVersion.for3Use2_13),
       // for LSP
       V.lsp4j,
       // for DAP
       V.dap4j,
-      "ch.epfl.scala" %% "scala-debug-adapter" % V.debugAdapter,
+      ("ch.epfl.scala" %% "scala-debug-adapter" % V.debugAdapter)
+        .cross(CrossVersion.for3Use2_13),
       // for finding paths of global log/cache directories
       "dev.dirs" % "directories" % "26",
       // ==================
       // Scala dependencies
       // ==================
       "org.scalameta" % "mdoc-interfaces" % V.mdoc,
-      "org.scalameta" %% "scalafmt-dynamic" % V.scalafmt,
+      ("org.scalameta" %% "scalafmt-dynamic" % V.scalafmt)
+        .cross(CrossVersion.for3Use2_13),
+      "com.googlecode.java-diff-utils" % "diffutils" % "1.3.0",
       "ch.epfl.scala" % "scalafix-interfaces" % V.scalafix,
       // For reading classpaths.
       // for fetching ch.epfl.scala:bloop-frontend and other library dependencies
       "io.get-coursier" % "interface" % V.coursierInterfaces,
       // for comparing versions && fetching from sbt maven repository
-      "io.get-coursier" %% "coursier" % V.coursier,
-      "io.get-coursier" %% "coursier-sbt-maven-repository" % V.coursier,
+      ("io.get-coursier" %% "versions" % "0.3.2")
+        .cross(CrossVersion.for3Use2_13),
+      ("io.get-coursier" %% "coursier-sbt-maven-repository" % V.coursier)
+        .cross(CrossVersion.for3Use2_13),
+      ("io.get-coursier" %% "coursier" % V.coursier)
+        .cross(CrossVersion.for3Use2_13),
       // for logging
       "com.outr" %% "scribe" % V.scribe,
       "com.outr" %% "scribe-file" % V.scribe,
@@ -462,15 +499,12 @@ lazy val metals = project
       // For fetching projects' templates
       "com.lihaoyi" %% "requests" % "0.9.0",
       // for producing SemanticDB from Scala source files, to be sure we want the same version of scalameta
-      "org.scalameta" %% "scalameta" % V.semanticdb(scalaVersion.value),
-      "org.scalameta" %% "semanticdb-metap" % V.semanticdb(
-        scalaVersion.value
-      ) cross CrossVersion.full,
-      "org.scalameta" % "semanticdb-shared" % V.semanticdb(
-        scalaVersion.value
-      ) cross CrossVersion.full,
+      scala3ScalametaDependency,
+      scala3MetapDependency,
+      scala3SemanticdbDependency,
       // For starting Ammonite
-      "io.github.alexarchambault.ammonite" %% "ammonite-runner" % "0.4.0",
+      ("io.github.alexarchambault.ammonite" %% "ammonite-runner" % "0.4.0")
+        .cross(CrossVersion.for3Use2_13),
       "org.scala-lang.modules" %% "scala-xml" % "2.3.0",
       "org.scala-lang.modules" %% "scala-parallel-collections" % "1.0.4",
       ("org.virtuslab.scala-cli" % "scala-cli-bsp" % V.scalaCli)
@@ -540,6 +574,7 @@ lazy val input = project
   .in(file("tests/input"))
   .settings(
     sharedSettings,
+    scalaVersion := V.scala213,
     scalacOptions -= "-Xsource:3",
     publish / skip := true,
     libraryDependencies ++= List(
@@ -716,6 +751,7 @@ lazy val metalsDependencies = project
   .in(file("target/.dependencies"))
   .settings(
     publish / skip := true,
+    scalaVersion := V.scala213,
     // silent the intransitive dependency warning
     publishMavenStyle := false,
     libraryDependencies ++= List(
@@ -745,8 +781,10 @@ lazy val unit = project
     sharedSettings,
     Test / javaOptions += "-Xmx2G",
     libraryDependencies ++= List(
-      "io.get-coursier" %% "coursier" % V.coursier, // for jars
-      "ch.epfl.scala" %% "bloop-config" % V.bloopConfig,
+      ("io.get-coursier" %% "coursier" % V.coursier)
+        .cross(CrossVersion.for3Use2_13), // for jars
+      ("ch.epfl.scala" %% "bloop-config" % V.bloopConfig)
+        .cross(CrossVersion.for3Use2_13),
       "org.scalameta" %% "munit" % V.munit,
     ),
     buildInfoPackage := "tests",

diff --git a/metals-bench/src/main/scala/bench/MetalsBench.scala b/metals-bench/src/main/scala/bench/MetalsBench.scala
@@ -1,11 +1,6 @@
 package bench
 
-import scala.reflect.internal.util.BatchSourceFile
-import scala.reflect.io.VirtualFile
-import scala.tools.nsc.interactive.Global
-
 import scala.meta.dialects
-import scala.meta.interactive.InteractiveSemanticdb
 import scala.meta.internal.metals.EmptyReportContext
 import scala.meta.internal.metals.IdentifierIndex
 import scala.meta.internal.metals.JdkSources
@@ -23,7 +18,6 @@ import scala.meta.internal.mtags.SemanticdbClasspath
 import scala.meta.internal.parsing.Trees
 import scala.meta.internal.semanticdb.TextDocument
 import scala.meta.internal.tokenizers.LegacyScanner
-import scala.meta.internal.tokenizers.LegacyToken
 import scala.meta.io.AbsolutePath
 import scala.meta.io.Classpath
 
@@ -129,22 +123,6 @@ class MetalsBench {
     }
   }
 
-  @Benchmark
-  @BenchmarkMode(Array(Mode.SingleShotTime))
-  def scalacTokenize(): Unit = {
-    val g = global
-    scalaDependencySources.foreach { input =>
-      val unit = new g.CompilationUnit(
-        new BatchSourceFile(new VirtualFile(input.path), input.chars)
-      )
-      val scanner = g.newUnitScanner(unit)
-      scanner.init()
-      while (scanner.token != LegacyToken.EOF) {
-        scanner.nextToken()
-      }
-    }
-  }
-
   @Benchmark
   @BenchmarkMode(Array(Mode.SingleShotTime))
   def scalametaParse(): Unit = {
@@ -154,27 +132,6 @@ class MetalsBench {
     }
   }
 
-  lazy val global: Global = InteractiveSemanticdb.newCompiler()
-
-  @Benchmark
-  @BenchmarkMode(Array(Mode.SingleShotTime))
-  def scalacParse(): Unit = {
-    val g = global
-    scalaDependencySources.foreach { input =>
-      val unit = new g.CompilationUnit(
-        new BatchSourceFile(new VirtualFile(input.path), input.chars)
-      )
-      val tree = g.newUnitParser(unit).parse()
-      var i = 0
-      new g.Traverser {
-        override def apply[T <: g.Tree](tree: T): T = {
-          i += 1
-          super.apply(tree)
-        }
-      }.traverse(tree)
-    }
-  }
-
   @Benchmark
   @BenchmarkMode(Array(Mode.SingleShotTime))
   def mtagsJavaParse(): Unit = {

diff --git a/metals/src/main/scala/scala/meta/internal/bsp/BspConfigGenerator.scala b/metals/src/main/scala/scala/meta/internal/bsp/BspConfigGenerator.scala
@@ -12,9 +12,9 @@ import scala.meta.internal.builds.BuildServerProvider
 import scala.meta.internal.builds.ShellRunner
 import scala.meta.internal.metals.Directories
 import scala.meta.internal.metals.Messages.BspProvider
-import scala.meta.internal.metals.MetalsEnrichments._
-import scala.meta.internal.metals.StatusBar
 import scala.meta.internal.metals.UserConfiguration
+import scala.meta.internal.metals.StatusBar
+import scala.meta.internal.metals.MetalsEnrichments.given
 import scala.meta.internal.metals.clients.language.MetalsLanguageClient
 import scala.meta.io.AbsolutePath
 

diff --git a/metals/src/main/scala/scala/meta/internal/bsp/BspConnector.scala b/metals/src/main/scala/scala/meta/internal/bsp/BspConnector.scala
@@ -18,8 +18,8 @@ import scala.meta.internal.metals.CreateSession
 import scala.meta.internal.metals.GenerateBspConfigAndConnect
 import scala.meta.internal.metals.Messages
 import scala.meta.internal.metals.Messages.BspSwitch
-import scala.meta.internal.metals.MetalsEnrichments._
 import scala.meta.internal.metals.SlowConnect
+import scala.meta.internal.metals.MetalsEnrichments.given
 import scala.meta.internal.metals.StatusBar
 import scala.meta.internal.metals.Tables
 import scala.meta.internal.metals.UserConfiguration
@@ -192,7 +192,7 @@ class BspConnector(
               None,
             )
           for {
-            Some(item) <- client
+            case Some(item) <- client
               .showMessageRequest(query.params)
               .asScala
               .map(item =>

diff --git a/metals/src/main/scala/scala/meta/internal/builds/BloopInstall.scala b/metals/src/main/scala/scala/meta/internal/builds/BloopInstall.scala
@@ -10,7 +10,7 @@ import scala.meta.internal.builds.Digest.Status
 import scala.meta.internal.metals.BuildInfo
 import scala.meta.internal.metals.Confirmation
 import scala.meta.internal.metals.Messages._
-import scala.meta.internal.metals.MetalsEnrichments._
+import scala.meta.internal.metals.MetalsEnrichments.given
 import scala.meta.internal.metals.Tables
 import scala.meta.internal.metals.UserConfiguration
 import scala.meta.internal.metals.clients.language.MetalsLanguageClient

diff --git a/metals/src/main/scala/scala/meta/internal/builds/BspOnly.scala b/metals/src/main/scala/scala/meta/internal/builds/BspOnly.scala
@@ -2,7 +2,6 @@ package scala.meta.internal.builds
 
 import java.security.MessageDigest
 
-import scala.meta.internal.builds.Digest
 import scala.meta.internal.mtags.MD5
 import scala.meta.io.AbsolutePath