grunt-annotated-requirejs

Optimize RequireJS projects using r.js, supporting annotations to define which AMD modules are compiled into one unified file with all it's dependencies included.

Getting Started

This plugin requires Grunt ~0.4.0

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-annotated-requirejs --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-annotated-requirejs');

This plugin was designed to work with Grunt 0.4.x. If you're still using grunt v0.3.x it's strongly recommended that you upgrade, but in case you can't please use v0.3.3.

Requirejs task

Run this task with the grunt requirejs command.

Task targets and options may be specified according to the grunt Configuring tasks guide.

Options

For a full list of possible options, see the r.js example build file.

This plugin adds the posibility to define regexp patterns into the r.js config to define which AMD modules will be treated as packages containing the module with all it's dependencies included in the same file. The regexp will be tested against the content of all modules included in the baseUrl directory tree.

Usage Examples

Gruntfile.js

requirejs: {
  compile: {
    options: {
      baseUrl: 'test/fixtures',
      dir: 'tmp',
      modules: [{pattern: /\/\/.*@packageModule/}]
    }
  }
}

project.js

//@packageModule
require(['hello', 'world'], function(hello, world) {
  console.log(hello,world);
});

Release History

• 2013-05-04   v0.1.1   Added some samples and rescriptions to README.md.
• 2013-05-04   v0.1.0   First release after forking contrib-requirejs.

Task submitted by Gabriel Jurgens

This file was generated on Sat May 04 2013 02:51:19.