https://github.com/navinpeiris/jsca2js
Utility to convert JSON in Appcelerator's JSCA format to JavaScript
https://github.com/navinpeiris/jsca2js
Last synced: over 1 year ago
JSON representation
Utility to convert JSON in Appcelerator's JSCA format to JavaScript
- Host: GitHub
- URL: https://github.com/navinpeiris/jsca2js
- Owner: navinpeiris
- Created: 2011-10-17T06:38:10.000Z (almost 15 years ago)
- Default Branch: master
- Last Pushed: 2015-05-21T21:33:54.000Z (about 11 years ago)
- Last Synced: 2025-03-27T06:22:32.979Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 2.35 MB
- Stars: 74
- Watchers: 9
- Forks: 25
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
jsca2js
=======
This project provides a set of utilities to convert APIs written in [Appcelerator's](http://www.appcelerator.com/)
[JSCA](http://wiki.appcelerator.org/display/tis/JSCA+1.0+Specification) specification to JSDoc annotated
JavaScript files.
A good use case for these utilities is to generate a JavaScript file for the
[Titanium JSON API](http://developer.appcelerator.com/apidoc/mobile/1.8.0.1/api.json), which can then be used in
IDE's such as [IntelliJ IDEA](http://www.jetbrains.com/idea/), [NetBeans](http://www.netbeans.com/) or [Sublime Text 2](http://www.sublimetext.com/)
(using [SublimeCodeIntel plugin](https://github.com/Kronuz/SublimeCodeIntel)) for code completion and documentation
lookup.
If you drop this Javascript API in the root of your Titanium mobile project,
smart JS editors' code completion will help you write this kind of stuff easily:
var win = Ti.UI.createWindow(options);
win.
Also, this project tries to find Alloy framework JSCA files and convert them too.
Converting JSCA JSON to JavaScript
----------------------------------
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.
Creating the Titanium JavaScript file
-------------------------------------
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 cache it locally) and produce
the corresponding JavaScript file.
### Usage:
titanium-mobile.py (optional)
### Output
The script will produce the JavaScript file in the current directory with a name that follows the following format:
titanium-mobile-.js
If the script would find Alloy JSCA file too, it will produce one more file with a name:
titanium-mobile-alloy-.js
### PS
Be aware that versions of Titanium and Alloy framework can be different. Check firstly [Appcelerator Portal](http://docs.appcelerator.com/titanium/latest/) in JSON SDK
section to find the proper latest version of Alloy framework. The titanium version for alloy is in the URL for the alloy file (eg. the 1.3.x alloy json is at version 3.2.0 of titanium).