Skip to content

Add optional flag (?) to overloads in love2d and lovr builders #1180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 29, 2022
Merged

Add optional flag (?) to overloads in love2d and lovr builders #1180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a570167
Add optional for overloads
C3pa May 28, 2022
96c969c
A refactoring change
C3pa May 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 17 additions & 15 deletions tools/love-api.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,17 +50,20 @@ local function formatIndex(key)
return ('[%q]'):format(key)
end

local function isTableOptional(tbl)
if not tbl then
return false
end
local optional = true
for _, field in ipairs(tbl) do
if field.default == nil then
optional = nil
end
end
return optional
local function getOptional(param)
if param.type == 'table' then
if not param.table then
return ''
end
for _, field in ipairs(param.table) do
if field.default == nil then
return ''
end
end
return '?'
else
return (param.default ~= nil) and '?' or ''
end
end

local buildType
Expand Down Expand Up @@ -125,9 +128,9 @@ local function buildDocFunc(variant, overload)
params[#params+1] = '...'
else
if param.name:find '^[\'"]' then
params[#params+1] = ('%s: %s|%q'):format(param.name:sub(2, -2), getTypeName(param.type), param.name)
params[#params+1] = ('%s%s: %s|%q'):format(param.name:sub(2, -2), getOptional(param), getTypeName(param.type), param.name)
else
params[#params+1] = ('%s: %s'):format(param.name, getTypeName(param.type))
params[#params+1] = ('%s%s: %s'):format(param.name, getOptional(param), getTypeName(param.type))
end
end
end
Expand Down Expand Up @@ -159,10 +162,9 @@ local function buildFunction(func, node, typeName)
for _, param in ipairs(func.variants[1].arguments or {}) do
for paramName in param.name:gmatch '[%a_][%w_]*' do
params[#params+1] = paramName
local optional = param.type == 'table' and isTableOptional(param.table) or (param.default ~= nil)
text[#text+1] = ('---@param %s%s %s # %s'):format(
paramName,
optional and '?' or '',
getOptional(param),
buildType(param),
param.description
)
Expand Down
32 changes: 17 additions & 15 deletions tools/lovr-api.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,17 +51,20 @@ local function formatIndex(key)
return ('[%q]'):format(key)
end

local function isTableOptional(tbl)
if not tbl then
return false
end
local optional = true
for _, field in ipairs(tbl) do
if field.default == nil then
optional = nil
end
end
return optional
local function getOptional(param)
if param.type == 'table' then
if not param.table then
return ''
end
for _, field in ipairs(param.table) do
if field.default == nil then
return ''
end
end
return '?'
else
return (param.default ~= nil) and '?' or ''
end
end

local buildType
Expand Down Expand Up @@ -129,9 +132,9 @@ local function buildDocFunc(variant, overload)
params[#params+1] = '...'
else
if param.name:find '^[\'"]' then
params[#params+1] = ('%s: %s|%q'):format(param.name:sub(2, -2), getTypeName(param.type), param.name)
params[#params+1] = ('%s%s: %s|%q'):format(param.name:sub(2, -2), getOptional(param), getTypeName(param.type), param.name)
else
params[#params+1] = ('%s: %s'):format(param.name, getTypeName(param.type))
params[#params+1] = ('%s%s: %s'):format(param.name, getOptional(param), getTypeName(param.type))
end
end
end
Expand Down Expand Up @@ -163,10 +166,9 @@ local function buildFunction(func, typeName)
for _, param in ipairs(func.variants[1].arguments or {}) do
for paramName in param.name:gmatch '[%a_][%w_]*' do
params[#params+1] = paramName
local optional = param.type == 'table' and isTableOptional(param.table) or (param.default ~= nil)
text[#text+1] = ('---@param %s%s %s # %s'):format(
paramName,
optional and '?' or '',
getOptional(param),
buildType(param),
param.description
)
Expand Down