overte icon indicating copy to clipboard operation
overte copied to clipboard

typescript def file generator from jsdoc annotations

Open QEU-B-458 opened this issue 8 months ago • 6 comments

dootaadoo we believe we have integrated the typescript def file generator from jsdoc annotations into the overte repo we need someone to build and test but from ours at least the template works. we have also done some sprucing on the types of the jsdoc annotations to Aline with jsdoc annotations and the correct generation of typescript and with making sure it stays compatible with JavaScript API docs

QEU-B-458 avatar Apr 03 '25 03:04 QEU-B-458

The Windows CI is currently expected to fail, so don't worry about that.

JulianGro avatar Apr 03 '25 16:04 JulianGro

Thank you there was so much we needed to do to get everything working

QEU-B-458 avatar Apr 03 '25 17:04 QEU-B-458

we are wondering if this template even belongs in the main repo as we have talked to some people that want the typescript bindings in a npm package and if that makes more since the generator is in its own overte repo to package the bindings to npm package

QEU-B-458 avatar Apr 06 '25 10:04 QEU-B-458

if you still want it in the repo we can make the template a package to be installed with npm and then for another repo pulls overte in and runs the template and packages the type def and publishes to npm

QEU-B-458 avatar Apr 06 '25 10:04 QEU-B-458

that would only be if there is already a cmake that command for only building the docs

QEU-B-458 avatar Apr 06 '25 10:04 QEU-B-458

found out that the overte namespaces clash with namespaces from the typescript library itself

QEU-B-458 avatar Apr 06 '25 10:04 QEU-B-458

Converting to draft as this appears to be work in progress. Please mark this as ready for review if I am wrong.

JulianGro avatar Aug 11 '25 12:08 JulianGro