LuaLS / LuaLS/lua-language-server

Automatic doc generation builds incorrectly assumingly large types as a return value

未關閉
#1,617 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

enhancement
主要語言
Lua
星號
4.4k
分支
442
PR 合併指標
30 天內沒有已合併 PR

描述

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

Visual Studio Code Extension (sumneko.lua)

### Which OS are you using?

Windows

### What is the issue affecting?

Annotations, Completion

### Expected Behaviour

```lua
---comment
---@param value any
---@return "boolean"|"function"|"nil"|"number"|"string"|"table"|"userdata"|"thread"
local function myAwesomeFunction(value)
return type(value)
end
```

### Actual Behaviour

```lua
---comment
---@param value any
---@return "boolean"|"function"|"nil"|"number"|"string"...(+3)
local function myAwesomeFunction(value)
return type(value)
end
```

### Reproduction steps

Copy the code
```lua
---
local function myAwesomeFunction(value)
return type(value)
end
```
execute autocompletion from `---`.

### Additional Notes

Probably not a very important issue.

### Log File

_No response_

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

使用 Lua 範例在 Visual Studio Code 擴充功能中重現此問題,並從 `---` 觸發自動完成。將產生的 `---@return` 註解與預期行為中顯示的完整 union 進行比較;當較大的回傳型別不再使用 `...(+3)` 縮寫時,即表示完成。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
lua, vscode
領域
devtools
Issue 類型
缺陷
難度
3/5
預估耗時
1-2 天
活躍度
停滯
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。