factor-bundle-reset-patch v1.0.0

factor-bundle-reset-patch

Patch for factor-bundle@2.4.1 to work with watchify.

There is a problem to use 2.4.1 with watchify: output streams are finished after bundle and thus not writable anymore, so you will run into errors when watchify fires update to rebundle.

To solve this problem, output streams are rebuilt every time reset.

Example

example/gulpfile.js

var path = require('path');
var gulp = require('gulp');
var uglify = require('gulp-uglify');
var buffer = require('gulp-buffer');
var gutil = require('gulp-util');

var factor = require('factor-bundle-reset-patch');
var browserify = require('browserify');
var watchify = require('watchify');

var source = require('vinyl-source-stream');
var merge = require('merge-stream');
var readonly = require('read-only-stream');
var del = require('del');

var PassThrough = require('stream').PassThrough;

var fixtures = path.resolve.bind(path, __dirname);

gulp.task('clean', function (cb) {
    del(fixtures('dist'), cb);
});

gulp.task('default', ['clean'], function () {
    return bundle(getBundle());
});

gulp.task('watch', ['clean'], function (cb) {
    var b = watchify(getBundle());
    b.on('update', _bundle);
    _bundle();

    function _bundle() {
        bundle(b);
    }
});

function bundle(b) {
    return b.bundle()
        // from now on, use gulp plugins to transform contents
        .pipe(buffer())
        .pipe(uglify())
        .pipe(gulp.dest(fixtures('dist')))
        ;
}

function getBundle() {
    var entries = ['a.js', 'b.js'];
    var basedir = fixtures('src');
    var b = browserify(entries, { basedir: basedir })
    b.plugin(factor, {
        entries: entries,
        basedir: basedir,
        outputs: entries,
        // overwrite default `fs.createWriteStream` to make vinyl streams
        createWriteStream: source,
    });
    b.on('log', gutil.log);
    b.on('error', gutil.log);
    // make `bundle` return a vinyl stream.
    // perhaps another plugin to gulpify `bundle`
    b.bundle = function () {
        var pipeline = PassThrough({ objectMode: true });
        var common = browserify.prototype.bundle.call(b)
            .pipe(source('common.js'));
        b.once('factor.pipelines', function (files, pipelines, outputs) {
            merge(outputs.concat(common)).pipe(pipeline);
        });
        return readonly(pipeline);
    };
    return b;
}

⌘ tree example/
example/
├── dist
│   ├── a.js
│   ├── b.js
│   └── common.js
├── gulpfile.js
└── src
    ├── a.js
    ├── b.js
    └── c.js

b.plugin(factor, opts)

opts

entries

Type: Array

Entry file paths. Absolute or relative to opts.basedir

basedir

Type: String

outputs

Type: Array, String

Output destinations. Passed to opts.createWriteStream to make output streams.

Type: Function

It receives opts.entries, opts.basedir, and should return output streams.

createWriteStream

Type: Function

Default: fs.createWriteStream

pack

Type: Function, browser-plugin

Default: browser-pack

theshold

Same with that in factor-bundle.

events

b.on('factor.pipelines', function(files, pipelines, outputStreams){})

Emits all absolute entry files, pipelines, and output streams.