Survey: TypeScript Language Support in the Editor

[britzl]

@ThinkNathan

Defold docs are fine for human readers, but challenging for tools to extract all the needed information. Eg. sometimes a property’s type is listed as just table, but to construct an accurate type definition, I need to know every property of that table, the types of those properties, and whether or not they’re optional. The comments usually explain in plain language what the table contains, but it’s challenging to extract accurate info from comments.

I’m only suggesting to parse the reference documentation in json format (which we also use for our own defold.com/ref pages and which I use when generating the docset for Dash.

I would like to improve the quality of the Defold API documentation so that it is near 100% correct in all cases. If you have examples of where we can improve it then please let me know!

@ThinkNathan

• Some extensions don’t have a script_api at all (most Lua libraries)
• There’s no strict validation for script_api files, so sometimes we have to guess at the author’s intentions (sometimes they write integer, but other times they write number; sometimes they make typos; sometimes they leave out types altogether)

What do you do in these kinds of situations? Can you set a type to unknown/any/object or similar ?