also check doc.type.table

LuaLS · Aug 14, 2023 · 01a741f · 01a741f
1 parent 63edb99
commit 01a741f
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 5 deletions.
diff --git a/locale/en-us/script.lua b/locale/en-us/script.lua
@@ -171,7 +171,11 @@ DIAG_GLOBAL_ELEMENT                   =
 DIAG_MISSING_FIELDS                   =
 'Missing fields: {}'
 DIAG_INJECT_FIELD                     =
-'Fields cannot be injected into the reference of `{class}` for `{field}`. To do so, use `---@class` for `{node}`.'
+'Fields cannot be injected into the reference of `{class}` for `{field}`. {fix}'
+DIAG_INJECT_FIELD_FIX_CLASS           =
+'To do so, use `---@class` for `{node}`.'
+DIAG_INJECT_FIELD_FIX_TABLE           = -- TODO: need translate!
+'如要允许注入，请在定义中添加 `{fix}` 。'
 
 MWS_NOT_SUPPORT         =
 '{} does not support multi workspace for now, I may need to restart to support the new workspace ...'

diff --git a/locale/pt-br/script.lua b/locale/pt-br/script.lua
@@ -171,7 +171,11 @@ DIAG_GLOBAL_ELEMENT                  = -- TODO: need translate!
 DIAG_MISSING_FIELDS                   = -- TODO: need translate!
 'Missing fields: {}'
 DIAG_INJECT_FIELD                     = -- TODO: need translate!
-'Fields cannot be injected into the reference of `{class}` for `{field}`. To do so, use `---@class` for `{node}`.'
+'Fields cannot be injected into the reference of `{class}` for `{field}`. {fix}'
+DIAG_INJECT_FIELD_FIX_CLASS           = -- TODO: need translate!
+'To do so, use `---@class` for `{node}`.'
+DIAG_INJECT_FIELD_FIX_TABLE           = -- TODO: need translate!
+'如要允许注入，请在定义中添加 `{fix}` 。'
 
 MWS_NOT_SUPPORT         =
 '{} não é suportado múltiplos espaços de trabalho por enquanto, posso precisar reiniciar para estabelecer um novo espaço de trabalho ...'

diff --git a/locale/zh-cn/script.lua b/locale/zh-cn/script.lua
@@ -171,7 +171,11 @@ DIAG_GLOBAL_ELEMENT                   =
 DIAG_MISSING_FIELDS                   =
 '缺少字段： {}'
 DIAG_INJECT_FIELD                     =
-'不能在 `{class}` 的引用中注入字段 `{field}` 。如要这么做，请对 `{node}` 使用 `---@class` 。'
+'不能在 `{class}` 的引用中注入字段 `{field}` 。{fix}'
+DIAG_INJECT_FIELD_FIX_CLASS           =
+'如要允许注入，请对 `{node}` 使用 `{fix}` 。'
+DIAG_INJECT_FIELD_FIX_TABLE           =
+'如要允许注入，请在定义中添加 `{fix}` 。'
 
 MWS_NOT_SUPPORT         =
 '{} 目前还不支持多工作目录，我可能需要重启才能支持新的工作目录...'

diff --git a/locale/zh-tw/script.lua b/locale/zh-tw/script.lua
@@ -171,7 +171,11 @@ DIAG_GLOBAL_ELEMENT                  = -- TODO: need translate!
 DIAG_MISSING_FIELDS                   = -- TODO: need translate!
 'Missing fields: {}'
 DIAG_INJECT_FIELD                     = -- TODO: need translate!
-'Fields cannot be injected into the reference of `{class}` for `{field}`. To do so, use `---@class` for `{node}`.'
+'Fields cannot be injected into the reference of `{class}` for `{field}`. {fix}'
+DIAG_INJECT_FIELD_FIX_CLASS           = -- TODO: need translate!
+'To do so, use `---@class` for `{node}`.'
+DIAG_INJECT_FIELD_FIX_TABLE           = -- TODO: need translate!
+'如要允许注入，请在定义中添加 `{fix}` 。'
 
 MWS_NOT_SUPPORT         =
 '{} 目前還不支援多工作目錄，我可能需要重新啟動才能支援新的工作目錄...'

diff --git a/script/core/diagnostics/inject-field.lua b/script/core/diagnostics/inject-field.lua
@@ -47,12 +47,28 @@ return function (uri, callback)
             if dnode and vm.getDefinedClass(uri, dnode) then
                 return
             end
+            if def.type == 'doc.type.field' then
+                return
+            end
+        end
+
+        local howToFix = lang.script('DIAG_INJECT_FIELD_FIX_CLASS', {
+            node = hname(node),
+            fix  = '---@class',
+        })
+        for _, ndef in ipairs(vm.getDefs(node)) do
+            if ndef.type == 'doc.type.table' then
+                howToFix = lang.script('DIAG_INJECT_FIELD_FIX_TABLE', {
+                    fix   = '[any]: any',
+                })
+                break
+            end
         end
 
         local message = lang.script('DIAG_INJECT_FIELD', {
             class = vm.getInfer(node):view(uri),
             field = guide.getKeyName(src),
-            node  = hname(node),
+            fix   = howToFix,
         })
         if     src.type == 'setfield' and src.field then
             callback {

diff --git a/test/diagnostics/inject-field.lua b/test/diagnostics/inject-field.lua
@@ -23,3 +23,19 @@ local m
 m.xx = 1 -- OK
 m.yy = 1 -- OK
 ]]
+
+TEST [[
+---@type { xx: number }
+local m
+
+m.xx = 1 -- OK
+m.<!yy!> = 1 -- Warning
+]]
+
+TEST [[
+---@type { xx: number, [any]: any }
+local m
+
+m.xx = 1 -- OK
+m.yy = 1 -- OK
+]]