New: Initial implementation

phated · phated · commit af9f0f4ba366 · 2017-03-23T18:48:36.000-07:00
diff --git a/README.md b/README.md
@@ -1,2 +1,52 @@
-# map-file
+# @gulp-sourcemaps/map-file
+
+[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![AppVeyor Build Status][appveyor-image]][appveyor-url] [![Coveralls Status][coveralls-image]][coveralls-url]
+
 Gulp plugin for changing the file property of a sourcemap.
+
+## Example
+
+```js
+var mapFile = require('@gulp-sourcemaps/map-file');
+
+gulp.src(...)
+  .pipe(sourcemaps.init())
+  .pipe(sourcemaps.write())
+  .pipe(mapFile(function(filePath, file) {
+    return '../' + filePath;
+  }))
+  .pipe(gulp.dest(...))
+```
+
+## API
+
+### `mapFile(mapFn)`
+
+Takes a map function as the only argument. Returns an `objectMode` Transform stream.
+
+#### `mapFn(filePath, file)`
+
+The map function is called once per each [`Vinyl`][vinyl-url] object passed through the stream that contains a sourcemap.  The map function is called with the `filePath` string from the `file` property of the sourcemap and the `file` object it originated from.  The return value replaces the original value.
+
+If a `Vinyl` object doesn't have a `sourceMap` property, the file is passed through the stream without having the `mapFn` called. If the `sourceMap.file` property doesn't exist, `filePath` will be undefined.
+
+All `file` properties are normalized to use `/` instead of `\\` as path separators.
+
+## License
+
+MIT
+
+[vinyl-url]: https://github.com/gulpjs/vinyl
+
+[downloads-image]: http://img.shields.io/npm/dm/@gulp-sourcemaps/map-file.svg
+[npm-url]: https://npmjs.org/package/@gulp-sourcemaps/map-file
+[npm-image]: http://img.shields.io/npm/v/@gulp-sourcemaps/map-file.svg
+
+[travis-url]: https://travis-ci.org/gulp-sourcemaps/map-file
+[travis-image]: http://img.shields.io/travis/gulp-sourcemaps/map-file.svg?label=travis-ci
+
+[appveyor-url]: https://ci.appveyor.com/project/phated/map-file
+[appveyor-image]: https://img.shields.io/appveyor/ci/phated/map-file.svg?label=appveyor
+
+[coveralls-url]: https://coveralls.io/r/gulp-sourcemaps/map-file
+[coveralls-image]: http://img.shields.io/coveralls/gulp-sourcemaps/map-file.svg
diff --git a/index.js b/index.js
@@ -0,0 +1,30 @@
+'use strict';
+
+var through = require('through2');
+var normalize = require('normalize-path');
+
+function mapFile(mapFn) {
+
+  function transform(file, _, cb) {
+    if (!file.sourceMap) {
+      return cb(null, file);
+    }
+
+    function mapper(filePath) {
+      var result = filePath;
+      if (typeof mapFn === 'function') {
+        result = mapFn(filePath, file);
+      }
+
+      return normalize(result);
+    }
+
+    file.sourceMap.file = mapper(file.sourceMap.file);
+
+    cb(null, file);
+  }
+
+  return through.obj(transform);
+}
+
+module.exports = mapFile;
diff --git a/package.json b/package.json
@@ -23,7 +23,10 @@
     "cover": "istanbul cover _mocha --report lcovonly",
     "coveralls": "npm run cover && istanbul-coveralls"
   },
-  "dependencies": {},
+  "dependencies": {
+    "normalize-path": "^2.0.1",
+    "through2": "^2.0.3"
+  },
   "devDependencies": {
     "eslint": "^1.7.3",
     "eslint-config-gulp": "^2.0.0",
diff --git a/test/index.js b/test/index.js
@@ -0,0 +1,206 @@
+'use strict';
+
+var expect = require('expect');
+
+var miss = require('mississippi');
+var File = require('vinyl');
+var normalize = require('normalize-path');
+
+var mapFile = require('../');
+
+var pipe = miss.pipe;
+var from = miss.from;
+var concat = miss.concat;
+
+function makeFile() {
+  var file = new File({
+    cwd: __dirname,
+    base: __dirname + '/assets',
+    path: __dirname + '/assets/helloworld.js',
+    contents: null,
+  });
+
+  file.sourceMap = {
+    version: 3,
+    file: 'helloworld.js',
+    names: [],
+    mappings: '',
+    sources: ['helloworld.js', 'helloworld2.js'],
+  };
+
+  return file;
+}
+
+describe('mapFile', function() {
+
+  it('ignores a file without sourceMap property', function(done) {
+    var file = makeFile();
+    delete file.sourceMap;
+
+    var spy = expect.createSpy();
+
+    function assert(files) {
+      expect(files.length).toEqual(1);
+      expect(spy).toNotHaveBeenCalled();
+    }
+
+    pipe([
+      from.obj([file]),
+      mapFile(spy),
+      concat(assert),
+    ], done);
+  });
+
+  it('only ignores a file without sourceMap property', function(done) {
+    var file = makeFile();
+    delete file.sourceMap;
+    var file2 = makeFile();
+
+    function mapFn(filePath) {
+      return filePath;
+    }
+
+    var spy = expect.createSpy().andCall(mapFn);
+
+    function assert(files) {
+      expect(files.length).toEqual(2);
+      expect(spy.calls.length).toEqual(1);
+    }
+
+    pipe([
+      from.obj([file, file2]),
+      mapFile(spy),
+      concat(assert),
+    ], done);
+  });
+
+  it('calls map function per file', function(done) {
+    var file = makeFile();
+
+    function mapFn(filePath) {
+      return '/test/' + filePath;
+    }
+
+    function assert(files) {
+      expect(files.length).toEqual(1);
+      expect(files[0].sourceMap.file).toEqual('/test/helloworld.js');
+    }
+
+    pipe([
+      from.obj([file]),
+      mapFile(mapFn),
+      concat(assert),
+    ], done);
+  });
+
+  it('normalizes Windows paths to unix paths', function(done) {
+    var file = makeFile();
+
+    function mapFn(filePath) {
+      return '\\test\\' + filePath;
+    }
+
+    function assert(files) {
+      expect(files.length).toEqual(1);
+      expect(files[0].sourceMap.file).toEqual('/test/helloworld.js');
+    }
+
+    pipe([
+      from.obj([file]),
+      mapFile(mapFn),
+      concat(assert),
+    ], done);
+  });
+
+  it('does not need a map function', function(done) {
+    var file = makeFile();
+
+    function assert(files) {
+      expect(files.length).toEqual(1);
+      expect(files[0].sourceMap.file).toEqual('helloworld.js');
+    }
+
+    pipe([
+      from.obj([file]),
+      mapFile(),
+      concat(assert),
+    ], done);
+  });
+
+  it('ignores non-function argument', function(done) {
+    var file = makeFile();
+
+    function assert(files) {
+      expect(files.length).toEqual(1);
+      expect(files[0].sourceMap.file).toEqual('helloworld.js');
+    }
+
+    pipe([
+      from.obj([file]),
+      mapFile('invalid argument'),
+      concat(assert),
+    ], done);
+  });
+
+  it('still normalizes without a map function', function(done) {
+    var file = makeFile();
+    file.sourceMap.file = '\\test\\' + file.sourceMap.file;
+
+    function assert(files) {
+      expect(files.length).toEqual(1);
+      expect(files[0].sourceMap.file).toEqual('/test/helloworld.js');
+    }
+
+    pipe([
+      from.obj([file]),
+      mapFile(),
+      concat(assert),
+    ], done);
+  });
+
+  it('calls map function with the filePath and the vinyl file', function(done) {
+    var file = makeFile();
+
+    function mapFn(filePath, file) {
+      expect(File.isVinyl(file)).toEqual(true);
+
+      return file.base + '/' + filePath;
+    }
+
+    function assert(files) {
+      expect(files.length).toEqual(1);
+
+      var file = files[0];
+      var base = normalize(file.base);
+
+      expect(file.sourceMap.file).toEqual(base + '/helloworld.js');
+    }
+
+    pipe([
+      from.obj([file]),
+      mapFile(mapFn),
+      concat(assert),
+    ], done);
+  });
+
+  it('calls map function with undefined if sourceMap.file is undefined', function(done) {
+    var file = makeFile();
+    delete file.sourceMap.file;
+
+    function mapFn(filePath) {
+      expect(filePath).toEqual(undefined);
+      return 'test';
+    }
+
+    function assert(files) {
+      expect(files.length).toEqual(1);
+      expect(files[0].sourceMap.file).toEqual('test');
+    }
+
+    pipe([
+      from.obj([file]),
+      mapFile(mapFn),
+      concat(assert),
+    ], done);
+  });
+});
