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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
local parser = require 'parser'
local guide = require 'parser.guide'
local helper = require 'plugins.astHelper'
---@diagnostic disable: await-in-sync
---@param ... function checkers
local function TestPlugin(script, plugin, ...)
local state = parser.compile(script, "Lua", "Lua 5.4")
state.ast = plugin(TESTURI, state.ast) or state.ast
parser.luadoc(state)
for i = 1, select('#', ...) do
select(i, ...)(state)
end
end
local function isDocClass(ast)
return ast.bindDocs[1].type == 'doc.class'
end
local function TestAIsClass(state, next)
assert(isDocClass(state.ast[1]))
end
--- when call Class
local function plugin_AddClass(uri, ast)
guide.eachSourceType(ast, "call", function (source)
local node = source.node
if not guide.isGet(node) then
return
end
if not guide.isGlobal(node) then
return
end
if guide.getKeyName(node) ~= 'Class' then
return
end
local wants = {
['local'] = true,
['setglobal'] = true
}
local classnameNode = guide.getParentTypes(source, wants)
if not classnameNode then
return
end
local classname = guide.getKeyName(classnameNode)
if classname then
helper.addClassDoc(ast, classnameNode, classname)
end
end)
end
local function plugin_AddClassAtParam(uri, ast)
guide.eachSourceType(ast, "function", function (src)
helper.addClassDocAtParam(ast, "A", src, 1)
end)
end
local function TestSelfIsClass(state, next)
guide.eachSourceType(state.ast, "local", function (source)
if source[1] == 'self' then
assert(source.bindDocs)
assert(source.parent.type == 'function')
assert(#source.parent.args == 0)
end
end)
end
local function TestAHasField(state, next)
local foundFields = false
local cb = function (source)
if not source.bindDocs or not source.bindDocs[1].class or source.bindDocs[1].class[1] ~= "A" then
return
end
assert(#source.bindDocs == 1)
assert(#source.bindDocs[1].fields >= 2)
assert(source.bindDocs[1].fields[1].field[1] == "x")
assert(source.bindDocs[1].fields[2].field[1] == "y")
foundFields = true
end
guide.eachSourceType(state.ast, "local", cb)
guide.eachSourceType(state.ast, "setglobal", cb)
assert(foundFields)
end
local function plugin_AddMultipleDocs(uri, ast)
guide.eachSourceType(ast, "call", function(source)
local node = source.node
if guide.getKeyName(node) ~= 'Class' then
return
end
local wants = {
['local'] = true,
['setglobal'] = true
}
local classnameNode = guide.getParentTypes(source, wants)
if not classnameNode then
return
end
local classname = guide.getKeyName(classnameNode)
if classname then
local group = {}
helper.addClassDoc(ast, classnameNode, classname, group)
helper.addDoc(ast, classnameNode, "field", "x number", group)
helper.addDoc(ast, classnameNode, "field", "y string", group)
end
end)
end
local function TestPlugin1(script)
TestPlugin(script, plugin_AddClass, TestAIsClass)
end
local function TestPlugin2(script)
TestPlugin(script, plugin_AddClassAtParam, TestSelfIsClass)
end
local function TestPlugin3(script)
TestPlugin(script, plugin_AddMultipleDocs, TestAIsClass, TestAHasField)
end
TestPlugin1 [[
local A = Class(function() end)
]]
TestPlugin1 [[
A = Class(function() end)
]]
TestPlugin2 [[
local function ctor(self) end
]]
TestPlugin2 [[
function ctor(self) end
]]
TestPlugin3 [[
local A = Class()
]]
TestPlugin3 [[
A = Class()
]]
require 'plugins.ast.helper'
|
