README.md

This library adds CommonJS support to Sprockets.

What is CommonJS?

The CommonJS module format is a way of encapsulating JavaScript libraries, ensuring they have to explicitly require and export properties they use. In a nutshell:

1. You require in files using require():

   var Asset = require('models/asset');

2. You export properties using module.exports:

   var Asset = function(){ /* ... */ }; module.exports = Asset;

This library

This library adds CommonJS support to Sprockets, so it can wrap up JavaScript files as modules, and serve them appropriately. This is done by giving any JS files you want as modules, the .module.js extension.

Sprockets will then wrap up the JS library when it's requested, with the following:

require.define({'library/name': function(exports, require, module){ /* Your library */ }});

require.define() is defined inside commonjs.js, which you'll need to include in the page before any modules are loaded.

One caveat to the approach this library takes, is that dependencies loaded through require() will not be added to the dependency graph. This library will not parse the AST tree for require calls. This decision has been made for a variety of reasons, but it does mean you need to require files through both CommonJS and Sprockets.

The library also supports processing .mustache files and for either .module.js and .mustache it will also accept .erb in addition, in case ERB pre-processing is desired. (This may be handy for using asset_path in the Rails asset pipeline.)

Usage

1. Add gem 'sprockets-commonjs' to your Gemfile
2. Add .module.js to any JavaScript files you want as modules, i.e. users.module.js
3. Require all the modules, e.g.: //= require_tree ./models
4. Or, require individual modules, e.g.: //= require users.module