Skip to content

Commit

Permalink
more sourcemaps docs
Browse files Browse the repository at this point in the history
  • Loading branch information
yocontra authored and phated committed Nov 27, 2017
1 parent f499910 commit 85a396e
Showing 1 changed file with 8 additions and 13 deletions.
21 changes: 8 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +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>
<tr>
<td>Package</td><td>vinyl-fs</td>
</tr>
<tr>
<td>Description</td>
<td>Vinyl adapter for the file system</td>
</tr>
<tr>
<td>Node Version</td>
<td>>= 0.10</td>
</tr>
</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

Expand Down Expand Up @@ -67,6 +55,8 @@ fs.src(['*.js', '!b*.js'])

- sourcemaps - `true` or `false` if you want files to have sourcemaps enabled.
- Default is `false`.
- Will load inline sourcemaps and resolve sourcemap links from files
- Uses `gulp-sourcemaps` under the hood
- followSymlinks - `true` if you want to recursively resolve symlinks to their targets; set to `false` to preserve them as symlinks.
- Default is `true`.
- `false` will make `file.symlink` equal the original symlink's target path.
Expand Down Expand Up @@ -109,6 +99,11 @@ This is just [glob-watcher].
- overwrite - Specify if existing files with the same path should be overwritten or not.
- Default is `true`, to always overwrite existing files.

- sourcemaps -
- Default is `null` aka do not write sourcemaps.
- Use `.` to write sourcemaps as files
- Uses `gulp-sourcemaps` under the hood

- Returns a Readable/Writable stream.
- On write the stream will save the [vinyl] File to disk at the folder/cwd specified.
- After writing the file to disk, it will be emitted from the stream so you can keep piping these around.
Expand Down

0 comments on commit 85a396e

Please sign in to comment.