Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gruntjs/grunt-contrib-requirejs
Optimize RequireJS projects using r.js.
https://github.com/gruntjs/grunt-contrib-requirejs
Last synced: about 1 month ago
JSON representation
Optimize RequireJS projects using r.js.
- Host: GitHub
- URL: https://github.com/gruntjs/grunt-contrib-requirejs
- Owner: gruntjs
- License: mit
- Created: 2012-09-08T18:21:05.000Z (about 12 years ago)
- Default Branch: main
- Last Pushed: 2022-01-03T16:28:45.000Z (over 2 years ago)
- Last Synced: 2024-08-01T05:28:09.471Z (about 2 months ago)
- Language: JavaScript
- Homepage: http://gruntjs.com/
- Size: 65.4 KB
- Stars: 504
- Watchers: 23
- Forks: 105
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- Contributing: CONTRIBUTING.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# grunt-contrib-requirejs v1.0.0 [](https://travis-ci.org/gruntjs/grunt-contrib-requirejs) [](https://ci.appveyor.com/project/gruntjs/grunt-contrib-requirejs/branch/master)
> Optimize RequireJS projects using r.js
## Getting Started
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-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](http://gruntjs.com/upgrading-from-0.3-to-0.4), but in case you can't please use [v0.3.3](https://github.com/gruntjs/grunt-contrib-requirejs/tree/grunt-0.3-stable).*
## Requirejs task
_Run this task with the `grunt requirejs` command._
Task targets and options may be specified according to the grunt [Configuring tasks](http://gruntjs.com/configuring-tasks) guide.
### Options
For a full list of possible options, [see the r.js example build file](https://github.com/jrburke/r.js/blob/master/build/example.build.js).
#### 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.
### Usage Examples
```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 `done`.
* 2013-05-16 v0.4.1 Add `done` option.
* 2013-02-15 v0.4.0 First official release for Grunt 0.4.0.
* 2013-01-23 v0.4.0rc7 Updating to work with grunt v0.4.0rc7.
* 2013-01-09 v0.4.0rc5 Updating to work with grunt v0.4.0rc5.
* 2012-10-12 v0.3.3 Rename grunt-contrib-lib dep to grunt-lib-contrib.
* 2012-10-09 v0.3.1 Bump to RequireJS 2.1.x. Run optimizer async.
* 2012-09-23 v0.3.0 Options no longer accepted from global config key.
* 2012-09-10 v0.2.0 Refactored from grunt-contrib into individual repo.
---
Task submitted by [Tyler Kellen](http://goingslowly.com/)
*This file was generated on Thu Apr 07 2016 15:25:57.*