Shall we set include_current to true by default in lsp_definitions and lsp_references?

[liancheng]

I'm developing a language server and using Neovim/LazyVim for testing. I noticed that when a definition and its reference are on the same line, neither lsp_definitions nor lsp_references could find any results.

This can be easily reproduced by creating the following Lua file test.lua:

local x = 0; print(x)

Moving the cursor to the first x and pressing gr doesn't bring me to the second x. (My language server is for Jsonnet, but I believe this issue applies to all LS.)

I thought my language server was buggy, but later, I realized this was due to include_current set to false by default. Flipping it to true for both pickers fixed this behavior.

The semantics of the include_current option isn't documented in picker.md. IIUC, it means "include the current line in the picker result". Shall we turn it to true by default for lsp_definitions and lsp_references?

[drowning-cat]

I mean, if you're searching for definitions or references, doesn't that usually mean you're not looking for the one your cursor is already on?

Similar discussion: #1857 (comment)

[liancheng]

I think it's a bit different? When I press gd when the cursor is on the 2nd x, I expect the cursor to jump to the 1st x.

[liancheng]

The following example might illustrate the problem better:

local x = 1; print(x)
print(x)

When pressing gr when the cursor is on the first x on line 1, the cursor jumps directly to the x on line 2. But this file contains 2 references to the local variable x.