Added support for source maps

Fixes #6

Author: jorrit

README.md

@@ -18,12 +18,12 @@ A small, simple, very easy wrapper around the [require.js optimizer](https://git
 </tr>
 <tr>
 <td>Node Version</td>
-<td>>= 4</td>
+<td>≧ 4</td>
 </tr>
 </table>
 
 
-##Installation
+## Installation
 
 Simply add `gulp-requirejs` as a dev-dependency in your package.json or run
 
@@ -64,6 +64,33 @@ gulp-requirejs will emit errors when you don't pass an options object and if the
 
 The require.js optimizer itself might also emit errors; unfortunately there's no way of catching them elegantly at the moment.
 
+### Source maps
+
+When source maps are enabled via the r.js `generateSourceMaps` option the stream returned by `rjs()` contains an additional file named the same as the `out` option with `.map` appended.
+
+Use [gulp-sourcemaps](https://www.npmjs.com/package/gulp-sourcemaps) to use this file
+in your gulp configuration:
+
+```javascript
+var gulp = require('gulp'),
+    rjs = require('gulp-requirejs')
+    sourcemaps = require('gulp-sourcemaps');
+
+gulp.task('requirejsBuild', function() {
+    return rjs({
+        baseUrl: 'path/to/your/base/file.js',
+        out: 'FILENAME_TO_BE_OUTPUTTED',
+        generateSourceMaps: true,
+        shim: {
+            // standard require.js shim options
+        },
+        // ... more require.js options
+    })
+    .pipe(sourcemaps.init({loadMaps: true})) // initialize gulp-sourcemaps with the existing map
+    .pipe(sourcemaps.write()) // write the source maps
+    .pipe(gulp.dest('./deploy/')); // pipe it to the output DIR
+});
+```
 
 ## Options
 

index.js

@@ -27,7 +27,7 @@ module.exports = function(opts) {
     // create the stream and save the file name (opts.out will be replaced by a callback function later)
     var _s       = es.pause(),
         _fName   = opts.out,
-        _success = function(text, buildResponse) {
+        _success = function(text, buildResponse, sourceMap) {
             var newFile = new File({
                 path: _fName,
                 contents: new Buffer(text)
@@ -36,6 +36,12 @@ module.exports = function(opts) {
             // debugging purposes.
             newFile.buildResponse = buildResponse.replace('FUNCTION', _fName);
             _s.write(newFile);
+            if (sourceMap) {
+                _s.write(new File({
+                    path: _fName + '.map',
+                    contents: new Buffer(sourceMap)
+                }));
+            }
             _s.resume();
             _s.end();
         },
@@ -55,9 +61,11 @@ module.exports = function(opts) {
 // a small wrapper around the r.js optimizer
 function optimize(opts, successFn, errorFn) {
     var output = null;
-    opts.out = function(text) {
+    var sourceMapOutput = null;
+    opts.out = function(text, sourceMap) {
         output = text;
+        sourceMapOutput = sourceMap;
     }
     opts.optimize = opts.optimize || 'none';
-    requirejs.optimize(opts, function(buildResponse) { successFn(output, buildResponse); }, errorFn);
+    requirejs.optimize(opts, function(buildResponse) { successFn(output, buildResponse, sourceMapOutput); }, errorFn);
 }

test/main.js

@@ -27,6 +27,41 @@ describe('gulp-requirejs', function() {
         stream.on('end', done);
     });
 
+    it('should emit source map file when configured', function(done) {
+        var filesInPipe = [];
+
+        var stream = grjs({
+            out: 'simple_init.js',
+
+            baseUrl: 'test/fixtures/',
+
+            findNestedDependencies: true,
+            skipPragmas: true,
+            generateSourceMaps: true,
+
+            name: 'simple_init',
+
+            include: ['simple_init'],
+
+            create: true
+        });
+
+        stream.on('data', (chunk) => {
+            filesInPipe.push(chunk.path);
+        });
+
+        stream.on('end', function() {
+            try {
+                filesInPipe.length.should.equal(2);
+                filesInPipe.should.containEql('simple_init.js');
+                filesInPipe.should.containEql('simple_init.js.map');
+                done();
+            } catch(e) {
+                done(e);
+            }
+        });
+    });
+
     describe('simple AMD file', function() {
 
         it('should concat the files in the correct order', function(done) {