Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
branch: master
Fetching contributors…

Cannot retrieve contributors at this time

89 lines (59 sloc) 3.519 kB

require-cs

A CoffeeScript loader plugin that may work with module loaders like RequireJS, curl and backdraft.

It is known to work with RequireJS 1.0+.

This loader plugin makes it easy to write your JS functionality in CoffeeScript, and easily use it in the browser, Node or Rhino. Plus, if you use the RequireJS optimizer, your CoffeeScript files can be translated to JavaScript, and inlined into optimized layers for fast performance.

In development, it uses XMLHttpRequest to fetch the .coffee files, so you can only fetch files that are on the same domain as the HTML page, and most browsers place restrictions on using XMLHttpRequest from local file URLs, so use a web server to serve your .coffee files.

Usage

1) Download CoffeeScript for the browser that registers as an AMD module. You that by using a "raw" GitHub URL. It takes the form of:

https://raw.github.com/jashkenas/coffee-script/[BRANCH-OR-VERSION]/extras/coffee-script.js

Example links:

The file is normally named coffee-script.js, but it should be saved on disk as "CoffeeScript.js", since that matches the name of the JS object created by the script, and the cs.js loader plugin references a module dependency called "CoffeeScript".

2) Download the latest version of cs.js.

3) For doing builds, download the latest version of csBuild.js, it is used in place of the cs.js plugin after a build is done.

4) Reference CoffeeScript files via the cs! plugin name:

require(['cs!app'], function (app) {

});

Or, if creating a module:

define(['cs!util'], function (util) {
    util.doSomething();
});

If you are using define() in a module written with CoffeeScript:

define ['cs!util'], (util) ->
    util.doSomething

VERY IMPORTANT: Only define anonymous modules using CoffeeScript. Otherwise, the optimization work will not happen correctly -- the name of the module is changed to allow inlining of the translated JS content.

Complete web project

The demo directory shows a complete web example. See the demo/index.html file as the entry point into the demo. It is not a fancy demo, just shows basic use.

Optimizing

See demo/build.sh for an example build script that drives the optimizer with the demo/build.js build config.

Be sure you have downloaded csBuild.js for use in the build.

The build will generate a demo-build directory with the optimized files. Where the unoptimized demo directory will load 7 files, the optimized one only loads 2, and the CoffeeScript files have been converted to JavaScript. Since the csBuild.js file will be used instead of the cs.js file in the optimized file, it will not require loading CoffeeScript after the build is done.

If you want to do dynamic loading of CoffeeScript files after a build, then do not use csBuild.js and do not do the reverse path config that build.js does in the build.

License

Available via the MIT or new BSD license.

Jump to Line
Something went wrong with that request. Please try again.