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
146
147
148
149
150
151
152
153
154
|
local helpers = require('test.functional.helpers')(after_each)
local eq = helpers.eq
local grammar = require('scripts/luacats_grammar')
describe('luacats grammar', function()
--- @param text string
--- @param exp table<string,string>
local function test(text, exp)
it(string.format('can parse %q', text), function()
eq(exp, grammar:match(text))
end)
end
test('@param hello vim.type', {
kind = 'param',
name = 'hello',
type = 'vim.type',
})
test('@param hello vim.type this is a description', {
kind = 'param',
name = 'hello',
type = 'vim.type',
desc = 'this is a description',
})
test('@param hello vim.type|string this is a description', {
kind = 'param',
name = 'hello',
type = 'vim.type|string',
desc = 'this is a description',
})
test('@param hello vim.type?|string? this is a description', {
kind = 'param',
name = 'hello',
type = 'vim.type?|string?',
desc = 'this is a description',
})
test('@return string hello this is a description', {
kind = 'return',
{
name = 'hello',
type = 'string',
},
desc = 'this is a description',
})
test('@return fun() hello this is a description', {
kind = 'return',
{
name = 'hello',
type = 'fun()',
},
desc = 'this is a description',
})
test('@return fun(a: string[]): string hello this is a description', {
kind = 'return',
{
name = 'hello',
type = 'fun(a: string[]): string',
},
desc = 'this is a description',
})
test('@return fun(a: table<string,any>): string hello this is a description', {
kind = 'return',
{
name = 'hello',
type = 'fun(a: table<string,any>): string',
},
desc = 'this is a description',
})
test('@param ... string desc', {
kind = 'param',
name = '...',
type = 'string',
desc = 'desc',
})
test('@param level (integer|string) desc', {
kind = 'param',
name = 'level',
type = 'integer|string',
desc = 'desc',
})
test('@return (string command) the command and arguments', {
kind = 'return',
{
name = 'command',
type = 'string',
},
desc = 'the command and arguments',
})
test('@return (string command, string[] args) the command and arguments', {
kind = 'return',
{
name = 'command',
type = 'string',
},
{
name = 'args',
type = 'string[]',
},
desc = 'the command and arguments',
})
test('@param rfc "rfc2396" | "rfc2732" | "rfc3986" | nil', {
kind = 'param',
name = 'rfc',
type = '"rfc2396" | "rfc2732" | "rfc3986" | nil',
})
test('@param offset_encoding "utf-8" | "utf-16" | "utf-32" | nil', {
kind = 'param',
name = 'offset_encoding',
type = '"utf-8" | "utf-16" | "utf-32" | nil',
})
-- handle a : after the param type
test('@param a b: desc', {
kind = 'param',
name = 'a',
type = 'b',
desc = 'desc',
})
test(
'@field prefix? string|table|(fun(diagnostic:vim.Diagnostic,i:integer,total:integer): string, string)',
{
kind = 'field',
name = 'prefix?',
type = 'string|table|(fun(diagnostic:vim.Diagnostic,i:integer,total:integer): string, string)',
}
)
test('@field [integer] integer', {
kind = 'field',
name = '[integer]',
type = 'integer',
})
test('@field [1] integer', {
kind = 'field',
name = '[1]',
type = 'integer',
})
end)
|
