Skip to content

Commit 124e29a

Browse files
committed
docs(contributing): show an example of how to switch your build server
This is a follow-up from the comment [here](#17585 (comment)) and just adds a bit more details about making sure you import the project correctly. [skip community_build]
1 parent 28915c4 commit 124e29a

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

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

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,26 +22,34 @@ sbt:scala3> projects
2222
...
2323
```
2424

25-
These duplicated projects can be confusing and cause issues in IDEs.
25+
These duplicated projects can be confusing and cause issues in IDEs, so it's
26+
import to import the project in a specifcc way depending on your editor.
2627

2728
### Metals
2829

2930
When using Metals, the `-bootstrapped` projects are not exported by default.
3031
Normally this is fine, but if you're working on certain modules like `scaladoc`
3132
you'll actually want these modules exported. In order to achieve this you'll
32-
first want to ensure you're using `sbt` as your build server instead of the
33-
default Bloop. You can achieve this with the `Metals: Switch Build Server`
34-
command and then choosing sbt. Once you do this, you'll want to find and change
35-
the following under `commonBootstrappedSettings` which is found in the
36-
[`Build.scala`](https://github.com/lampepfl/dotty/blob/main/project/Build.scala)
37-
file.
33+
want to make sure you do two things:
34+
35+
1. You'll want to find and change the following under
36+
`commonBootstrappedSettings` which is found in the
37+
[`Build.scala`](https://github.com/lampepfl/dotty/blob/main/project/Build.scala)
38+
file.
3839

3940
```diff
4041

4142
- bspEnabled := false,
4243
+ bspEnabled := true,
4344
```
4445

46+
2. Set `sbt` as your build server instead of the default, Bloop. You can achieve
47+
this with the `Metals: Switch Build Server` command and then choosing sbt. In
48+
VSCode, this looks like this:
49+
50+
![bsp-switch](https://user-images.githubusercontent.com/777748/241986423-0724ae74-0ebd-42ef-a1b7-4d17678992b4.png)
51+
52+
4553
### IntelliJ
4654

4755
In IntelliJ IDEA, we recommend importing the dotty codebase through BSP, then

0 commit comments

Comments
 (0)