LuaLS / LuaLS/lua-language-server

[Feature Request] @alias hover description / search for description

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

還沒有人認領這個 Issue。

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

描述

It would be really nice, to have a popup, when hovering over a @alias.

---@alias DeviceSide
---| '"left"' # The left side of the device
---| '"right"' # The right side of the device
---| '"top"' # The top side of the device
---| '"bottom"' # The bottom side of the device
---| '"front"' # The front side of the device
---| '"back"' # The back side of the device

---@param side DeviceSide
local function checkSide(side) end

Hover description
eg:

checkSide("left")

when hovering over "left", display a popup with the text: The left side of the device

Search for description
When beginning to type:

checkSide(left side

it would be great, if the IntelliSense would show the entry "left" -- The left side of the device

貢獻指南

開啟貢獻指南

從這裡開始

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

研究方向

首先追蹤 language server 如何處理 @alias 宣告、懸停資訊和 IntelliSense 搜尋建議。重現 DeviceSide 範例,並遵循在 "left" 上懸停以及搜尋 "left side" 時現有的路徑。完成的標準是,別名項目的懸停彈出視窗和以描述為基礎的建議都能正常運作。

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

評估

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

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

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