LuaLS / LuaLS/lua-language-server

Suggestion: Make `@param;@return` available as code action

未關閉
#2,517 0 則留言 3 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

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

描述

One really nice feature of the lua-lsp is that by typing `---` above a function, we get the `@param;@return` suggestions which auto-inserts function annotation.

Would it be possible to make this feature available via code action as well? Right now, it takes a bit of repetitive work to get the annotations inserted. When at the function head: `up`, `-`. `-`, `-`, `enter`. By using a code action, this could be reduced to one hotkey (and depending on your editor, maybe one extra `enter`).

Another benefit would be that making this available as code action would increase the discoverability of this feature. For a while, I didn't know that this very useful feature even existed. By being a code action, it would be far easier to discover for new users.

貢獻指南

開啟貢獻指南

從這裡開始

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

研究方向

首先追蹤由 `---` 觸發、用來插入 `@param` 和 `@return` 註解的現有建議,然後檢查 language server 在哪裡提供程式碼動作。完成的標準是:可以透過程式碼動作執行相同的註解插入,並且在函式標頭處仍然可以發現這項功能。

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

評估

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

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

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