textDocument/documentSymbol in Metals LSP does not return case class fields as symbols

[YuMuuu]

version: metals_2.13:1.6.2

In Metals LSP, case class fields are not returned as symbols.

How to reproduce

Clone the following repository:

https://github.com/YuMuuu/serena-issue-688

Build and run Metals:

$ cs bootstrap org.scalameta:metals_2.13:1.6.3 -o metals -f
$ ./metals

Send the following LSP requests and observe the responses:

Content-Length: 241^M
{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"processId":12345,"rootUri":"file:///Users/miurayu/ghq/github.com/YuMuuu/serena-issue-688","capabilities":{},"initializationOptions":{"statusBarProvider":"on","doctorProvider":"json"}}}

~~~
Content-Length: 206^M
{"jsonrpc":"2.0","id":2,"method":"textDocument/documentSymbol","params":{"textDocument":{"uri":"file:///Users/miurayu/ghq/github.com/YuMuuu/serena-issue-688/src/main/scala/some/somepackage/SomeApp.scala"}}}
Content-Length: 205
{"jsonrpc":"2.0","id":2,"result":[{"name":"some.somepackage","kind":4,"location":{"uri":"file:///Users/miurayu/ghq/github.com/YuMuuu/serena-issue-688/src/main/scala/some/somepackage/SomeApp.scala","range":{"start":{"line":0,"character":0},"end":{"line":10,"character":1}}},"containerName":""},{"name":"SomeApp","kind":2,"location":{"uri":"file:///Users/miurayu/ghq/github.com/YuMuuu/serena-issue-688/src/main/scala/some/somepackage/SomeApp.scala","range":{"start":{"line":2,"character":0},"end":{"line":10,"character":1}}},"containerName":"some/somepackage/"},{"name":"Config","kind":5,"location":{"uri":"file:///Users/miurayu/ghq/github.com/YuMuuu/serena-issue-688/src/main/scala/some/somepackage/SomeApp.scala","range":{"start":{"line":3,"character":2},"end":{"line":3,"character":35}}},"containerName":"some/somepackage/SomeApp."},{"name":"someMethod","kind":6,"location":{"uri":"file:///Users/miurayu/ghq/github.com/YuMuuu/serena-issue-688/src/main/scala/some/somepackage/SomeApp.scala","range":{"start":{"line":5,"character":2},"end":{"line":9,"character":3}}},"containerName":"some/somepackage/SomeApp."},{"name":"str","kind":14,"location":{"uri":"file:///Users/miurayu/ghq/github.com/YuMuuu/serena-issue-688/src/main/scala/some/somepackage/SomeApp.scala","range":{"start":{"line":6,"character":4},"end":{"line":6,"character":43}}},"containerName":"some/somepackage/SomeApp.someMethod."}]}

As you can see from this result, the response does not include the symbol for field1.

As a use case, I want to use the position of a symbol obtained via textDocument/documentSymbol to call textDocument/references and retrieve its references. From this perspective, it would be more convenient if case class fields were also returned as symbols.

If my understanding is incorrect, I apologize.

Thank you.

[tgodzik]

I think we should include those symbols, fixing it in #7953

I am now also wondering about method parameters, but not sure. We certainly do not want to overwhelm the user, but maybe we can show more.

[YuMuuu]

Thank you for your response. I am very grateful.