|
| 1 | +--- |
| 2 | +layout: doc-page |
| 3 | +title: "IDE support for Dotty" |
| 4 | +--- |
| 5 | + |
| 6 | +Dotty comes built-in with the Dotty Language Server, an implementation of the |
| 7 | +[Language Server Protocol](https://github.com/Microsoft/language-server-protocol), |
| 8 | +which means that any editor that implements support for the LSP can get a great |
| 9 | +Dotty integration. Currently, the only IDE we officially support |
| 10 | +is [Visual Studio Code](https://code.visualstudio.com/). |
| 11 | + |
| 12 | +Prerequisites |
| 13 | +============ |
| 14 | +To use this in your own Scala project, you must first get it to compile with |
| 15 | +Dotty, please follow the instructions at https://github.com/lampepfl/dotty-example-project |
| 16 | + |
| 17 | +Usage |
| 18 | +===== |
| 19 | +1. Install [Visual Studio Code](https://code.visualstudio.com/). |
| 20 | +2. In your project, run: |
| 21 | +```shell |
| 22 | +sbt launchIDE |
| 23 | +``` |
| 24 | + |
| 25 | +Status |
| 26 | +====== |
| 27 | + |
| 28 | +## Fully supported features: |
| 29 | +- Typechecking as you type to show compiler errors/warnings |
| 30 | +- Type information on hover |
| 31 | +- Go to definition (in the current project) |
| 32 | +- Find all references |
| 33 | + |
| 34 | +## Partially working features: |
| 35 | +- Completion |
| 36 | +- Renaming |
| 37 | +- Go to definition in external projects |
| 38 | + |
| 39 | +## Unimplemented features: |
| 40 | +- Documentation on hover |
| 41 | +- Formatting code (requires integrating with scalafmt) |
| 42 | +- Quick fixes (probably by integrating with scalafix) |
| 43 | + |
| 44 | +## Current limitations, to be fixed: |
| 45 | +- Projects should be compiled with sbt before starting the IDE, this is |
| 46 | + automatically done for you if you run `sbt launchIDE`. |
| 47 | +- Once the IDE is started, source files that are not opened in the IDE |
| 48 | + should not be modified in some other editor, the IDE won't pick up |
| 49 | + these changes. |
| 50 | +- Not all compiler errors/warnings are displayed, just those occuring |
| 51 | + during typechecking. |
| 52 | + |
| 53 | + |
| 54 | +Feedback |
| 55 | +======== |
| 56 | +Please report issues on https://github.com/lampepfl/dotty/issues, |
| 57 | +you can also come chat with use on the |
| 58 | +[Dotty gitter channel](https://gitter.im/lampepfl/dotty)! |
0 commit comments