Repository navigation
Expand file tree
/
Copy pathdocgen.tl
More file actions
455 lines (406 loc) · 14.8 KB
/
Copy pathdocgen.tl
File metadata and controls
455 lines (406 loc) · 14.8 KB
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
local ansi <const> = require("cyan.ansi")
local cs <const> = require("cyan.colorstring")
local fs <const> = require("cyan.fs")
local log <const> = require("cyan.log")
local util <const> = require("cyan.util")
local keys <const> = util.tab.keys
local info = log.create_logger(
io.stdout,
"normal",
cs.highlight({ansi.color.bright.cyan}, "Docgen"),
cs.highlight({ansi.color.bright.cyan}, "...")
)
local has_ltreesitter <const>, ts <const> = pcall(require, "ltreesitter")
if not has_ltreesitter then
log.warn("docgen requires the ltreesitter module, which lua was unable to find\n", ts as string)
return
end
local has_teal_parser <const>, teal_parser <const> = pcall(ts.require, "teal")
if not has_teal_parser then
log.warn("docgen requires tree-sitter-teal, which ltreesitter could not find:\n", teal_parser as string)
return
end
local template_file <const> = fs.path.new("doc-template.html")
local template <const> = assert(fs.read(template_file:to_real_path()))
local docfile <const> = fs.path.new("docs/index.html")
local type Emitter = function(prefix: {string}, object: ts.Node, output: {string}): string
local function assertf(val: any, fmt: string, ...: any)
assert(val, fmt:format(...))
end
local type TagTree = {string | TagTree}
local function html(tags: TagTree): string
local flattened <const>: {string} = {}
for _, v in ipairs(tags) do
if v is string then
if #v > 0 then
table.insert(flattened, v)
end
else
table.insert(flattened, html(v))
end
end
return table.concat(flattened)
end
local function tag_wrapper(name: string): function(string | TagTree, {string:string}): TagTree
return function(content: string | TagTree, attrs: {string:string}): TagTree
if content is string then
content = { content }
end
local start = { "<", name }
if attrs then
local attr_keys <const> = util.tab.from(keys(attrs))
table.sort(attr_keys)
for _, key in ipairs(attr_keys) do
table.insert(start, (" %s=%s"):format(key, attrs[key]))
end
end
table.insert(start, ">")
table.insert(content as TagTree, 1, start)
table.insert(content as TagTree, "</" .. name .. ">\n")
return content as TagTree
end
end
local _h1 <const> = tag_wrapper "h1"
local h2 <const> = tag_wrapper "h2"
local h3 <const> = tag_wrapper "h3"
local _h4 <const> = tag_wrapper "h4"
local pre <const> = tag_wrapper "pre"
local p <const> = tag_wrapper "p"
local a <const> = tag_wrapper "a"
local br <const> = "<br>"
local function doc_header(content: string | TagTree, name: string): TagTree
return h3(a({ "<code>", content, "</code>" }, { name = name }))
end
local emit: {string:Emitter} = setmetatable({}, {
__newindex = function(self: {string:Emitter}, name: string, emitter: Emitter)
-- wrap all functions in these asserts
rawset(self, name, function(prefix: {string}, n: ts.Node, out: {string}): string
assertf(prefix, "nil prefix for emitter %q", name)
assertf(n, "nil node for emitter %q", name)
assertf(out, "nil output for emitter %q", name)
assertf(n:type() == name, "Wrong node type (%q) for emitter %q", n:type(), name)
local obj_name = emitter(prefix, n, out)
assertf(obj_name, "Emitter %q did not return object name", name)
return obj_name
end)
end,
__index = function(_: {string:Emitter}, name: string)
error(("No emitter for node %q"):format(name))
end,
})
local function escape(str: string): string
return (str:gsub("\n\n", br)
:gsub("`(.-)`", "<code>%1</code>")
:gsub("([\"'])([^%1]-)%1", "<code>%1%2%1</code>"))
end
local html_escape_map <const> = {
["<"] = "<",
[">"] = ">",
["'"] = "'",
['"'] = """,
['&'] = "&",
}
local function escape_html_chars(str: string): string, integer
return str:gsub("[<>'\"&]", html_escape_map)
end
emit["function_statement"] = function(prefix: {string}, n: ts.Node, out: {string}): string
local sig <const> = n:child_by_field_name("signature")
local ret <const> = sig:child_by_field_name("return_type")
local typeargs <const> = sig:child_by_field_name("typeargs")
local name <const> = n:child_by_field_name("name"):source()
table.insert(
out,
html {
doc_header({ name,
typeargs and escape_html_chars(typeargs:source()) or "",
sig:child_by_field_name("arguments"):source(),
(ret and ": " .. ret:source() or "") },
name),
p { escape(table.concat(prefix)) }
}
)
return name
end
emit["enum_declaration"] = function(prefix: {string}, n: ts.Node, out: {string}): string
local body <const> = n:child_by_field_name("enum_body")
assertf(body, "enum_body is nil for %s", tostring(n));
local name <const> = n:child_by_field_name("name"):source()
local entries <const> = {}
for child in body:named_children() do
table.insert(entries, child:source())
end
table.insert(
out,
html {
doc_header ({"type ", name}, name),
pre { "enum ", name, br, " ",
table.concat(entries, br .. " "),
br,
"end " },
p { escape(table.concat(prefix)) }
}
)
return name
end
emit["record_declaration"] = function(prefix: {string}, n: ts.Node, out: {string}): string
local fields <const> = {}
local meta <const> = {}
local body <const> = n:child_by_field_name("record_body")
assertf(body, "record_body is nil for %s", tostring(n))
local private_fields <const> = {}
for c in body:named_children() do
if c:type() == "field" then
local key = c:child_by_field_name("key")
local is_string = false
if not key then
key = c:child_by_field_name("string_key")
is_string = true
end
-- FIXME: properly parse out the key when it is a string
local is_private <const> = key:source():sub(1, 1) == "_" or is_string and key:source():sub(2, 2) == "_"
local t = c:child_by_field_name("type")
table.insert(
is_private and private_fields or fields,
(is_string and "[%s]" or "%s"):format(key:source())
.. ": " .. t:source()
)
elseif c:type() == "metamethod" then
table.insert(
meta,
c:source()
)
elseif c:type() == "record_array_type" then
table.insert(
fields,
1,
"{" .. c:child(0):source() .. "}"
)
end
end
local obj_name <const> = n:child_by_field_name("name"):source()
local pre_contents <const> = { "record ", obj_name }
if #fields > 0 then
table.insert(pre_contents, br .. " " .. table.concat(fields, br .. " "))
end
if #meta > 0 then
if #fields > 0 then
table.insert(pre_contents, br)
end
table.insert(pre_contents, br .. " " .. table.concat(meta, br .. " "))
end
if #private_fields > 0 then
if #fields > 0 or #meta > 0 then
table.insert(pre_contents, br)
end
table.insert(pre_contents, br .. " <details><summary class=\"private-field-comment\">-- private fields</summary>" .. br .. " ")
table.insert(pre_contents, table.concat(private_fields, br .. " "))
table.insert(pre_contents, "</details>")
end
table.insert(pre_contents, br .. "end")
table.insert(
out,
html {
doc_header ({"type ", obj_name}, obj_name),
pre (pre_contents),
p { escape(table.concat(prefix)) }
}
)
return obj_name
end
local query <const> = teal_parser:query[[
((comment)+ @com
. (_) @obj
(#match? @com "^%-%-%-@%w+$")) ]]
local record Doc
kind: string
content: {string}
obj: ts.Node
end
local function gen_docs(filename: string, module_name: string): string, {string}
local root: ts.Node
do
local file <const> = assert(filename, "No filename provided")
local content <const> = assert(fs.read(file))
local tree <const> = assert(teal_parser:parse_string(content))
root = tree:root()
end
local docs <const>: {Doc} = {}
for match in query:match(root) do
local caps <const> = match.captures as {ts.Node}
local n <const> = caps[match.capture_count as integer]
local s = n:type()
if s ~= "comment" then
-- obj will match comments as the query will produce EVERY match
-- resulting in the same nodes being matched over and over
-- this basically guarantees the match we actually care about
local obj <const> = table.remove(caps, match.capture_count)
local kind_node = table.remove(caps, 1)
local kind <const> = kind_node:source():match("^%-%-%-@(%w+)")
if kind == "nodoc" then
return
end
local lines <const> = {}
local content: {string} = {}
local current_state: string
local n_leading_spaces: integer
local function ins(str: string)
if str:match("^%s*$") then return end
table.insert(content, str)
end
for i, v in ipairs(caps) do
local src <const> = v:source()
if not src:match("^%-%-%-") then
break
end
local sub <const>, rest <const> = src:match("^%-%-%-@@(%w+)(.*)%s*$")
-- TODO: make a proper state machine for this
if sub then
if sub == "end" then
if current_state == "table" then
ins("</table><p>")
elseif current_state == "code" then
ins("</pre><p>")
end
current_state = nil
elseif current_state then
error("Attempt to use @@" .. sub .. " inside of @@" .. current_state)
else
current_state = sub
if current_state == "table" then
ins("</p><table>")
local row <const> = { "<tr>" }
for col in rest:gmatch("[^|]+") do
table.insert(row, "<th>" .. col .. "</th>")
end
table.insert(row, "</tr>")
ins(table.concat(row))
elseif current_state == "code" then
ins("</p><pre>")
end
end
else
local leadingws <const>, line = src:match("^%-%-%-(%s*)(.*)%s*$")
if i == 1 then
n_leading_spaces = #leadingws
else
line = leadingws:sub(n_leading_spaces + 1, -1) .. line
end
if current_state == "table" then
local row = { "<tr>" }
for col in line:gmatch("[^|]+") do
table.insert(row, "<td>" .. escape_html_chars(col) .. "</td>")
end
table.insert(row, "</tr>")
ins(table.concat(row))
elseif current_state == "code" then
ins(line .. "<br>")
else
if line == "" and #content > 0 then
table.insert(lines, "<p>" .. table.concat(content, " ") .. "</p>")
content = {}
else
ins(line)
end
end
end
end
assertf(not current_state, "Unended doc block %q in %s", current_state, filename)
table.insert(lines, "<p>" .. table.concat(content, " ") .. "</p>")
table.insert(docs, {
kind = kind,
content = lines,
obj = obj,
})
end
end
local brief: string
local sections <const>: {string} = {}
local table_of_contents <const>: {string} = {}
for _, d in ipairs(docs) do
local node_kind <const> = d.obj:type()
if d.kind == "desc" then
local name <const> = emit[node_kind](d.content, d.obj, sections)
table.insert(table_of_contents, html {
a (name, { href = ("#%s"):format(name) }),
})
elseif d.kind == "brief" then
if brief then
error("Module " .. module_name .. " contains more than one @brief directive")
end
brief = escape(table.concat(d.content))
else
log.warn("Unhandled node kind: ", node_kind)
end
end
if not brief then
log.warn(
filename, " has no ",
cs.highlight(cs.colors.keyword, "---@brief"), "\n If this is intentional, use ",
cs.highlight(cs.colors.keyword, "---@nodoc"), " to silence this warning"
)
end
if #sections > 0 or brief as boolean then
table.sort(sections)
local res: {string | TagTree} = {
h2 (a (module_name, { name = module_name })),
}
if brief then
table.insert(res, p(brief))
end
table.insert(sections, 1, html (res))
table.sort(table_of_contents)
return table.concat(sections), table_of_contents
end
end
local table_of_contents <const> = {}
local table_of_contents_line_count <const>: {integer} = {}
local total_lines = 0
local output <const> = {}
for path in fs.scan_dir("src", {"cyan/**/*"}) do
local file <const> = ("src" .. path):to_real_path()
local mod <const> = path:tostring():gsub("%.tl$", ""):gsub("/", "."):gsub("%.init$", "")
local docs <const>, toc <const> = gen_docs(file, mod)
if docs then
info("Processed ",
5E70
cs.highlight(cs.colors.file, path:tostring()))
table.insert(table_of_contents, html {
p { a (mod, { href = ("#%s"):format(mod), class = "module-name" }),
br,
table.concat(toc, br) }
})
table.insert(table_of_contents_line_count, #toc)
total_lines = total_lines + #toc
table.insert(output, docs)
end
end
table.sort(table_of_contents)
local columns <const> = 3
local new_column_threshold <const> = math.floor(total_lines / columns)
do
local rows = 0
for i = #table_of_contents, 1, -1 do
rows = rows + table_of_contents_line_count[i]
if rows >= new_column_threshold then
table.insert(table_of_contents, i, "</td><td valign=top>")
rows = 0
end
end
end
table.insert(table_of_contents, "</td>")
table.sort(output)
local final_table_of_contents <const> = table.concat(table_of_contents)
local final_output <const> = table.concat(output)
local final_blob <const> = template:gsub(
"<!%-%-([%w ]+)%-%->",
function(match: string): string
if match == "TABLE OF CONTENTS" then
return final_table_of_contents
elseif match == "CONTENTS" then
return final_output
end
return match
end
)
local fh <const> = assert(io.open(docfile:to_real_path(), "w"))
fh:write(final_blob)
fh:close()
info("Wrote ", cs.highlight(cs.colors.file, docfile:to_real_path()))