Merge pull request #2 from twada/gulp-sourcemaps

gulp-sourcemaps  support

Author: twada

README.md

@@ -30,6 +30,31 @@ gulp.src("./test/*.js")
     .pipe(gulp.dest("./dist"));
 ```
 
+
+## Source maps
+
+gulp-espower can be used with [gulp-sourcemaps](https://github.com/floridoo/gulp-sourcemaps) to generate source maps for the instrumented javascript code. Note that you should `init` gulp-sourcemaps prior to running the gulp-espower and `write` the source maps after. gulp-espower works well with some gulp plugins that supports [gulp-sourcemaps](https://github.com/floridoo/gulp-sourcemaps).
+
+```javascript
+var espower = require("gulp-espower");
+var coffee = require("gulp-coffee");
+var concat = require("gulp-concat");
+var sourcemaps = require("gulp-sourcemaps");
+
+// compile, instrument then concatinate
+gulp.src("./test/*test.coffee")
+    .pipe(sourcemaps.init())
+    .pipe(coffee())
+    .pipe(espower())
+    .pipe(concat('all_test.js'))
+    .pipe(sourcemaps.write())
+    .pipe(gulp.dest("./build"));
+// will write the source maps inline in the code
+```
+
+For more information, see [gulp-sourcemaps](https://github.com/floridoo/gulp-sourcemaps).
+
+
 ## API
 
 ### espower(options)

index.js

@@ -7,31 +7,92 @@
  * Licensed under the MIT license.
  *   https://github.com/twada/gulp-espower/blob/master/LICENSE-MIT
  */
+'use strict';
+
 var through = require('through2'),
     gutil = require('gulp-util'),
+    extend = require('xtend'),
     BufferStreams = require('bufferstreams'),
-    espowerSource = require('espower-source');
+    espower = require('espower'),
+    espowerSource = require('espower-source'),
+    esprima = require('esprima'),
+    escodegen = require('escodegen'),
+    applySourceMap = require('vinyl-sourcemaps-apply'),
+    transfer = require('multi-stage-sourcemap').transfer,
+    convert = require('convert-source-map');
 
-module.exports = function (opt) {
-    'use strict';
+function mergeSourceMap(incomingSourceMap, outgoingSourceMap) {
+    if (typeof outgoingSourceMap === 'string' || outgoingSourceMap instanceof String) {
+        outgoingSourceMap = JSON.parse(outgoingSourceMap);
+    }
+    if (!incomingSourceMap) {
+        return outgoingSourceMap;
+    }
+    return JSON.parse(transfer({fromSourceMap: outgoingSourceMap, toSourceMap: incomingSourceMap}));
+}
+
+function transform (file, encoding, opt) {
+    var inMap = file.sourceMap;
+    var escodegenOptions = {};
+    var jsCode = file.contents.toString(encoding);
 
-    var transform = function (code, path) {
-        return new Buffer(espowerSource(code, path, opt));
-    };
+    // use file.relative to keep paths relative until the end of chain
+    var jsAst = esprima.parse(jsCode, {tolerant: true, loc: true, source: file.relative});
+
+    var espowerOptions = extend(espower.defaultOptions(), opt, {
+        destructive: true,
+        path: file.path
+    });
+    if (inMap) {
+        espowerOptions.sourceMap = inMap;
+        escodegenOptions = extend(escodegenOptions, {
+            file: file.relative,
+            sourceMap: true,
+            // do not set sourceMapRoot to keep paths relative until the end of chain
+            // sourceMapRoot: file.base,
+            sourceMapWithCode: true
+        });
+    }
+    var modifiedAst = espower(jsAst, espowerOptions);
+    var escodegenOutput = escodegen.generate(modifiedAst, escodegenOptions);
+    if (inMap) {
+        file.contents = new Buffer(escodegenOutput.code);
+        var outMap = convert.fromJSON(escodegenOutput.map.toString());
+        outMap.setProperty('sources', inMap.sources);
+        outMap.setProperty('sourcesContent', inMap.sourcesContent);
 
+        var reMap;
+        if (inMap.mappings === '') {
+            applySourceMap(file, outMap.toJSON());
+            reMap = convert.fromObject(file.sourceMap);
+        } else {
+            reMap = convert.fromObject(mergeSourceMap(inMap, outMap.toJSON()));
+        }
+        reMap.setProperty('sources', inMap.sources);
+        reMap.setProperty('sourcesContent', inMap.sourcesContent);
+        // do not set sourceMapRoot to keep paths relative until the end of chain
+        // reMap.setProperty('sourceRoot', file.base);
+
+        file.sourceMap = reMap.toObject();
+    } else {
+        file.contents = new Buffer(escodegenOutput);
+    }
+}
+
+module.exports = function (opt) {
     return through.obj(function (file, encoding, callback) {
         encoding = encoding || 'utf8';
         if (file.isNull()) {
             this.push(file);
         } else if (file.isBuffer()) {
-            file.contents = transform(file.contents.toString(encoding), file.path);
+            transform(file, encoding, opt);
             this.push(file);
         } else if (file.isStream()) {
             file.contents = file.contents.pipe(new BufferStreams(function(err, buf, cb) {
                 if(err) {
                     cb(new gutil.PluginError('gulp-espower', err, {showStack: true}));
                 } else {
-                    cb(null, transform(buf.toString(encoding), file.path));
+                    cb(null, new Buffer(espowerSource(buf.toString(encoding), file.path, opt)));
                 }
             }));
             this.push(file);

package.json

@@ -33,18 +33,25 @@
   },
   "scripts": {
     "jshint": "jshint index.js",
-    "test": "mocha"
+    "test": "jshint index.js && mocha"
   },
   "dependencies": {
     "bufferstreams": "~0.0.2",
-    "espower-source": "~0.8.0",
+    "convert-source-map": "~0.4.1",
+    "escodegen": "~1.4.0",
+    "espower": "~0.9.0",
+    "espower-source": "~0.9.0",
+    "esprima": "~1.2.2",
     "gulp-util": "~3.0.0",
-    "through2": "~1.0.0"
+    "multi-stage-sourcemap": "~0.2.1",
+    "through2": "~1.1.1",
+    "vinyl-sourcemaps-apply": "~0.1.1",
+    "xtend": "~4.0.0"
   },
   "devDependencies": {
     "event-stream": "~3.1.7",
-    "jshint": "~2.5.2",
-    "mocha": "~1.21.0"
+    "jshint": "~2.5.5",
+    "mocha": "~1.21.4"
   },
   "engines": {
     "node": ">=0.8.0",

test/expected/customized-with-sourcemap.js

@@ -23,4 +23,3 @@ refute.same(refute._expr(refute._capt(truthy, 'arguments/0'), {
     filepath: 'test/fixtures/customized.js',
     line: 9
 }));
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInRlc3QvZml4dHVyZXMvY3VzdG9taXplZC5qcyJdLCJuYW1lcyI6WyJlbXBvd2VyIiwicmVxdWlyZSIsImZvcm1hdHRlciIsImJ1c3RlckFzc2VydGlvbnMiLCJyZWZ1dGUiLCJ0YXJnZXRNZXRob2RzIiwib25lQXJnIiwidHdvQXJncyIsInRydXRoeSIsImZhbHN5IiwiX2V4cHIiLCJfY2FwdCIsImNvbnRlbnQiLCJmaWxlcGF0aCIsImxpbmUiLCJpc051bGwiLCJzYW1lIl0sIm1hcHBpbmdzIjoiQUFBQSxJQUFJQSxPQUFBLEdBQVVDLE9BQUEsQ0FBUSxTQUFSLENBQWQsRUFDSUMsU0FBQSxHQUFZRCxPQUFBLENBQVEsd0JBQVIsQ0FEaEIsRUFFSUUsZ0JBQUEsR0FBbUJGLE9BQUEsQ0FBUSxtQkFBUixDQUZ2QixFQUdJRyxNQUFBLEdBQVNKLE9BQUEsQ0FBUUcsZ0JBQUEsQ0FBaUJDLE1BQXpCLEVBQWlDRixTQUFBLEVBQWpDLEVBQThDO0FBQUEsUUFBRUcsYUFBQSxFQUFlO0FBQUEsWUFBRUMsTUFBQSxFQUFRLENBQUMsUUFBRCxDQUFWO0FBQUEsWUFBc0JDLE9BQUEsRUFBUyxDQUFDLE1BQUQsQ0FBL0I7QUFBQSxTQUFqQjtBQUFBLEtBQTlDLENBSGIsRUFJSUMsTUFBQSxHQUFTLE1BSmIsRUFLSUMsS0FBQSxHQUFRLE9BTFo7QUFNQUwsTUFBQSxDQUFPQSxNQUFBLENBQUFNLEtBQUEsQ0FBQU4sTUFBQSxDQUFBTyxLQUFBLENBQUFILE1BQUE7QUFBQSxJQUFBSSxPQUFBO0FBQUEsSUFBQUMsUUFBQTtBQUFBLElBQUFDLElBQUE7QUFBQSxFQUFQLEVBTkE7QUFPQVYsTUFBQSxDQUFPVyxNQUFQLENBQWNYLE1BQUEsQ0FBQU0sS0FBQSxDQUFBTixNQUFBLENBQUFPLEtBQUEsQ0FBQUYsS0FBQTtBQUFBLElBQUFHLE9BQUE7QUFBQSxJQUFBQyxRQUFBO0FBQUEsSUFBQUMsSUFBQTtBQUFBLEVBQWQsRUFQQTtBQVFBVixNQUFBLENBQU9ZLElBQVAsQ0FBWVosTUFBQSxDQUFBTSxLQUFBLENBQUFOLE1BQUEsQ0FBQU8sS0FBQSxDQUFBSCxNQUFBO0FBQUEsSUFBQUksT0FBQTtBQUFBLElBQUFDLFFBQUE7QUFBQSxJQUFBQyxJQUFBO0FBQUEsRUFBWixFQUFvQlYsTUFBQSxDQUFBTSxLQUFBLENBQUFOLE1BQUEsQ0FBQU8sS0FBQSxDQUFBRixLQUFBO0FBQUEsSUFBQUcsT0FBQTtBQUFBLElBQUFDLFFBQUE7QUFBQSxJQUFBQyxJQUFBO0FBQUEsRUFBcEIiLCJzb3VyY2VzQ29udGVudCI6WyJ2YXIgZW1wb3dlciA9IHJlcXVpcmUoJ2VtcG93ZXInKSxcbiAgICBmb3JtYXR0ZXIgPSByZXF1aXJlKCdwb3dlci1hc3NlcnQtZm9ybWF0dGVyJyksXG4gICAgYnVzdGVyQXNzZXJ0aW9ucyA9IHJlcXVpcmUoXCJidXN0ZXItYXNzZXJ0aW9uc1wiKSxcbiAgICByZWZ1dGUgPSBlbXBvd2VyKGJ1c3RlckFzc2VydGlvbnMucmVmdXRlLCBmb3JtYXR0ZXIoKSwgeyB0YXJnZXRNZXRob2RzOiB7IG9uZUFyZzogWydpc051bGwnXSwgdHdvQXJnczogWydzYW1lJ10gfSB9KSxcbiAgICB0cnV0aHkgPSAndHJ1ZScsXG4gICAgZmFsc3kgPSAnZmFsc2UnO1xucmVmdXRlKHRydXRoeSk7XG5yZWZ1dGUuaXNOdWxsKGZhbHN5KTtcbnJlZnV0ZS5zYW1lKHRydXRoeSwgZmFsc3kpO1xuIl19

test/expected/customized.js

@@ -13,4 +13,3 @@ assert.equal(assert._expr(assert._capt(truthy, 'arguments/0'), {
     filepath: 'test/fixtures/example.js',
     line: 5
 }));
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInRlc3QvZml4dHVyZXMvZXhhbXBsZS5qcyJdLCJuYW1lcyI6WyJhc3NlcnQiLCJyZXF1aXJlIiwidHJ1dGh5IiwiZmFsc3kiLCJfZXhwciIsIl9jYXB0IiwiY29udGVudCIsImZpbGVwYXRoIiwibGluZSIsImVxdWFsIl0sIm1hcHBpbmdzIjoiQUFBQSxJQUFJQSxNQUFBLEdBQVNDLE9BQUEsQ0FBUSxjQUFSLENBQWIsRUFDSUMsTUFBQSxHQUFTLE1BRGIsRUFFSUMsS0FBQSxHQUFRLE9BRlo7QUFHQUgsTUFBQSxDQUFPQSxNQUFBLENBQUFJLEtBQUEsQ0FBQUosTUFBQSxDQUFBSyxLQUFBLENBQUFGLEtBQUE7QUFBQSxJQUFBRyxPQUFBO0FBQUEsSUFBQUMsUUFBQTtBQUFBLElBQUFDLElBQUE7QUFBQSxFQUFQLEVBSEE7QUFJQVIsTUFBQSxDQUFPUyxLQUFQLENBQWFULE1BQUEsQ0FBQUksS0FBQSxDQUFBSixNQUFBLENBQUFLLEtBQUEsQ0FBQUgsTUFBQTtBQUFBLElBQUFJLE9BQUE7QUFBQSxJQUFBQyxRQUFBO0FBQUEsSUFBQUMsSUFBQTtBQUFBLEVBQWIsRUFBcUJSLE1BQUEsQ0FBQUksS0FBQSxDQUFBSixNQUFBLENBQUFLLEtBQUEsQ0FBQUYsS0FBQTtBQUFBLElBQUFHLE9BQUE7QUFBQSxJQUFBQyxRQUFBO0FBQUEsSUFBQUMsSUFBQTtBQUFBLEVBQXJCIiwic291cmNlc0NvbnRlbnQiOlsidmFyIGFzc2VydCA9IHJlcXVpcmUoJ3Bvd2VyLWFzc2VydCcpLFxuICAgIHRydXRoeSA9ICd0cnVlJyxcbiAgICBmYWxzeSA9ICdmYWxzZSc7XG5hc3NlcnQoZmFsc3kpO1xuYXNzZXJ0LmVxdWFsKHRydXRoeSwgZmFsc3kpO1xuIl19