Defold Annotations generator for Lua Language Server

The Defoldmine
#1

Found that still haven’t started a related topic. So…

Defold Annotations

This is a set of Lua scripts for parsing Defold documentation and generating annotation files compatible with Lua Language Server.

By design, it can be run on Windows, macOS and Linux. Only Lua needs to be installed. The Lua language was chosen because it allows all Defold users to contribute to this project.

Generated annotations are available on the Releases page.

Use case

Litteraly it’s any way of Lua Language Server installation outside of Defold Editor.

Fox example, these annotations are used by Defold Kit which automatically fetches an annotations release when if your Defold Editor version has been changed.

Automatic Releases

The repository has an action workflow that checks the latest version of Defold daily and automatically generates and releases the new version of annotations if required.

But if something goes wrong and edits are needed, there will be an additional manual update in the release.

6 Likes
#2

And that’s the point! The point, why I decided to create this topic.

I would like to inform you that from version 1.9.4 to version 1.9.6, some non-valid annotations were generated for the editor.* namespace, which blocked the build if the folder with annotations was manually placed in the project folder.

So, if you already fetched annotations for 1.9.6, please update it :grinning_face_with_smiling_eyes: .
Including users of Defold Kit (by calling the Sync Annotations for API command).

Thanks, enjoy!

3 Likes