chore: Add a warning when ignoring JAVA_HOME set by Metals

scalameta · Jun 17, 2024 · b8d7199 · b8d7199
1 parent 70d7650
commit b8d7199
Showing 1 changed file with 11 additions and 2 deletions.
diff --git a/metals/src/main/scala/scala/meta/internal/bsp/BspServers.scala b/metals/src/main/scala/scala/meta/internal/bsp/BspServers.scala
@@ -102,8 +102,17 @@ final class BspServers(
         // With Bazel for example chaning JAVA_HOME might cause Bazel to restart on shell
         if (
           sys.env.contains("JAVA_HOME") && details.getName().contains("bazel")
-        ) Map.empty[String, String]
-        else JdkSources.envVariables(userConfig().javaHome)
+        ) {
+          userConfig().javaHome.zip(sys.env.get("JAVA_HOME")) match {
+            case Some((metalsHome, envHome)) if metalsHome != envHome =>
+              scribe.warn(
+                s"JAVA_HOME set by Metals (${metalsHome}) would be different than the one set in the environment ($envHome), " +
+                  "which might cause Bazel to restart on shell, so Metals will not override it."
+              )
+            case _ =>
+          }
+          Map.empty[String, String]
+        } else JdkSources.envVariables(userConfig().javaHome)
       scribe.info(s"Running BSP server $args")
       val proc = SystemProcess.run(
         args,