new diagnostic: `missing-fields`

2 files changed, 73 insertions, 0 deletions

diff --git a/script/core/diagnostics/missing-fields.lua b/script/core/diagnostics/missing-fields.lua
new file mode 100644
index 00000000..e23352bc
--- /dev/null
+++ b/script/core/diagnostics/missing-fields.lua
@@ -0,0 +1,72 @@
+local vm    = require 'vm'
+local files = require 'files'
+local guide = require 'parser.guide'
+local await = require 'await'
+
+---@async
+return function (uri, callback)
+    local state = files.getState(uri)
+    if not state then
+        return
+    end
+
+    ---@async
+    guide.eachSourceType(state.ast, 'table', function (src)
+        await.delay()
+
+        local defs = vm.getDefs(src)
+        local requiresKeys = {}
+        for _, def in ipairs(defs) do
+            if def.type == 'doc.class' then
+                if not def.fields then
+                    goto continue
+                end
+                if def.bindSource then
+                    if guide.isInRange(def.bindSource, src.start) then
+                        goto continue
+                    end
+                end
+                for _, field in ipairs(def.fields) do
+                    if  not field.optional
+                    and not vm.compileNode(field):isNullable() then
+                        local key = vm.getKeyName(field)
+                        if key and not requiresKeys[key] then
+                            requiresKeys[key] = true
+                            requiresKeys[#requiresKeys+1] = key
+                        end
+                    end
+                end
+            end
+            ::continue::
+        end
+
+        if #requiresKeys == 0 then
+            return
+        end
+
+        local myKeys = {}
+        for _, field in ipairs(src) do
+            local key = vm.getKeyName(field)
+            if key then
+                myKeys[key] = true
+            end
+        end
+
+        local missedKeys = {}
+        for _, key in ipairs(requiresKeys) do
+            if not myKeys[key] then
+                missedKeys[#missedKeys+1] = ('`%s`'):format(key)
+            end
+        end
+
+        if #missedKeys == 0 then
+            return
+        end
+
+        callback {
+            start   = src.start,
+            finish  = src.finish,
+            message = string.format('Missing fields: %s', table.concat(missedKeys, ', ')),
+        }
+    end)
+end
diff --git a/script/proto/diagnostic.lua b/script/proto/diagnostic.lua
index 8175a2c5..9c095531 100644
--- a/script/proto/diagnostic.lua
+++ b/script/proto/diagnostic.lua
@@ -62,6 +62,7 @@ m.register {
     'missing-return-value',
     'redundant-return-value',
     'missing-return',
+    'missing-fields',
 } {
     group    = 'unbalanced',
     severity = 'Warning',