Development

Source code

The source code for ist.js is accessible on GitHub. The master branch contains the latest released (and hopefully stable) version, while the devel branch features the latest developments but may be unstable.

You can also directly grab the source code as a zip archive or a tar.gz archive.

Building

Installing build dependencies

You will need make, nodejs and npm to build or test ist.js. Just clone the repository or download a source tarball, and run npm install from the repository root to install build dependencies. The following dependencies are installed:

• pegjs to build the template parser
• requirejs to build ist.js components into a single file and to run tests
• karma to run the test suite, including support for Chrome and Firefox
• karma-opera-launcher to run the test suite on Opera
• karma-sauce-launcher to run the test suite on Sauce Labs. This is only used when running tests from Travis.

Building

Run make from the repository root to build both ist.js and the minified version. You can also run make ist or make ist-min to only build one version at a time. Output files are created in the repository root.

Testing

ist.js includes a thorough test suite which uses Karma and Jasmine. There are two ways to run the test suite from a local repository clone:

• make test runs the test suite with PhantomJS, Chrome, Firefox and Opera, and then exits. You must have both those browsers installed for this to succeed (except for PhantomJS, which is built-in with Karma).
• make test-dev launches Karma but does not launch any browsers. You can then point any browser to http://localhost:9876/ to run the test suite with this browser.

Compatibility

ist.js builds are tested automatically on Travis with Sauce Labs.

Contributing

Don't hesitate to report bugs on GitHub, even the little hitches do matter. You can also fork ist.js and send me pull requests. Also please feel free to contact me as @njoyard on twitter.