diag missing-return

Author: sumneko

changelog.md

@@ -9,6 +9,7 @@
   * `cast-type-mismatch`
   * `missing-return-value`
   * `redundant-return-value`
+  * `missing-return`
 * `NEW` settings:
   * `diagnostics.groupSeverity`
   * `diagnostics.groupFileStatus`

locale/zh-cn/script.lua

@@ -136,6 +136,8 @@ DIAG_REDUNDANT_RETURN_VALUE           =
 '最多只有 {max} 个返回值，但此处返回了第 {rmax} 个值。'
 DIAG_REDUNDANT_RETURN_VALUE_RANGE     =
 '最多只有 {max} 个返回值，但此处返回了第 {rmin} 到第 {rmax} 个值。'
+DIAG_MISSING_RETURN                   =
+'此处需要返回值。'
 
 MWS_NOT_SUPPORT         =
 '{} 目前还不支持多工作目录，我可能需要重启才能支持新的工作目录...'

script/config/config.lua

@@ -38,7 +38,7 @@ local function getScope(uri, key)
         end
     end
     if uri then
-        ---@type scope
+        ---@type scope?
         local scp = scope.getFolder(uri) or scope.getLinkedScope(uri)
         if scp then
             if not key

script/core/completion/completion.lua

@@ -1133,7 +1133,6 @@ local function cleanEnums(enums, source)
     return enums
 end
 
----@return boolean
 local function insertEnum(state, src, enums, isInArray)
     if src.type == 'doc.type.string'
     or src.type == 'doc.type.integer'

script/core/diagnostics/missing-return.lua

@@ -0,0 +1,84 @@
+local files  = require 'files'
+local guide  = require 'parser.guide'
+local vm     = require 'vm'
+local lang   = require 'language'
+
+---@param uri uri
+---@param func parser.object
+local function hasDocReturn(uri, func)
+    if not func.bindDocs then
+        return false
+    end
+    for _, doc in ipairs(func.bindDocs) do
+        if doc.type == 'doc.return' then
+            -- don't need return with only one `any`
+            local lastReturn = doc.returns[#doc.returns]
+            if lastReturn.returnIndex ~= 1
+            or vm.getInfer(lastReturn):view(uri) ~= 'any' then
+                return true
+            end
+        end
+    end
+    return false
+end
+
+---@param block parser.object
+---@return boolean
+local function hasReturn(block)
+    if block.hasReturn or block.hasError then
+        return true
+    end
+    if block.type == 'if' then
+        local hasElse
+        for _, subBlock in ipairs(block) do
+            if not hasReturn(subBlock) then
+                return false
+            end
+            if subBlock.type == 'elseblock' then
+                hasElse = true
+            end
+        end
+        return hasElse == true
+    else
+        if block.type == 'while' then
+            if vm.testCondition(block.filter) then
+                return true
+            end
+        end
+        for _, action in ipairs(block) do
+            if guide.isBlockType(action) then
+                if hasReturn(action) then
+                    return true
+                end
+            end
+        end
+    end
+    return false
+end
+
+return function (uri, callback)
+    local state = files.getState(uri)
+    if not state then
+        return
+    end
+
+    guide.eachSourceType(state.ast, 'function', function (source)
+        -- check declare only
+        if #source == 0 then
+            return
+        end
+        if not hasDocReturn(uri, source) then
+            return
+        end
+        if hasReturn(source) then
+            return
+        end
+        local lastAction = source[#source]
+        local finish = lastAction.range or lastAction.finish
+        callback {
+            start   = finish,
+            finish  = finish,
+            message = lang.script('DIAG_MISSING_RETURN'),
+        }
+    end)
+end

script/lclient.lua

@@ -80,7 +80,6 @@ function mt:reportHangs()
 end
 
 ---@param callback async fun(client: languageClient)
----@return languageClient
 function mt:start(callback)
     CLI = true
 

script/parser/compile.lua

@@ -2833,7 +2833,8 @@ local function compileExpAsAction(exp)
                 local block = Chunk[i]
                 if block.type == 'ifblock'
                 or block.type == 'elseifblock'
-                or block.type == 'else' then
+                or block.type == 'elseblock'
+                or block.type == 'function' then
                     block.hasError = true
                     break
                 end
@@ -2986,7 +2987,8 @@ local function parseReturn()
         local block = Chunk[i]
         if block.type == 'ifblock'
         or block.type == 'elseifblock'
-        or block.type == 'else' then
+        or block.type == 'elseblock'
+        or block.type == 'function' then
             block.hasReturn = true
             break
         end

script/parser/guide.lua

@@ -1276,4 +1276,10 @@ function m.isBasicType(str)
     return basicTypeMap[str] == true
 end
 
+---@param source parser.object
+---@return boolean
+function m.isBlockType(source)
+    return blockTypes[source.type] == true
+end
+
 return m

script/proto/diagnostic.lua

@@ -60,6 +60,7 @@ m.register {
     'missing-parameter',
     'missing-return-value',
     'redundant-return-value',
+    'missing-return',
 } {
     group    = 'unbalanced',
     severity = 'Warning',

script/pub/pub.lua

@@ -136,8 +136,6 @@ function m.task(name, params, callback)
 end
 
 --- 接收反馈
---- 返回接收到的反馈数量
----@return integer
 function m.recieve(block)
     if block then
         local id, name, result = waiter:bpop()