grunt-tusk-coffee

Compiles coffee script into commonjs modules and joins them to a single file

Getting Started

If you haven't used grunt before, be sure to check out the Getting Started guide.

From the same directory as your project's Gruntfile and package.json, install this plugin with the following command:

npm install grunt-tusk-coffee --save-dev

Once that's done, add this line to your project's Gruntfile:

grunt.loadNpmTasks('grunt-tusk-coffee');

If the plugin has been installed correctly, running grunt --help at the command line should list the newly-installed plugin's task or tasks. In addition, the plugin should be listed in package.json as a devDependency, which ensures that it will be installed whenever the npm install command is run.

The "commoncoffee" task

Overview

In your project's Gruntfile, add a section named commoncoffee to the data object passed into grunt.initConfig().

grunt.initConfig
  commoncoffee:
    your_target:
      options:
        # Task-specific options go here.
      files:
        # Target-specific file lists and/or options go here.

Options

options.root

Type: String Default value: '.'

The root of the module files.

For example, by default, to load the file "src/files/file1.coffee" in the browser you will run "require 'src/files/file1'".

If you set root to src/files you can use "require 'file1'"

options.runtime

Type: Boolean Default value: true

When true, add the require() method code at the beginning of each generated file.

options.wrap

Type: Boolean Default value: true

When true, wraps each file in a "window.require.register(...)" block.

Usage Examples

This is the way I use this plugin, the following configuration will generate two files:

• public/app.js - includes the require() method code and all of the compiled coffeescript files wrapped in modules.
• public/vendor.js - the combined vendor javascripts (without the require method code and without wrapping).

grunt.initConfig
  commoncoffee:
    app:
      options:
        root: 'src'
      files:
        'public/app.js': ['src/**/*.coffee'],

    vendor:
      options:
        wrap: false
        runtime: false
      files:
        'public/vendor.js': [
          'vendor/zepto/zepto.js',
          'vendor/backbone/backbone.js'
          'vendor/bootstrap/javascripts/*.js'
        ]

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.

Release History

(Nothing yet)