1
0

Added API export for LuaCheck.

This commit is contained in:
Lukas Pioch 2016-11-20 22:11:23 +01:00
parent 852dbe9ab4
commit d929fbe665
2 changed files with 74 additions and 1 deletions

2
.gitignore vendored
View File

@ -107,4 +107,4 @@ CPackSourceConfig.cmake
Server/cuberite_api.lua Server/cuberite_api.lua
Server/official_undocumented.lua Server/official_undocumented.lua
Server/NewlyUndocumented.lua Server/NewlyUndocumented.lua
Server/.luacheckrc

View File

@ -1635,6 +1635,75 @@ end
local function DumpLuaCheck(a_API)
LOG("Creating file .luacheckrc...")
local file = io.open(".luacheckrc", "w")
file:write([[
-- This file is the config file for the tool named Luacheck
-- Documentation: http://luacheck.readthedocs.io/en/stable/index.html
-- Ignore unused function and loop arguments
unused_args = false
-- Allow self defined globals
allow_defined = true
-- Ignore this functions
ignore =
{
"Initialize", -- Plugin
"OnDisable", -- Plugin
"RegisterPluginInfoCommands", -- InfoReg.lua
"RegisterPluginInfoConsoleCommands", -- InfoReg.lua
"g_PluginInfo", -- Info.lua
}
-- Ignore files / directories
exclude_files =
{
"tests/" -- CuberitePluginChecker
}
-- All globals from cuberite (classes, enums, functions)
globals =
{
]])
-- Export all global symbols
for _, cls in ipairs(a_API) do
if cls.Name == "Globals" then
-- Global functions
for _, func in ipairs(cls.Functions) do
file:write("\t\"", func.Name, "\",\n")
end
-- Global constants
for _, const in ipairs(cls.Constants) do
file:write("\t\"", const.Name, "\",\n")
end
-- Global constants from all groups
for _, group in pairs(cls.ConstantGroups) do
for _, const in pairs(group.Constants) do
file:write("\t\"", const.Name, "\",\n")
end
end
else
file:write("\t\"", cls.Name, "\",\n")
end
end
file:write("}\n")
file:close()
LOG("Config file .luacheckrc created...")
end
--- Returns true if a_Descendant is declared to be a (possibly indirect) descendant of a_Base --- Returns true if a_Descendant is declared to be a (possibly indirect) descendant of a_Base
local function IsDeclaredDescendant(a_DescendantName, a_BaseName, a_API) local function IsDeclaredDescendant(a_DescendantName, a_BaseName, a_API)
-- Check params: -- Check params:
@ -1804,6 +1873,9 @@ local function DumpApi()
-- Dump all available API objects in format used by ZeroBraneStudio API descriptions: -- Dump all available API objects in format used by ZeroBraneStudio API descriptions:
DumpAPIZBS(API) DumpAPIZBS(API)
-- Export the API in a format used by LuaCheck
DumpLuaCheck(API)
LOG("APIDump finished"); LOG("APIDump finished");
return true return true
end end
@ -2062,3 +2134,4 @@ function Initialize(Plugin)
return true return true
end end