This project provides a set of utilities to convert APIs written in Appcelerator's JSCA specification to JSDoc annotated JavaScript files.
Currently the only use case I've found for these utilities is to generate a JavaScript file for the Titanium JSON API, which can then be used in IDE's such as IntelliJ IDEA for code completion and documentation lookup. Unfortunately not all identifiers used in the Titanium API convert to valid JavaScript, but nonetheless I found the produced file quite useful.
The main function used to convert JSCA JSON to JavaScript is named convertJsca2Js
and is provided through the jsca2js.py
script. This function expects a JSON object containing the API in the JSCA specification and produces a string containing the converted JavaScript.
The titanium-mobile.py
script can be used to create a JavaScript file for Titanium Mobile API. This script will automatically fetch the api.json
file from the Titanium Developer site and produce the corresponding JavaScript file.
titanium-mobile.py <titanium-version>
The script will produce the JavaScript file in the current directory with a name that follows the following format:
titanium-mobile-<titanium-version>.js