olafurpg
commented
5 years ago This is the only remaining issue blocking a v0.5 release! I have published v0.5.0-M1 so people can try out a non-SNAPSHOT.
I have personally used VS Code + Metals for two weeks now and I'm pretty happy with the new functionality. It would be great to confirm before the stable release that the features also work outside of VS Code.
- [x] VS Code: @olafurpg / @gabro /@jvican
- [ ] Atom: @laughedelic
- [ ] Vim: @ceedubs / anyone else?. I recommend trying out coc.nvim instead of vim-lsc because coc.nvim implements several advanced completion features that Metals supports.
- [ ] Emacs: @JesusMtnez / @coreyoconnor / @rossabaker
- [ ] Sublime Text: @ayoub-benali
Below is a checklist of features that may need minor tweaking to improve the UX
outside of VS Code. The cursor position is indicated by @@.
Completions
In LSP, it's called textDocument/completion but in the editor it may be called
something else.
- scope completion, try completing a variable like
println@@ - member completion, try completing a member of a type such
Predef.println@@. - auto-import completion, try completing a symbol that is not in scope, like
Future@@and if you select the optionFuture - scala.concurrentit adds a localimport scala.concurrent.Future - override def completion, inside a class/object/trait, complete
def @@and it shows methods that can be overridden by the superclass
class Main {
// should show "override def toString(): String` along with hashCode, equals, ...
def @@
}- named argument completion,
assert(true, mess@@)should completemessage = - snippet completion, completing a method like
assert@@should move the cursor inside parentheses likeassert(@@) - completion item resolution, Java method parameters should not have names like
x$1, for example"".substrin@@should displaysubstring(beginIndex: Int, endIndex: Int): Stringinstead ofsubstring(x$1: Int, x$2: Int): String. I suspect this won't work in Vim or Sublime, you may need to trigger a command in Emacs. - string literal into interpolator completion, try completing a variable name inside a plain literal
locally {
val susan = "Susan"
"Hello $susa@@" // should complete into s"Hello $susan"
}- string literal member into curly brace completion, try completing a type member name of a spliced identifier inside a string interpolator
locally {
val numbers = List(1)
s"Hello $numbers.head@@" // should complete into s"Hello ${numbers.head}"
}- completion sorting, validate the sorting is not alphabetical
Option(1) match {
case S@@ // Should suggest `Some` at the top, not `Seq`
}- trigger characters, typing
Predef.@@should trigger completion. - exhaustive match completion, completing on a sealed type should propose a "match (exhaustive)` completion
// before
Option(1) match@@
// after
Option(1) match {
case None => @@
case Some(value) =>
}- case completion, completing on the case keyword should suggest valid types
List(Option(1)).map {
case@@ // should suggest "case None =>` and `case Some(value) =>`Server configuration
-Dmetals.signature-help.command: a command ID to automatically trigger signature help (parameter hints) when a completion snippet moves the cursor into parenthesesassert(@@). In VS Code, this value is"editor.action.triggerParameterHints".-Dmetals.completion.command: a command ID to trigger a follow-up completion in the editor after selecting certain completions. In VS Code, this value is"editor.action.triggerSuggest".-Dmetals.override-def-format: valid values areascii(default) orunicode. If set to unicode, then Metals uses the symbols ⏫ and 🔼 instead of "override def" and "def" to save horizontal space in the UI.
Hover (aka. show type at point)
In LSP, it's called textDocument/hover but in the editor it may be called
something else.
- markdown rendering,
Option(1).ma@@p(_ + 1)should appear like this
- range highlighting, observe in the screenshot above how
.map(_.toString)is not highlighted
Server configuration
-Dmetals.hover.documentation: a booleantrue(default) orfalse. If set to false, then the docstring is left empty, which can be desirable if you only care about seeing the expression type and symbol signature.
Signature help (aka. parameter hints)
In LSP, it's called textDocument/signatureHelp but in the editor it may be
called something else.
- when inside a parameter list, you should see the signature of the method
- active parameter, the currently active argument should be highlighted.
Example,
y: Intin the image above. - overloaded methods, all overloads should be displayed. Example,
math.maxhas four overloads that can be cycled through by clicking the up/down arrows in the image above. - trigger character, typing
(should automatically trigger signature help. - docstrings for active parameter and method symbol should be displayed.
Server configuration
-Dmetals.signature-help.documentation: a booleantrue(default) orfalse. If set to false, then the docstring is left empty, which can be desirable if you only care about seeing the symbol signature.
Folding ranges
In LSP, it's called textDocument/foldingRange but in the editor it may be
called something else.
- code folding, for example you can fold large multiline strings
- import folding, for example you can fold large groups of imports
- comment folding, for example you can fold large groups of single-line comments
Document highlight
In LSP, it's called textDocument/documentHighlight but in the editor it may be
called something else.
- triggering document highlight on a variable should highlight all occurrences of that symbol in the current file
JesusMtnez
Atry
ivanopagano
gabro
gvolpe
ceedubs
coreyoconnor
cb372
tdroxler
A lot has happened since the last stable release. Before releasing v0.5, we should update the website to document new functionality such as
In particular, we should validate all the features work reliably in the supported editors (vim, emacs, sublime, atom).