What is it all about?
Tomasz Godzik
VirtusLab
Maintainer of multiple Scala tools including Metals, Bloop, Scalameta, Munit, Mdoc and parts of the Scala 3 compiler.
Release officer for Scala LTS versions
Part of the Scala Core team as coordinator and VirtusLab representative
Part of the moderation team
Most prominent Metals issues
MBT - Metals Build Tool
Fast IDE features
Improved Java Support
Plans
Questions
Uses Language Server Protocol to provide IDE features in any editor that implements the LSP client
Based on JSON RPC
Widely supported by multiple editors, de facto standard for most languages
Model Context Protocol is similar, but it is designed to be used by LLM agents
Provide tools and other resources to improve LLM results.
Main Metals v2 goal:
Make the IDE useful from the moment you clone a repo.
Main Metals v2 was worked on in Databricks by Ólafur Páll Geirsson, Iulian Dragos and others in the team.
Metals Build Tool symbol index
Each feature reinforces the others — together they make Metals viable for large, mixed-language monorepos.
It's about getting the minimal amount of information from the build to somewhere Metals can access it directly.
Symbol search depended on the BSP build server. We needed to connect to the build server (could be different from the build tool)
We had to wait to get all `src/main/scala` etc.
Editor opened
Build import
(1-5 min)
Build import
Build import
Build import
Build server start (20s-2min)
Build import
Build import
Build import
Not imported
Already imported
Indexing
(30s - 3min)
Build import
Build import
Build import
Ready to serve requests
Build import
Build import
Build import
Compilation (30s - 10min)
Build import
Build import
Build import
Self-contained index, zero build dependency. Can work as soon as it's indexed.
Editor opened
Build import
(1-5 min)
Build import
Build import
Build import
Build server start (20s-2min)
Build import
Build import
Build import
Not imported
Already imported
Indexing
(30s - 3min)
Build import
Build import
Build import
Ready to serve requests
Build import
Build import
Build import
Compilation (30s - 10min)
Build import
Build import
Build import
git ls-files --stage
~200-300ms
Each file checked if modified by OID
Index each file using existing fast indexers
Create IndexedDocument
Overwrite existing index.mbt on close
Contains information about all found identifiers added to bloom filters and definitions in a separate collection.
This is enough for navigation.
For references it's used together with the presentation compiler for correctness.
Query: "UserSer"
│
├─ File A → MAYBE match → compile it
├─ File B → NO match → skip
├─ File C → NO match → skip
└─ File D → MAYBE match → compile it
Result: only 2 of 4 files opened instead of all 4
Query: "UserSer"
│
├─ File A → MAYBE match → compile it
├─ File B → NO match → skip
├─ File C → NO match → skip
└─ File D → MAYBE match → compile it
Result: only 2 of 4 files opened instead of all 4
| Feature | How MBT helps |
|---|---|
| Workspace Symbol | Primary provider |
| Find References | Pre-filter via Bloom filters → only scan candidates |
| Find Implementations | Walks inheritance graph (depth ≤ 10) from index |
| Go to Definition | Fallback when classpath has no entry (pre-build) |
| Protobuf support | `.proto` files indexed alongside `.scala` and `.java` |
No separate Protobuf language server needed.
Very simple indexing in most cases
// ← appears in workspace/symbol
message TextDocuments {
// ← go-to-definition soon supported
repeated TextDocument documents = 1;
}
message TextDocument {
reserved 4, 8, 9;
Schema schema = 1;
string uri = 2;
}
git clone
Full IDE:
Build import
Build import
Build import
Open editor
If we don't have anything we put all sources into the presentation compiler.
This means that even in projects with broken build tool you should be able to work on your code.
And it does work in a lot of cases.
With caveats.
And it does work in a lot of cases.
The Scala presentation compiler accepts a `-sourcepath` flag that lets it resolve symbols directly from source files rather than requiring compiled class files on the classpath.
The fallback Scala compiler now receives the full source path of the project, including sources from transitive dependencies — not just direct ones.
This means the fallback compiler can resolve most symbols even in a large multi-module project without any compiled output.
package org.myorg.core
import org.myorg.util.Helper
object Main {
Helper.printMessage(
"Hello London!"
)
}package org.myorg.util
import org.myorg.util.Helper
object Helper {
def printMessage(msg: String): Unit = {
val message = "<info>" + msg
println(message)
}
}package org.myorg.services
object Service {
def execute(): Unit = {
// very complicated code ...
}
}org.myorg.core -> Main.scalaorg.myorg.util -> Helper.scalaorg.myorg.services -> Service.scalapackage org.myorg.core
import org.myorg.util.Helper
object Main {
Helper.printMessage(
"Hello London!"
)
}package org.myorg.util
object Helper {
def printMessage(msg: String): Unit = {
val message = "<info>" + msg
println(message)
}
}package org.myorg.services
object Service {
def execute(): Unit = {
// very complicated code ...
}
}This file is ignored
This is compiled
When we edit this file
If we have explicit types for our methods there is no reason to compile the method itself if we are not in that specific file.
Please use ExplicitResults rules in scalafix, it helps the tools a lot!
package org.myorg.core
import org.myorg.util.Helper
object Main {
Helper.printMessage(
"Hello London!"
)
}package org.myorg.util
object Helper {
def printMessage(msg: String): Unit = ???
}Bodies are ignored
When we edit this file
package org.myorg.core
import org.myorg.util.Helper
object Main {
Helper.printMessage(
"Hello London!"
)
}package org.myorg.util
object Helper {
def printMessage(msg: String): Unit = ???
}When we edit this file
Bodies are ignored
Sourcepath helps with the current project, but we still need to know what are the dependencies for the project.
This is where another feature of mbt comes in and the reason it's a "build tool"
.metals/mbt.json{
"dependencyModules": [
{
"id": "com.google.guava:guava:30.0-jre",
"jar": "/path/to/guava-30.0-jre.jar",
"sources": "/path/to/guava-30.0-jre-sources.jar"
}
]
}It's a very simple file format, we have extractors ready for Bazel, Maven and Gradle.
It can be setup for your project and updated similar to lock files.
Will make the experience work faster and better, you might not need a build server sometimes
This approach also works if we do have a full project structure
Results in completions and other features being up to date even with compilation issues
- workspaceSymbolProvider - mbt, bsp
- definitionProviders - protobuf, mbt
- javaSymbolLoader - javac-sourcepath, turbine-classpath
- javaTurbineRecompileDelay - 1.minute
- referenceProvider - bsp, mbt
- additionalPcChecks - [], [refchecks]
- scalaImportsPlacement - smart, append-lastOne of the main goals in Metals 2 to was to make it viable for large mixed codebases.
Hence we needed to step up out Java support as well.
We decided to implement most of the basic features of LSP for Java.
No complex refactors, since most likely LLM era makes them redundant.
| Feature | Status | Powered by. |
|---|---|---|
| Completions | ✅ | Presentation compiler |
| Hover | ✅ | Presentation compiler |
| Signature Help | ✅ | Presentation compiler |
| Diagnostics | ✅ | Presentation compiler |
| Semantic Highlighting | ✅ | Java Semanticdb |
| Selection Range | ✅ | Javac AST |
| Document Symbols | ✅ | Javac AST |
| Go to Definition | ✅ | SemanticDB + mbt |
| Find References | ✅ | mbt + Bloom filters |
We use google turbine which allows us to define stubs for each file without compiling method bodies.
We get in-memory classfiles which the javac compiler can use as a normal classpath
Caveat: It does not support project Lombok or annotation processors currently.
example/File.java (edited)
example/Other.java
...
Classfiles stubs: example/Other.class, example/Other2.class
File.java,
Google Turbine
Presentation compiler
Javac outline compiler, compiles the file fully
example/File.java (edited)
example/Other.java
...
Classfiles stubs: example/Other.class, example/Other2.class
File.java
Google Turbine
Presentation compiler
Javac outline compiler, compiles the file fully
Outline compiler, compiles without method bodies
AlsoEdited.java
By default turbine will run every minute, so we are back to classfiles once that completes
Edit Foo.java
javac resolves Bar (from sourcepath)
Bar references Baz → compile Baz too
Baz references Qux → compile Qux...
💥 500 files compiled for one edit
Sourcepath will still be used for any broken files and any changed files within last minute.
We still prefer to depend on fully compiled workspace as it's more efficient.
Overall, the approach in Java is very much similar to what we have in Scala.
The main difference is the inclusion of Google Turbine.
A lot was done to improve Bazel support:
- source jar as roots;
- handling large BSP messages;
But a lot of this was done with internal Bazel BSP server inside Databricks.
We're working on our own Scala based inlined inside Metals.
Java Support
Fast IDE features
MBT Index
Build from source on main-v2
or
metals.serverVersion : "2.0.0-M8"
Bluesky: @tgodzik.bsky.social
Mastodon: fosstodon.org/@tgodzik
Discord: tgodzik