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 摘要。