LuaLS / LuaLS/lua-language-server

missing-fields ignores fields set post-assignment

Open
#2,293 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?

Windows

What is the issue affecting?

Diagnostics/Syntax Checking

Expected Behaviour

Assigning a table to a variable with @type annotation and filling out the class's fields and functions afterwards should not trigger missing-fields.

Actual Behaviour

A missing-fields diagnostic is triggered despite fields being set after the initial assignment of the variable yet before the variable is used for anything.
image

Reproduction steps

Small script that replicates the issue:

---@class MyInterface
---@field DoAction fun()

---@type MyInterface
local inst = {}

-- Does not remove `missing-fields` diagnostic
inst.DoAction = function() end

missing-fields will trigger on inst.

Additional Notes

No response

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

Start with the Lua reproduction in the issue and trace the missing-fields diagnostic for a typed table whose field is assigned after initialization. Confirm the behavior in the Visual Studio Code extension on Windows; done means the post-assignment field no longer produces a missing-fields diagnostic before the variable is used.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.