more elegant sourcemap handling, more docs

Author: Contra

README.md

@@ -1,6 +1,6 @@
 # vinyl-fs [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Dependency Status][depstat-image]][depstat-url]
 ## Information
-<table><br><tr><br><td>Package</td><td>vinyl-fs</td><br></tr><br><tr><br><td>Description</td><br><td>Vinyl adapter for the file system</td><br></tr><br><tr><br><td>Node Version</td><br><td>>= 0.10</td><br></tr><br></table>
+<table><br><tr><br><td>Package</td><td>vinyl-fs</td><br></tr><br><tr><br><td>Description</td><br><td>Vinyl adapter for the file system</td><br></tr><br><tr><br><td>Node Version</td><br><td>>= 0.10</td><br></tr><br></table>  
 
 ## Usage
 
@@ -50,7 +50,6 @@ fs.src(['*.js', '!b*.js'])
     - `false` will disable writing the file to disk via `.dest()`.
 
   - since - `Date` or `number` if you only want files that have been modified since the time specified.
-
   - stripBOM - `true` or `false` if you want the BOM to be stripped on UTF-8 encoded files.
     - Default value is `true`.
 
@@ -97,8 +96,14 @@ _Note:_ UTF-8 BOM will be stripped from all UTF-8 files read with `.src`.
 
   - sourcemaps -
     - Default is `null` aka do not write sourcemaps.
-    - Use `.` to write sourcemaps as files
     - Uses `gulp-sourcemaps` under the hood
+    - Examples:
+      - Write as inline comments
+      - fs.dest('./', {sourcemaps: true})
+      - Write as files in the same folder
+      - fs.dest('./', {<br>  sourcemaps: {<br>    path: '.'<br>  }<br>})
+      - Any other options are passed through to `gulp-sourcemaps`
+      - fs.dest('./', {<br>  sourcemaps: {<br>    path: '.',<br>    addComment: false,<br>    includeContent: false<br>  }<br>})
 
 - Returns a Readable/Writable stream.
 - On write the stream will save the [vinyl] File to disk at the folder/cwd specified.

lib/dest/index.js

@@ -3,14 +3,9 @@
 var through2 = require('through2');
 var sourcemaps = require('gulp-sourcemaps');
 var duplexify = require('duplexify');
-var ternaryStream = require('ternary-stream');
 var prepareWrite = require('../prepareWrite');
 var writeContents = require('./writeContents');
 
-function canSourceMap(file) {
-  return file.isBuffer();
-}
-
 function dest(outFolder, opt) {
   if (!opt) {
     opt = {};
@@ -25,8 +20,12 @@ function dest(outFolder, opt) {
     });
   }
 
-  var mapStream = ternaryStream(canSourceMap, sourcemaps.write(opt.sourcemaps));
   var saveStream = through2.obj(saveFile);
+  if (!opt.sourcemaps) {
+    return saveStream;
+  }
+
+  var mapStream = sourcemaps.write(opt.sourcemaps.path, opt.sourcemaps);
   var outputStream = duplexify.obj(mapStream, saveStream);
   mapStream.pipe(saveStream);
 

package.json

@@ -21,7 +21,6 @@
     "object-assign": "^4.0.0",
     "strip-bom": "^2.0.0",
     "strip-bom-stream": "^1.0.0",
-    "ternary-stream": "^1.2.3",
     "through2": "^2.0.0",
     "through2-filter": "^2.0.0",
     "vinyl": "^1.0.0"