LuaLS / LuaLS/lua-language-server

Swap Params codeAction breaks code

未关闭
#3,413 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
Lua
星标
4.4k
派生
442
PR 合并指标
30 天内没有已合并 PR

描述

### 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.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先,使用报告中的位置参数示例,在保存时触发代码操作的 NeoVim 中重现该问题。然后检查第 462 行附近的 script/core/code-action.lua,并跟踪 Swap Params 编辑;代码操作运行后示例保持不变即表示完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
lua, neovim
领域
devtools, tooling
Issue 类型
缺陷
难度
3/5
预计耗时
1-2 天
活跃度
冷清
描述清晰度
描述清楚
新手友好度
68/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。