LuaLS / lua-language-server

A language server that offers Lua language support - programmed in Lua
https://luals.github.io
MIT License
3.25k stars 305 forks source link

Table literals aren't properly checked for field injections and missing fields #2802

Open Calandiel opened 3 weeks ago

Calandiel commented 3 weeks ago

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?

Type Checking

Expected Behaviour

I'd expect tables created in the return statement to check for missing fields, and those created outside of them to check for injected fields.

Actual Behaviour

There are no warnings emitted for the attached code.

Reproduction steps

Code to reproduce the issue:

---@class Tile
---@field name string

local Tile = {}

---@return Tile
function Tile.new()
    ---@type Tile
    local d = {
        name = 'abc',
        f = 10 -- No warning when a field is being injected
    }

    return {
        f = 10 -- No warning even though there's a missing field and a field is being injected
    }
end

Note that it won't produce any warnings, regardless of configuration (as far as I can tell).

Additional Notes

No response

Log File

No response

tomlau10 commented 3 weeks ago

The checking of return-type-mismatch for table literal is added recently in https://github.com/LuaLS/lua-language-server/pull/2768. But seems it is too strict so it is disabled by default. You have to enable it by using "type.checkTableShape": true in your .luarc.json or whatever settings file that you used.

But, only half of the problem is solved 😂 . Because it only checks for missing fields but not extra fields


As for the inject field check, there seems to be some similar issues: