summaryrefslogtreecommitdiff
path: root/script/core/diagnostics/helper/missing-doc-helper.lua
blob: 3b953b86e7a1e5b241f3d51f453175564ab9d7a0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
local lang    = require 'language'

local m = {}

local function findParam(docs, param)
    if not docs then
        return false
    end

    for _, doc in ipairs(docs) do
        if doc.type == 'doc.param' then
            if doc.param[1] == param then
                return true
            end
        end
    end

    return false
end

local function findReturn(docs, index)
    if not docs then
        return false
    end

    for _, doc in ipairs(docs) do
        if doc.type == 'doc.return' then
            for _, ret in ipairs(doc.returns) do
                if ret.returnIndex == index then
                    return true
                end
            end
        end
    end

    return false
end

local function checkFunction(source, callback, commentId, paramId, returnId)
    local functionName = source.parent[1]
    local argCount = source.args and #source.args or 0

    if argCount == 0 and not source.returns and not source.bindDocs then
        callback {
            start   = source.start,
            finish  = source.finish,
            message = lang.script(commentId, functionName),
        }
    end

    if argCount > 0 then
        for _, arg in ipairs(source.args) do
            local argName = arg[1]
            if argName ~= 'self' then
                if not findParam(source.bindDocs, argName) then
                    callback {
                        start   = arg.start,
                        finish  = arg.finish,
                        message = lang.script(paramId, argName, functionName),
                    }
                end
            end
        end
    end

    if source.returns then
        for _, ret in ipairs(source.returns) do
            for index, expr in ipairs(ret) do
                if not findReturn(source.bindDocs, index) then
                    callback {
                        start   = expr.start,
                        finish  = expr.finish,
                        message = lang.script(returnId, index, functionName),
                    }
                end
            end
        end
    end
end

m.CheckFunction = checkFunction
return m