Skip to content

Add "async" and "deprecated" key to JSON output #2545

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
Feb 27, 2024
Merged

Add "async" and "deprecated" key to JSON output #2545

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
beacc21
Add "async" key in JSON output.
AndreasMatthias Feb 26, 2024
d0bfdaa
Add "deprecated" key in JSON output.
AndreasMatthias Feb 26, 2024
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
14 changes: 14 additions & 0 deletions script/cli/doc.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,13 @@ local function collectTypes(global, results)
field.rawdesc = getDesc(source, true)
field.extends = packObject(source.value)
field.visible = vm.getVisibleType(source)
if vm.isAsync(source, true) then
field.async = true
end
local depr = vm.getDeprecated(source)
if (depr and not depr.versions) then
field.deprecated = true
end
return
end
if source.type == 'tableindex' then
Expand Down Expand Up @@ -250,6 +257,13 @@ local function collectVars(global, results)
result.rawdesc = result.rawdesc or getDesc(set, true)
result.defines[#result.defines].extends['desc'] = getDesc(set)
result.defines[#result.defines].extends['rawdesc'] = getDesc(set, true)
if vm.isAsync(set, true) then
result.defines[#result.defines].extends['async'] = true
end
local depr = vm.getDeprecated(set)
if (depr and not depr.versions) then
result.defines[#result.defines].extends['deprecated'] = true
end
end
end
if #result.defines == 0 then
Expand Down