Code Monkey home page Code Monkey logo

jsca2js's Introduction

jsca2js

This project provides a set of utilities to convert APIs written in Appcelerator's JSCA specification to JSDoc annotated JavaScript files.

A good use case 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, NetBeans or Sublime Text 2 (using SublimeCodeIntel plugin) 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.<completion for Window proxy object>

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 <titanium-version>

Output

The script will produce the JavaScript file in the current directory with a name that follows the following format:

titanium-mobile-<titanium-version>.js

jsca2js's People

Contributors

doublerebel avatar elsassph avatar h3r2on avatar navinpeiris avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.