Skip to content

Commit

Permalink
Docs: Add example and API (closes #2)
Browse files Browse the repository at this point in the history
  • Loading branch information
phated committed Mar 23, 2017
1 parent 6ff3070 commit f622aca
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,37 @@ Gulp plugin for mapping sources of a sourcemap.
## Example

```js
// TODO
var mapSources = require('@gulp-sourcemaps/map-sources');

gulp.src(...)
.pipe(sourcemaps.init())
.pipe(mapSources(function(sourcePath, file) {
return '../' + sourcePath;
}))
.pipe(sourcemaps.write())
.pipe(gulp.dest(...))
```

## API

### `TODO`
### `mapSources(mapFn)`

Takes a map function as the only argument. Returns an `objectMode` Transform stream.

#### `mapFn(sourcePath, file)`

The map function is called once per value of the `sources` array of a `sourceMap` attached to each [`Vinyl`][vinyl-url] object passed through the stream. The map function is called with the `sourcePath` string from the `sources` array and the `file` object it originated from. The return value replaces the original value in the array.

If a `Vinyl` object doesn't have a `sourceMap` or `sourceMap.sources` property, the file is passed through the stream without having the `mapFn` called.

All `sources` 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-sources.svg
[npm-url]: https://npmjs.org/package/@gulp-sourcemaps/map-sources
[npm-image]: http://img.shields.io/npm/v/@gulp-sourcemaps/map-sources.svg
Expand Down

0 comments on commit f622aca

Please sign in to comment.