LuaLS / LuaLS/lua-language-server

能够生成文件本地的注释么?就像lua本身的local一样

未关闭
#854 2 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

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

描述

image
如上图,我这个文件里并没有定义Enum,但是其他文件中有定义Enum,这样构成了冲突。

另外,想问下能不能,当我local xxx = require "xxx"了之后,就导入所有xxx文件里的结构。
举个例子
在a.lua里

---@alias Enum
---| 'Enum.ZERO' # = 0
---| 'Enum.ONE' # = 1
---| 'Enum.TWO' # = 2

在b.lua里

local aa = require "a"
---@type aa.Enum
local x

然后这时候如果我输入x = ,弹出来的提示是aa.Enum.ZERO | aa.Enum.ONE | aa.Enum.TWO

插件版本
image

贡献指南

打开贡献指南

从这里开始

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

调研方向

使用 issue 中的 a.lua 和 b.lua 示例重现该请求,首先处理 language server 对文件局部注解的处理以及 require 解析。payload 未指定源文件或测试,因此请先定位相关实现和现有覆盖范围。当不同文件中的定义不再发生冲突,且 aa.Enum 的补全提供所列出的 Enum 值时,即表示完成。

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

评估

技术栈
lua
领域
devtools
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
25/100

把新 issue 发到你的邮箱

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