Add script to automatically generate a declaration file for the JS API #34
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a Python script to automatically generate a declaration file (.d.ts) for the JavaScript API. This give TypeScript syntax highlighting and intellisense for the entire API including the OpenSpace lua functions.
For now we keep the
openspace-ai-js.d.ts
file in this repository since it seems to be quite a process to add it to the npm @types and DefinitelyTyped repo since our Lua API is updated quite often, it will be nice to have more control over it.Usage
Simply copy the
openspace-api-js.d.ts
file from the declaration folder to the src project folder, might have to update thecompilerOptions
to include the new file as well.Generate an updated version
Run the Python script
generatetypescriptfile.py
from the root folder ofopenspace-api-js