LuaLS / LuaLS/lua-language-server

Indexing a table by an enum's value

Open
#2,410 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lua
Stars
4.4k
Forks
442
PR merge metrics
No merged PRs in 30d

Description

### 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?

Diagnostics/Syntax Checking

### Expected Behaviour

Types defined with an enum as their key should be accessible via both the runtime enum itself and the value they represent.

### Actual Behaviour

A type defined with an enum as its key cannot be accessed with the enum's value.

### Reproduction steps

```
---@enum building_id
local building_id = {
ANY = -1,
ONE = 0,
TWO = 1,
}

---@type { [building_id]: { name: string } }
local building_attributes = {}

local anyName = building_attributes[building_id.ANY].name // Typed as "string"
local anyName = building_attributes[-1].name // Typed as "unknown"
```

### Additional Notes

### Discussed in https://github.com/LuaLS/lua-language-server/discussions/2402

### Log File

_No response_

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the diagnostics issue in the provided Lua example, beginning with enum key handling in the language server's type-checking path. Compare access through building_id.ANY with access through -1, and use the discussion linked in the issue for context; done means both forms resolve the table value as { name: string } rather than unknown.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
devtools
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.