Reuh/anselme
1
0
Fork 0
mirror of https://github.com/Reuh/anselme.git synced 2025-10-27 16:49:31 +00:00
Code Releases Activity

[doc] improve anselme operator title extraction, check for unused defers

Browse source
This commit is contained in:
Étienne Fildadut 2024-05-29 14:31:53 +02:00
parent 3ba67b839f
commit 157f71a7fa
1 changed files with 34 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

39
doc/gendocs.lua
View file

@ -17,9 +17,32 @@ end
local title_extractors = { local title_extractors = {
-- anselme luafunction definition -- anselme luafunction definition
{ "\"(.-)\",%s*\"(.-)\",", function(name, params) { "{?%s*\"(.-)\",%s*\"(.-)\",", function(name, params)
return ("%s %s"):format(unescape(name), unescape(params)) name, params = unescape(name), unescape(params)
-- assignment
local assignment = ""
if params:match("=[%w%s]+$") then
params, assignment = params:match("^(.-)%s*=%s*([%w%s]+)%s*$")
assignment = " = "..assignment
end
-- infix
if name:match("^_[^%w]+_$") and params:match("^%(.-,.-%)$") then
local left, right = params:match("^%(%s*(.-)%s*,%s*(.-)%s*%)$")
return ("%s %s %s%s"):format(left, name:match("^_([^%w]+)_$"), right, assignment)
-- suffix
elseif name:match("^_[^%w]+$") and params:match("^%(.-%)$") then
local left = params:match("^%(%s*(.-)%s*%)$")
return ("%s %s%s"):format(left, name:match("^_([^%w]+)$"), assignment)
-- prefix
elseif name:match("^[^%w]+_$") and params:match("^%(.-%)$") then
local right = params:match("^%(%s*(.-)%s*%)$")
return ("%s %s%s"):format(name:match("^([^%w]+)_$"), right, assignment)
end
-- normal function
return ("%s %s%s"):format(name, params, assignment)
end }, end },
-- anselme field definition
{ "{%s*\"(.-)\",", "%1"},
-- methods -- methods
{ "(.-)%s*=%s*function%s*%(%s*self%s*%)", ":%1 ()" }, { "(.-)%s*=%s*function%s*%(%s*self%s*%)", ":%1 ()" },
@ -46,7 +69,7 @@ local valid_tags = { title = true, defer = true }
local function process(content) local function process(content)
local deferred = {} local deferred = {}
return content:gsub("{{(.-)}}", function(lua_file) local out = content:gsub("{{(.-)}}", function(lua_file)
-- deferred doc comments -- deferred doc comments
if lua_file:match("^:") then if lua_file:match("^:") then
local defer = lua_file:match("^:(.-)$") local defer = lua_file:match("^:(.-)$")
@ -59,7 +82,7 @@ local function process(content)
end end
-- lua file -- lua file
else else
local f = io.open(lua_file, "r") local f = assert(io.open(lua_file, "r"))
local c = f:read("a") local c = f:read("a")
f:close() f:close()
@ -79,7 +102,7 @@ local function process(content)
if comment:match("^%s*@") then if comment:match("^%s*@") then
local tag, data = comment:match("^%s*@%s*([^%s]*)%s*(.-)$") local tag, data = comment:match("^%s*@%s*([^%s]*)%s*(.-)$")
if valid_tags[tag] then comment_block[tag] = data if valid_tags[tag] then comment_block[tag] = data
else print(("unknown documentation tag @%s, at %s:%s"):format(tag, lua_file, line_no)) end else print(("[warning] unknown documentation tag @%s, at %s:%s"):format(tag, lua_file, line_no)) end
else else
table.insert(comment_block, comment) table.insert(comment_block, comment)
end end
@ -114,6 +137,12 @@ local function process(content)
return table.concat(output, "\n") return table.concat(output, "\n")
end end
end) .. ("\n---\n_file generated at %s_"):format(os.date("!%Y-%m-%dT%H:%M:%SZ")) end) .. ("\n---\n_file generated at %s_"):format(os.date("!%Y-%m-%dT%H:%M:%SZ"))
for k in pairs(deferred) do
print("[warning] unused defer "..tostring(k))
end
return out
end end
local function generate_file(input, output) local function generate_file(input, output)