Merge pull request #3224 from tomlau10/fix/field-fallback-type

fix: typed `@field` should not override other defined field

Author: sumneko

changelog.md

@@ -2,6 +2,7 @@
 
 ## Unreleased
 <!-- Add all new changes here. They will be moved under a version at release -->
+* `FIX` Typed `@field` (eg `---@field [string] boolean`) should not override other defined field [#2171](https://github.com/LuaLS/lua-language-server/issues/2171), [#2711](https://github.com/LuaLS/lua-language-server/issues/2711)
 
 ## 3.15.0
 `2025-6-25`

script/vm/compiler.lua

@@ -434,44 +434,6 @@ function vm.getClassFields(suri, object, key, pushResult)
                         pushResult(field, true)
                         goto CONTINUE
                     end
-                    if hasFounded[key] then
-                        goto CONTINUE
-                    end
-                    local keyType = type(key)
-                    if keyType == 'table' then
-                        -- ---@field [integer] boolean -> class[integer]
-                        local fieldNode = vm.compileNode(field.field)
-                        if vm.isSubType(suri, key.name, fieldNode) then
-                            local nkey = '|' .. key.name
-                            if not searchedFields[nkey] then
-                                pushResult(field, true)
-                                hasFounded[nkey] = true
-                            end
-                        end
-                    else
-                        local keyObject
-                        if keyType == 'number' then
-                            if math.tointeger(key) then
-                                keyObject = { type = 'integer', [1] = key }
-                            else
-                                keyObject = { type = 'number', [1] = key }
-                            end
-                        elseif keyType == 'boolean'
-                        or     keyType == 'string' then
-                            keyObject = { type = keyType, [1] = key }
-                        end
-                        if keyObject and field.field.type ~= 'doc.field.name' then
-                            -- ---@field [integer] boolean -> class[1]
-                            local fieldNode = vm.compileNode(field.field)
-                            if vm.isSubType(suri, keyObject, fieldNode) then
-                                local nkey = '|' .. keyType
-                                if not searchedFields[nkey] then
-                                    pushResult(field, true)
-                                    hasFounded[nkey] = true
-                                end
-                            end
-                        end
-                    end
                     ::CONTINUE::
                 end
             end
@@ -547,6 +509,59 @@ function vm.getClassFields(suri, object, key, pushResult)
         end
         copyToSearched()
 
+        -- search for typed @field, eg: ---@field [string] boolean
+        -- only if type for this field key is not found
+        if not searchedFields[key] and key ~= vm.ANY and key ~= vm.ANYDOC then
+            for _, set in ipairs(sets) do
+                if set.type == 'doc.class' then
+                    for _, field in ipairs(set.fields) do
+                        local fieldKey = guide.getKeyName(field)
+                        if fieldKey then
+                            -- already processed above
+                            goto CONTINUE
+                        end
+                        local keyType = type(key)
+                        if keyType == 'table' then
+                            -- ---@field [integer] boolean -> class[integer]
+                            local fieldNode = vm.compileNode(field.field)
+                            if vm.isSubType(suri, key.name, fieldNode) then
+                                local nkey = '|' .. key.name
+                                if not searchedFields[nkey] then
+                                    pushResult(field, true)
+                                    hasFounded[nkey] = true
+                                end
+                            end
+                        else
+                            local keyObject
+                            if keyType == 'number' then
+                                if math.tointeger(key) then
+                                    keyObject = { type = 'integer', [1] = key }
+                                else
+                                    keyObject = { type = 'number', [1] = key }
+                                end
+                            elseif keyType == 'boolean'
+                            or     keyType == 'string' then
+                                keyObject = { type = keyType, [1] = key }
+                            end
+                            if keyObject and field.field.type ~= 'doc.field.name' then
+                                -- ---@field [integer] boolean -> class[1]
+                                local fieldNode = vm.compileNode(field.field)
+                                if vm.isSubType(suri, keyObject, fieldNode) then
+                                    local nkey = '|' .. keyType
+                                    if not searchedFields[nkey] then
+                                        pushResult(field, true)
+                                        hasFounded[nkey] = true
+                                    end
+                                end
+                            end
+                        end
+                        ::CONTINUE::
+                    end
+                end
+            end
+            copyToSearched()
+        end
+
         for _, set in ipairs(sets) do
             if set.type == 'doc.class' then
                 -- look into extends(if field not found)

test/type_inference/common.lua

@@ -3608,6 +3608,25 @@ local t
 local <?x?> = t.n
 ]]
 
+TEST 'function' [[
+---@class A
+---@field [string] boolean
+local t
+function t.f() end
+
+local <?f?> = t.f
+]]
+
+TEST 'function' [[
+---@class A
+---@field [string] boolean
+local t = {
+    f = function () end
+}
+
+local <?f?> = t.f
+]]
+
 TEST 'string' [[
 ---@class string
 ---@operator mod: string