vim.lsp.buf.format() invalidates changes list

[Baehn]

Describe the bug

I noticed that with some language servers (e.g. sumneko_lua) after calling vim.lsp.buf.format() entries in :changes are marked as invalid (-invalid-). This only seems to happen for lsp's sending the whole formatted document as response instead of actual text edits.

Steps to reproduce

1. open new lua file with attached lsp "sumneko_lua"
2. insert two lines:

print("1")
print("2")

3. :lua vim.lsp.buf.format()
4. open changes list with :changes

Expected behavior

calling :changes should result in

change line  col text
    2     1    9 print("1")
    1     2    7 print("2")
>

but instead shows

change line  col text
    3     1    9 print("1")
    2     1    0 print("1")
    1     3    0 -invalid-
>

Neovim version (nvim -v)

v0.9.0-dev-581+gcb9d68fe6

Vim (not Nvim) behaves the same?

na

Operating system/version

5.15.0-10056-tuxedo

Terminal name/version

konsole 21.12.3

$TERM environment variable

xterm-256color

Installation

build from repo

[Baehn]

other vim features are affected too:

• jumplist: all entries are collapsed to the first line in buffer
• marks: all lowercase entries are removed
• extmarks: all entries are collapsed to last line

[justinmk]

only seems to happen for lsp's sending the whole formatted document as response instead of actual text edits.

what can we do about that?

[Baehn]

what can we do about that?

you don't think that this is something neovim should handle? Looking at the lsp specification I'm not sure if this is actually prohibited. For example, one could compute the actual diff to the current buffer and then apply this as text edits.

[justinmk]

For example, one could compute the actual diff to the current buffer and then apply this as text edits.

i mean yeah we could do that, or ... the language server could do that, since that is its job 😏

[marconetto]

I noticed that if I use vim.lsp.buf.format in a lua file, the marks disappear. I found this issue and if I understood correctly there is a limitation in the lua language server---which indeed I don't have issues with python and other language servers.

I'm wondering if there is any suggestion of a temporary workaround to avoid having the marks disappear for lua files when running the autoformating?

EDIT:
I found this plugin which seems to solve the issue:
https://github.com/stevearc/conform.nvim
"Diffs the format results and applies the changes using the same utilities as LSP formatting. This preserves extmarks, folds, and cursor/window position."