Builds projects using require.js's optimizer
npm install requirejs-stream#requirejs-stream
A small, simply, very easy wrapper around the require.js optimizer to work with gulp.js
| Package | gulp-requirejs |
| Description | uses require.js's r.js optimizer to combine require.js AMD modules into one file |
| Node Version | >= 0.4 |
##Installation
Simply add requirejs-stream as a dev-dependency in your package.json or run
`bash`
$ npm install --save-dev requirejs-stream
Because the require.js optimizer (_r.js_) is a kind of build system in itself we can't use the gulp.src([...]) syntax at the moment (I might add this in future), instead this wrapper itself emits a pipable stream, holding a 'virtual' file, in which the result of the r.js build process are saved.
The resulting stream can be treated like a regular gulp.src(...) stream.
>NOTE: The built in minification/obfuscation is deactivated by default and can not be switched on. Please use a gulp plugin like gulp-uglify for this.
`javascript
var gulp = require('gulp'),
rjs = require('requirejs-stream');
gulp.task('requirejsBuild', function() {
rjs({
baseUrl: 'path/to/your/base/file.js',
out: 'FILENAME\_TO\_BE\_OUTPUTTED',
shim: {
// standard require.js shim options
},
// ... more require.js options
})
.pipe(gulp.dest('./delpoy/')); // pipe it to the output DIR
});
`
gulp-requirejs will emit errors when you don't pass an options object and if the baseUrl or out` properties are undefined.
The requiere.js optimizer itself might also emit errors; unfortunately there's no way of catching them elegantly at the moment.
The options object supports the same parameters as the require.js optimizer.