Merge pull request #63 from scala/backport-lts-3.3-21842

Backport "improvement: Remove workaround for Bloop and update docs" to 3.3 LTS

Author: tgodzik

compiler/src/dotty/tools/dotc/config/Settings.scala

@@ -293,8 +293,11 @@ object Settings:
     def BooleanSetting(name: String, descr: String, initialValue: Boolean = false, aliases: List[String] = Nil): Setting[Boolean] =
       publish(Setting(name, descr, initialValue, aliases = aliases))
 
-    def StringSetting(name: String, helpArg: String, descr: String, default: String, aliases: List[String] = Nil, deprecation: Option[Deprecation] = None, depends: SettingDependencies = Nil): Setting[String] =
-      publish(Setting(descr, default, helpArg, aliases = aliases, deprecation = deprecation, depends = depends))
+    def StringSetting(name: String, helpArg: String, descr: String, default: String, aliases: List[String] = Nil, depends: SettingDependencies = Nil): Setting[String] =
+      publish(Setting(name, descr, default, helpArg, aliases = aliases, depends = depends))
+
+    def ChoiceSetting(name: String, helpArg: String, descr: String, choices: List[String], default: String, aliases: List[String] = Nil): Setting[String] =
+      publish(Setting(name, descr, default, helpArg, Some(choices), aliases = aliases))
 
     def MultiChoiceSetting(name: String, helpArg: String, descr: String, choices: List[String], default: List[String], aliases: List[String] = Nil): Setting[List[String]] =
       publish(Setting(name, descr, default, helpArg, Some(choices), aliases = aliases))
@@ -320,8 +323,8 @@ object Settings:
     def PathSetting(name: String, descr: String, default: String, aliases: List[String] = Nil): Setting[String] =
       publish(Setting(name, descr, default, aliases = aliases))
 
-    def PhasesSetting(name: String, descr: String, default: String = "", aliases: List[String] = Nil, deprecation: Option[Deprecation] = None, depends: SettingDependencies = Nil): Setting[List[String]] =
-      publish(Setting(descr, if (default.isEmpty) Nil else List(default), aliases = aliases, deprecation = deprecation, depends = depends))
+    def PhasesSetting(name: String, descr: String, default: String = "", aliases: List[String] = Nil, depends: SettingDependencies = Nil): Setting[List[String]] =
+      publish(Setting(name, descr, if (default.isEmpty) Nil else List(default), aliases = aliases, depends = depends))
 
     def PrefixSetting(name: String, pre: String, descr: String): Setting[List[String]] =
       publish(Setting(name, descr, Nil, prefix = pre))

compiler/src/dotty/tools/dotc/core/SymbolLoaders.scala

@@ -337,7 +337,7 @@ abstract class SymbolLoader extends LazyType { self =>
     val sym = root.symbol
     def associatedFile = root.symbol.associatedFile match
       case file: AbstractFile => file
-      case _ => NoAbstractFile
+      case null => NoAbstractFile
     ctx.profiler.onCompletion(sym, associatedFile)(body)
   }
 

docs/_docs/contributing/setting-up-your-ide.md

@@ -3,16 +3,15 @@ layout: doc-page
 title: Setting up your IDE
 ---
 
-You can use either Metals with your favorite editor (VS Code, Neovim, Sublime)
-or [IntelliJ IDEA for
-Scala](https://www.jetbrains.com/help/idea/discover-intellij-idea-for-scala.html)
+You can use either Metals with your favorite editor or
+[IntelliJ IDEA for Scala](https://www.jetbrains.com/help/idea/discover-intellij-idea-for-scala.html)
 to work on the Scala 3 codebase. There are however a few additional
 considerations to take into account.
 
 ## Bootstrapping Projects
 
-The sbt build for dotty implements bootstrapping within the same build, so each component has
-two projects:
+The sbt build for dotty implements bootstrapping within the same build, so each
+component has two projects:
 
 ```
 sbt:scala3> projects
@@ -32,23 +31,24 @@ Normally this is fine, but if you're working on certain modules like `scaladoc`
 you'll actually want these modules exported. In order to achieve this you'll
 want to make sure you do two things:
 
-1. You'll want to find and change the following under
-    `commonBootstrappedSettings` which is found in the
-    [`Build.scala`](https://github.com/lampepfl/dotty/blob/main/project/Build.scala)
-    file.
+1. You'll want to find and change the following above
+   `commonBootstrappedSettings` which is found in the
+   [`Build.scala`](https://github.com/scala/scala3/blob/main/project/Build.scala)
+   file.
 
 ```diff
 
--    bspEnabled := false,
-+    bspEnabled := true,
+-    val enableBspAllProjects = false,
++    val enableBspAllProjects = true,
 ```
 
-2. Set `sbt` as your build server instead of the default, Bloop. You can achieve
-    this with the `Metals: Switch Build Server` command and then choosing sbt. In
-    VSCode, this looks like this:
+2. Run `sbt publishLocal` to get the needed presentation compiler jars.
 
-![bsp-switch](https://user-images.githubusercontent.com/777748/241986423-0724ae74-0ebd-42ef-a1b7-4d17678992b4.png)
+By default Metals uses Bloop build server, however you can also use sbt
+directly. You can achieve this with the `Metals: Switch Build Server` command
+and then choosing sbt. In VSCode, this looks like this:
 
+![bsp-switch](https://user-images.githubusercontent.com/777748/241986423-0724ae74-0ebd-42ef-a1b7-4d17678992b4.png)
 
 ### IntelliJ
 

project/Build.scala

@@ -364,10 +364,20 @@ object Build {
     ) ++ extMap
   }
 
+  /* These projects are irrelevant from IDE point of view and do not compile with Bloop*/
+  val fullyDisabledProjects = Set(
+    "scala2-library-cc",
+    "scala2-library-bootstrapped",
+    "scala2-library-cc-tasty",
+    "scala2-library-tasty"
+  )
+
+  val enableBspAllProjects = false
+
   // Settings used when compiling dotty with a non-bootstrapped dotty
-  lazy val commonBootstrappedSettings = commonDottySettings ++ NoBloopExport.settings ++ Seq(
-    // To enable support of scaladoc and language-server projects you need to change this to true and use sbt as your build server
-    bspEnabled := false,
+  lazy val commonBootstrappedSettings = commonDottySettings ++ Seq(
+    // To enable support of scaladoc and language-server projects you need to change this to true
+    bspEnabled := { if(fullyDisabledProjects(name.value)) false else enableBspAllProjects },
     (Compile / unmanagedSourceDirectories) += baseDirectory.value / "src-bootstrapped",
 
     version := dottyVersion,