node package manager
Loosely couple your services. Use Orgs to version and reuse your code. Create a free org »

lazypipe

lazypipe

NPM version Build Status Support via Gratipay

Lazypipe allows you to create an immutable, lazily-initialized pipeline. It's designed to be used in an environment where you want to reuse partial pipelines, such as with gulp.

This module returns a function that can be used to start building a lazypipe. Individual steps are added via the .pipe() method. At any point, a new lazypipe can be built by adding to an existing one, without affecting the previous lazypipe. Lazypipes can even be used as steps within another lazypipe.

Once the partial pipeline is ready to use, call the last result from .pipe() directly as a function (e.g.: .pipe()()).

Changelog

Usage

Install using:

npm i --save-dev lazypipe

Then create lazypipes like so:

// Example usage within a gulpfile 
var lazypipe = require('lazypipe');
 
...
 
// initialize a lazypipe 
var jsHintTasks = lazypipe()
    // adding a pipeline step, notice the stream function has not been called! 
    .pipe(jshint)
    // adding a step with an argument 
    .pipe(jshint.reporter, 'jshint-stylish');
 
// this is OK, because lazypipes are immutable 
// jsHintTasks will _not_ be affected by the addition. 
var jsTasks = jsHintTasks
    .pipe(gulp.dest, 'build/js');
 
// Create another pipe 
var cssTasks = lazypipe()
    .pipe(recess, recessConfig)
    .pipe(less)
    .pipe(autoprefixer);
 
 
// now using the lazypipes 
gulp.task('jsHint', function() {
    gulp.src('js/**/*.js').pipe(jsHintTasks());
});
 
gulp.task('build', function() {
    // for example only! 
    return gulp.src('js/**/*.js').pipe(jsTasks());
});
 
gulp.task('default', ['build'], function() {
    // using gulp-watch 
    watch('js/**/*.js').pipe(jsTasks());
});

You can combine lazypipes in various ways:

// streamA -> streamB 
var foo = lazypipe().pipe(streamA).pipe(streamB);
 
// streamA -> streamB -> streamC 
var bar = foo.pipe(streamC);
 
// streamD -> streamA -> streamB -> streamE 
var baz = lazypipe().pipe(streamD).pipe(foo).pipe(streamE);
 

Using with more complex function arguments (such as gulp-if)

Lazypipe assumes that all function parameters are static, gulp-if arguments need to be instantiated inside each lazypipe. This difference can be easily solved by passing a function on the lazypipe step

var gulpif = require('gulp-if');
var jshint = require('gulp-jshint');
var uglify = require('gulp-uglify');
var concat = require('gulp-concat');
 
var compressing = false;
 
var jsChannel = lazypipe()
  // adding a pipeline step 
  .pipe(jshint) // notice the stream function has not been called! 
  .pipe(jshint.reporter)
  // adding a step with an argument 
  .pipe(jshint.reporter, 'fail')
  // adding a step with multiple arguments 
  .pipe(concat, 'bundle.js', {newLine: ';'})
  // you can't say: .pipe(gulpif, compressing, uglify) 
  // because uglify needs to be instantiated separately in each lazypipe instance 
  // you can say this instead: 
  .pipe(function () {
    return gulpif(compressing, uglify());
  });
  // why does this work? lazypipe calls the function, passing in the no arguments to it, 
  // it instantiates a new gulp-if pipe and returns it to lazypipe. 
 
gulp.task('scripts', function () {
  return gulp.src(paths.scripts.src)
    .pipe(jsChannel())
    .pipe(gulp.dest(paths.scripts.dest));
});

source

API

lazypipe()

Initializes a lazypipe. Returns a function that can be used to create the pipeline. The returned function has a function (pipe) which can be used to create new lazypipes with an additional step.

lazypipe().pipe(fn[, arg1[, arg2[, ...]]])

Creates a new lazy pipeline with all the previous steps, and the new step added to the end. Returns the new lazypipe.

  • fn - a stream creation function to call when the pipeline is created later. You can either provide existing functions (such as gulp plugins), or provide your own custom functions if you want to manipulate the stream before creation.
  • arg1, arg2, ... - Any remaining arguments are saved and passed into fn when the pipeline is created.

The arguments allows you to pass in configuration arguments when the pipeline is created, like this:

var pipeline = lazypipe().pipe(jsHint, jsHintOptions);
 
// now, when gulp.src().pipe(pipeline()) is called later, it's as if you did: 
gulp.src().pipe(jsHint(jsHintOptions));

lazypipe()() "build"

Calling the result of pipe() as a function builds the pipeline at that time. This can be used multiple times, and can even be called if the lazypipe was used to create different pipelines.

It returns a stream created using stream-combiner, where all the internal steps are processed sequentially, and the final result is passed on.

Help Support This Project

If you'd like to support this and other OverZealous Creations (Phil DeJarnett) projects, donate via Gratipay!

Support via Gratipay

LICENSE

MIT License