Optimize RequireJS projects using r.js
npm install grunt-contrib-requirejs> Optimize RequireJS projects using r.js
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:
``shell`
npm install grunt-contrib-requirejs --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
`js`
grunt.loadNpmTasks('grunt-contrib-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.
command._Task targets and options may be specified according to the grunt Configuring tasks guide.
$3
For a full list of possible options, see the r.js example build file.
#### done(done, build)
The done option is an optional hook to receive the r.js build output. The first argument is the grunt async callback that you are required to call if you provide the done hook. This informs grunt that the task is complete. The second parameter is the build output from r.js.
$3
`js
requirejs: {
compile: {
options: {
baseUrl: "path/to/base",
mainConfigFile: "path/to/config.js",
name: "path/to/almond", /* assumes a production build using almond, if you don't use almond, you
need to set the "includes" or "modules" option instead of name */
include: [ "src/main.js" ],
out: "path/to/optimized.js"
}
}
}
`#### Done
js
requirejs: {
compile: {
options: {
baseUrl: "path/to/base",
mainConfigFile: "path/to/config.js",
done: function(done, output) {
var duplicates = require('rjs-build-analysis').duplicates(output); if (Object.keys(duplicates).length) {
grunt.log.subhead('Duplicates found in requirejs build:');
grunt.log.warn(duplicates);
return done(new Error('r.js built duplicate modules, please check the excludes option.'));
}
done();
}
}
}
}
`#### Error
js
requirejs: {
compile: {
options: {
baseUrl: "path/to/base",
mainConfigFile: "path/to/config.js",
error: function(done, err) {
grunt.log.warn(err);
done();
}
}
}
}
`
Release History
* 2016-03-04 v1.0.0 Update usage example to show a working usage. Remove peerDep and point to main task. rjs-build-analysis returns an object not an array. Made clear that usage of almond is not required. added error option to handle r.js errors.
* 2014-04-25 v0.4.4 Reduce logging verbosity unless --verbose flag is used.
* 2014-02-26 v0.4.3 Remove "Gruntfile.js" as package.json main.
* 2014-02-26 v0.4.2 Catch exceptions in
---
Task submitted by Tyler Kellen
This file was generated on Fri Mar 04 2016 16:13:43.