An AMD loader plugin for CoffeeScript
Pull request Compare This branch is 40 commits behind requirejs:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
demo
tools
.gitignore
README.md
coffee-script.js
cs.js
demoserver.js
package.json

README.md

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 can do 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:

Place this in the directory that is your baseUrl for your project, or set up a paths config for it for the module ID coffee-script. The cs.js file specifies coffee-script as a dependency.

  1. Download the latest version of cs.js.

  2. Reference CoffeeScript files via the cs! plugin name. For example, to load the app.coffee file that is in your baseUrl directory:

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

    });

Or, if creating a module that depends on util.coffee:

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.

If you have node installed and need to run a web server to try out the demo, in this directory run npm install send, then start up the demo web server by running:

node demoserver.js

Optimizing

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

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 all the CoffeeScript modules have been converted to JS after the build, the CoffeeScript module and the source cs.js module are not included/needed in the built file.

If you want to do dynamic loading of CoffeeScript files after a build, then comment out stubModules: ['cs'] and exclude: ['coffee-script'] from the build file so that they will be included in the build.

License

Available via the MIT or new BSD license.