vinyl-source-stream
    Overview
    Documentation
    Insights
    Code
    Contributors
    Dependencies
    Alternatives

vinyl-source-stream

Use conventional text streams at the start of your gulp or vinyl pipelines

2.0.0  •  Published 2 years ago  •  by Hugh Kennedy  •  MIT License

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.

Usage

vinyl-source-stream

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() {
  gulp.src('index.js')
    .pipe(gulpify())
    .pipe(uglify())
    .pipe(rename('bundle.js'))
    .pipe(gulp.dest('./'))
})

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

  bundleStream
    .pipe(source('index.js'))
    .pipe(streamify(uglify()))
    .pipe(rename('bundle.js'))
    .pipe(gulp.dest('./'))
})

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.

API

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.

License

MIT. See LICENSE.md for details.

Popularity

Weekly Downloads
129.2K
Stars
339

Maintenance

Development

Last ver 2 years ago
Created 6 years ago
Last commit 2 years ago
2 months between commits

Technology

Node version: 0.10.48
0 unpacked

Compliance

MIT License
OSI Approved
0 vulnerabilities

Contributors

8 contributors
Hugh Kennedy
Maintainer, 13 commits, 5 merges
Blaine Bublitz
Maintainer, 7 commits, 2 merges, 1 PRs
Works at Paying the maintainers Tidelift
Alan Plum
2 commits, 1 PRs
Works at CTO at foss-haas
aldendaniels
2 commits, 1 PRs
Works at OneSpot, Inc.
Pascal Duez
2 commits, 1 PRs
Works at Gandi
IgorKlopov
1 commits, 1 PRs

Tags

vinyl
gulp
gulpfriendly
vanilla
stream
string
text
classic
Ready for the next level?
Join Devstore's founding team to help us build the ultimate open-source app store, work with the latest technologies, and enjoy great culture, impact and autonomy
© 2019 Devstore, Inc.
Devstore helps developers find and use open-source packages, so they can focus on building amazing things