LuaLS / LuaLS/lua-language-server

When using alias values as its keys, Dictionary types don't give completion when defining an instance of that dictionary

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

还没有人认领这个 Issue。

主要语言
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?

Linux

What is the issue affecting?

Completion

Expected Behaviour

When trying to define a table annotated with ---@type {[an_alias]: a_type}, beginning to type a key in the table brings up an_alias's values for automatic completion.

Actual Behaviour

When trying to define a table annotated with ---@type {[an_alias]: a_type}, beginning to type a key in the table will not bring up an_alias's values.

Reproduction steps

Enter the following:

---@alias Flavor
---| "sweet"
---| "spicy"
---| "tangy"
---| "juicy"
---| "tough"
---| "gummy"


---@type {[Flavor]: number}
local test = {

}

Try typing "s" into the empty line in the test table, and it should be able to tell that you'd like to type sweet or spicy because those are members of the Flavor alias, but it does not. It recognizes those words as words found elsewhere in the document and will display them in the autocompletion dropdown as such (below other words found elsewhere in the document that also start with "s"), as shown in this screenshot of a larger file:
image

This might not be the best of examples because there are no other words that start with "s" in the code, but hopefully the issue is still clear. Adding other things (defining variables, using strings, what not) that start with "s" into the example code will give a result like my screenshot.

Additional Notes

I've tried to make this work with the ---@class annotation, and it behaves how I'd expect (the autocompletion dropdown's first results are field names on that class), but it brings up another issue: I'm trying to iterate through an instance of the class, and I don't get the correct return types when using functions like pairs. That makes sense to me - an object is probably not meant to be iterated through, because it likely has fields of different types.

I'm running into this issue because I'm trying to define a dictionary, i.e. a collection of fields that do have the same type. I know all of the names of the fields beforehand, and I define them in an alias. It seems to me that the language server should be able to recognize when I begin typing one of the alias's values in a table that's being defined as a dictionary with that alias as its keys.

Log File

No response

贡献指南

打开贡献指南

从这里开始

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

调研方向

首先,使用 issue 中所示的 Flavor 别名和 ---@type {[Flavor]: number} 表复现补全行为。跟踪带注解字典表中键的补全入口点,并将其与类字段补全进行比较;当输入键时,别名值(如 sweetspicy)会被优先显示,即表示完成。

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

评估

技术栈
lua
领域
tooling
Issue 类型
缺陷
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 发到你的邮箱

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