mirror of https://github.com/Hilbis/Hilbish
147 lines
3.2 KiB
Lua
147 lines
3.2 KiB
Lua
local fs = require 'fs'
|
|
local emmyPattern = '^%-%-%- (.+)'
|
|
local modpattern = '^%-+ @module (%w+)'
|
|
local pieces = {}
|
|
|
|
local files = fs.readdir 'nature'
|
|
for _, fname in ipairs(files) do
|
|
local isScript = fname:match'%.lua$'
|
|
if not isScript then goto continue end
|
|
|
|
local f = io.open(string.format('nature/%s', fname))
|
|
local header = f:read '*l'
|
|
local mod = header:match(modpattern)
|
|
if not mod then goto continue end
|
|
|
|
print(fname, mod)
|
|
pieces[mod] = {}
|
|
|
|
local docPiece = {}
|
|
local lines = {}
|
|
local lineno = 0
|
|
for line in f:lines() do
|
|
lineno = lineno + 1
|
|
lines[lineno] = line
|
|
|
|
if line == header then goto continue2 end
|
|
if not line:match(emmyPattern) then
|
|
if line:match '^function' then
|
|
local pattern = (string.format('^function %s%%.', mod) .. '(%w+)')
|
|
local funcName = line:match(pattern)
|
|
if not funcName then goto continue2 end
|
|
|
|
local dps = {
|
|
description = {},
|
|
params = {}
|
|
}
|
|
|
|
local offset = 1
|
|
while true do
|
|
local prev = lines[lineno - offset]
|
|
|
|
local docline = prev:match '^%-+ (.+)'
|
|
if docline then
|
|
local emmy = docline:match '@(%w+)'
|
|
local cut = 0
|
|
|
|
if emmy then cut = emmy:len() + 3 end
|
|
local emmythings = string.split(docline:sub(cut), ' ')
|
|
|
|
if emmy then
|
|
if emmy == 'param' then
|
|
table.insert(dps.params, 1, {
|
|
name = emmythings[1],
|
|
type = emmythings[2]
|
|
})
|
|
end
|
|
else
|
|
table.insert(dps.description, 1, docline)
|
|
end
|
|
offset = offset + 1
|
|
else
|
|
break
|
|
end
|
|
end
|
|
|
|
pieces[mod][funcName] = dps
|
|
end
|
|
docPiece = {}
|
|
goto continue2
|
|
end
|
|
|
|
table.insert(docPiece, line)
|
|
::continue2::
|
|
end
|
|
::continue::
|
|
end
|
|
|
|
local header = [[---
|
|
title: %s %s
|
|
description: %s
|
|
layout: doc
|
|
menu:
|
|
docs:
|
|
parent: "Nature"
|
|
---
|
|
|
|
]]
|
|
|
|
for iface, dps in pairs(pieces) do
|
|
local mod = iface:match '(%w+)%.' or 'nature'
|
|
local path = string.format('docs/%s/%s.md', mod, iface)
|
|
fs.mkdir(fs.dir(path), true)
|
|
local f <close> = io.open(path, 'w')
|
|
f:write(string.format(header, 'Module', iface, 'No description.'))
|
|
print(f)
|
|
|
|
print(mod, path)
|
|
|
|
for func, docs in pairs(dps) do
|
|
f:write(string.format('<hr>\n<div id=\'%s\'>', func))
|
|
local sig = string.format('%s.%s(', iface, func)
|
|
for idx, param in ipairs(docs.params) do
|
|
sig = sig .. ((param.name:gsub('%?$', '')))
|
|
if idx ~= #docs.params then sig = sig .. ', ' end
|
|
end
|
|
sig = sig .. ')'
|
|
f:write(string.format([[
|
|
<h4 class='heading'>
|
|
%s
|
|
<a href="#%s" class='heading-link'>
|
|
<i class="fas fa-paperclip"></i>
|
|
</a>
|
|
</h4>
|
|
|
|
]], sig, func))
|
|
|
|
f:write(table.concat(docs.description, '\n') .. '\n')
|
|
f:write '#### Parameters\n'
|
|
if #docs.params == 0 then
|
|
f:write 'This function has no parameters. \n'
|
|
end
|
|
for _, param in ipairs(docs.params) do
|
|
f:write(string.format('`%s` **`%s`**\n', param.name:gsub('%?$', ''), param.type))
|
|
end
|
|
--[[
|
|
local params = table.filter(docs, function(t)
|
|
return t:match '^%-%-%- @param'
|
|
end)
|
|
for i, str in ipairs(params) do
|
|
if i ~= 1 then
|
|
f:write ', '
|
|
end
|
|
f:write(str:match '^%-%-%- @param ([%w]+) ')
|
|
end
|
|
f:write(')\n')
|
|
|
|
for _, str in ipairs(docs) do
|
|
if not str:match '^%-%-%- @' then
|
|
f:write(str:match '^%-%-%- (.+)' .. '\n')
|
|
end
|
|
end
|
|
]]--
|
|
f:write('</div>')
|
|
f:write('\n\n')
|
|
end
|
|
end
|