LuaLS / LuaLS/lua-language-server

Swap Params codeAction breaks code

Aperta
#3,413 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Lua
Stelle
4.4k
Fork
442
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

### How are you using the lua-language-server?

NeoVim

### Which OS are you using?

MacOS

### What is the issue affecting?

Formatting

### Expected Behaviour

Write lua code in neovim with codeActions triggered on buffer save. The lua code looks like the following:
```lua
vim.api.nvim_create_autocmd('BufWritePre', {})
```
and save, it will remain unchanged.

### Actual Behaviour

It changes the code to the following:
```lua
vim.api.nvim_create_autocmd({}, 'BufWritePre')
```

### Reproduction steps

1. Install lua-language-server
2. Setup lua lsp in neovim (can expand if needed)
3. Add the following autocmd to run codeactions on save
```lua
vim.api.nvim_create_autocmd('BufWritePre', {
group = vim.api.nvim_create_augroup('auto-format', { clear = false }),
buffer = ev.buf,
callback = function(evt)
local params = vim.lsp.util.make_range_params()
params.context = { }
local result = vim.lsp.buf_request_sync(evt.buf, "textDocument/codeAction", params)
for _, res in pairs(result or {}) do
for _, r in pairs(res.result or {}) do
if r.edit then
local enc = client.offset_encoding or "utf-16"
vim.lsp.util.apply_workspace_edit(r.edit, enc)
end
end
end

vim.lsp.buf.format({ bufnr = ev.buf, id = client.id, timeout_ms = 1000, async = false })
end,
})
```
4. Write some lua code and save that lua code with the cursor still on the same line.
5.

### Additional Notes

I was editing my neovim config and the lsp kept switching params like the following:
```lua
vim.api.nvim_create_autocmd('BufWritePre', {})
```
And after my PreWrite autocmd calls codeActions
```lua
vim.api.nvim_create_autocmd({}, 'BufWritePre')
```
which immediately breaks the code because the params are position sensitive.

It only does this if the cursor is on the line of the method call which I suppose makes sense since the code action is called with a range. My full autocmd works like this:
```lua
vim.api.nvim_create_autocmd('BufWritePre', {
group = vim.api.nvim_create_augroup('auto-format', { clear = false }),
buffer = ev.buf,
callback = function(evt)
local params = vim.lsp.util.make_range_params()
params.context = { }
local result = vim.lsp.buf_request_sync(evt.buf, "textDocument/codeAction", params)
for _, res in pairs(result or {}) do
for _, r in pairs(res.result or {}) do
if r.edit then
local enc = client.offset_encoding or "utf-16"
vim.lsp.util.apply_workspace_edit(r.edit, enc)
end
end
end

vim.lsp.buf.format({ bufnr = ev.buf, id = client.id, timeout_ms = 1000, async = false })
end,
})
```

I narrowed it down to this code action here https://github.com/LuaLS/lua-language-server/blob/b5e57c36a9a27b89eb283861fb8946fa787e37d8/script/core/code-action.lua#L462

Maybe I am holding it wrong and it is not supposed to be used in this way but I don't have a problem with other LSPs.

### Log File

No log entry was added during this behaviour.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia riproducendo il problema in NeoVim con le azioni di codice attivate al salvataggio, usando l’esempio di argomento posizionale del report. Poi esamina script/core/code-action.lua intorno alla riga 462 e segui la modifica «Swap Params»; il lavoro è completato quando l’esempio rimane invariato dopo l’esecuzione dell’azione di codice.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
lua, neovim
Ambito
devtools, tooling
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Tranquilla
Chiarezza
Specificata chiaramente
Idoneità per principianti
68/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.