Metals works with the following text editors with varying degree of functionality.
|Editor||Installation||Build import||Diagnostics||Goto definition||Completions||Hover||Parameter hints||Find references||Document symbols||Workspace symbols||Formatting||Folding||Highlight||Metals Extensions|
|Visual Studio Code||Single click||✅||✅||✅||✅||✅||✅||✅||✅||✅||✅||✅||✅||✅|
|Atom||Single click||✅||✅||✅||✅*||✅||✅||✅||✅||✅||Status bar|
|Vim||Few steps||✅||✅||✅||✅*||✅||✅||✅||Flat||✅||✅*||✅*||Status bar|
|Sublime Text 3||Few steps||✅||✅||✅||✅||✅||✅||✅||Flat||✅||✅||✅|
|Emacs||Few steps||✅||✅||✅||✅||✅||✅||✅||✅||✅||✅||✅||✅||Status bar|
Metals is a new project with limited features. If you are learning Scala or are looking for a rich IDE experience it is recommended to use IntelliJ instead.
Single click: Metals is easy to install and requires minimal configuration out-of-the-box.
Few steps: installing Metals requires a few custom steps and minimal configuration to work.
Compile from source: installing Metals requires building an editor plugin from source.
✅: it is possible to import a build such as an sbt project directly from the editor.
Requires browser: importing a build requires additional steps in a web browser using a localhost server. It is not possible to import a build within the editor.
✅: Diagnostics are correctly published on compile.
Escaped newlines: Multi-line diagnostic are slightly difficult to read since
newlines are escaped into
Single buffer: Diagnostics are only published for the current buffer so compile errors are lost for unopened files.
Compile errors are reported as red squiggles in the editor. Compilation is triggered on file save for the build target (project/module) containing the focused text file.
- Slow feedback for type errors. Syntax errors are published as you type but type errors are handled by the build tool, meaning diagnostics may take a while to publish for large projects.
Navigate to symbol definitions for project sources and Scala/Java library dependencies.
Symbols are resolved according to the last successful compilation in the build tool and navigation continues to work despite syntax errors in the open unsaved buffer.
- Navigation does not work for buffers that do not tokenize, for example due to unclosed string literals.
- scalameta/scalameta#1802 reflective invocations (methods calls on structural types) do not resolve to a definition.
✅ Atom: no auto-import and string interpolator completions produce invalid code.
✅ Vim: auto-import and snippets require coc.nvim client.
Use code completions to explore APIs, implement interfaces, generate exhaustive pattern matches and more.
- Auto-import: imports are inserted at the bottom of the global import list. Imports still need to be sorted and grouped manually, we are exploring ways to automate this workflow in the future.
- Override def: implement methods from the super class.
- Exhaustive match: generate an exhaustive pattern match for sealed types.
- String interpolator: automatically convert string literals into string interpolators.
- Filename: complete classnames based on the enclosing file.
- Documentation: read the docstring for method symbols by pressing ctrl+space in VS Code.
- completion results don't include symbols that have just been typed in separate files without a successful compilation in the build tool.
Hover (aka. type at point)
See the expression type and symbol signature under the cursor.
- Expression type: shows the non-generic type of the highlighted expression.
- Symbol signature: shows the generic signature of symbol under the cursor along with its docstring, if available.
Signature help (aka. parameter hints)
View a method signature and method overloads as you fill in the arguments.
Find symbol references in project sources. References include implicits,
.flatMap from for comprehensions and other
symbols that may not be explicitly written in source, making it possible to
discover usages of difficult-to-grep symbols. The Metals navigation index is
low-overhead and should only require a few megabytes of memory even for large
- References to overridden methods are not included in the results. For example,
if you run "find references" on the method
Dog.name()then it won't include references to the super method
✅: Document symbols are displayed in a hierarchical outline.
Flat: Document symbols are displayed in a flat outline.
Fuzzy search a symbol in the workspace of library dependencies by its name.
- All-lowercase queries are treated as case-insensitive searches.
- Queries ending with a dot
.list nested symbols.
- Queries containing a semicolon
;search library dependencies.
Metals uses Scalafmt to respond to formatting requests from the editor,
according to the configuration defined in
Learn how to configure Scalafmt at https://scalameta.org/scalafmt/docs/configuration.html.
Fold ranges such as large multi-line expressions, import groups and comments.
Highlight references to the same symbol in the open file.
Browse packages, classes and methods in the workspace and library dependencies using the Metals sidebar. This feature is only implemented in VS Code.
Status bar: Editor client implements the
Tree view: Editor client implements the Tree View Protocol.
Did focus: Editor client implements the
Slow task: Editor client implements the
Input box: Editor client implements the
Window state: Editor client implements the
✅: Editor implements all Metals extension endpoints.
The Metals language server supports custom extensions that are not part of the Language Server Protocol (LSP). These extensions are not necessary for Metals to function but they improve the user experience. To learn more about Metals extensions, see integrating a new editor.
Metals does not support the following features:
- Rename symbol
- Organize imports
- Run test
- Refactoring: move class, extract/inline value, convert to block