🌀 Use conventional text streams at the start of your gulp or vinyl pipelines
Clone or download
Latest commit 502f2e5 Dec 23, 2017
Type Name Latest commit message Commit time
Failed to load latest commit information.
LICENSE.md first commit Jan 11, 2014
README.md Fixed a grammar typo ("there's") in the readme (#20) Dec 22, 2017
index.js resolve relative to process.cwd() by default Mar 6, 2015
package.json 2.0.0 Dec 23, 2017
test.js Upgrade vinyl & tests Dec 23, 2017


vinyl-source-stream Flattr this!experimental

Use conventional text streams at the start of your gulp or vinyl pipelines, making for nicer interoperability with the existing npm stream ecosystem.

Take, for example, browserify. There are the gulp-browserify and gulpify plugins, which you can use in combination with gulp to get browserify working in your build. Unfortunately, these plugins come with additional overhead: an extra GitHub repository, npm module, maintainer, tests, semantics, etc. It's much simpler in this case to use the original module directly where you can, which is what vinyl-source-stream handles for you.



Our previous example, browserify, has a streaming API for its output bundles which you can use directly. This module is just a bridge that makes it simple to use conventional text streams such as this in combination with gulp. Here's an example of using vinyl-source-stream and browserify, compared to using gulpify:

var source = require('vinyl-source-stream')
var streamify = require('gulp-streamify')
var browserify = require('browserify')
var uglify = require('gulp-uglify')
var gulpify = require('gulpify')
var rename = require('gulp-rename')
var gulp = require('gulp')

// using gulpify:
gulp.task('gulpify', function() {

// using vinyl-source-stream:
gulp.task('browserify', function() {
  var bundleStream = browserify('./index.js').bundle()


Not all that different, really! The nice thing here is that you're getting the up-to-date browserify API and don't have to worry about the plugin's available functionality. Of course, these same benefits apply for any readable text stream you can find on npm.


stream = sourceStream([filename])

Creates a through stream which takes text as input, and emits a single vinyl file instance for streams down the pipeline to consume.

filename is a "pretend" filename to use for your file, which some streams might use to determine various factors such as the final filename of your file. It should be a string, and though recommended, using this argument is optional.


MIT. See LICENSE.md for details.