Code Monkey home page Code Monkey logo

gulp-bro's Introduction

gulp + browserify + incremental build, done right.

travis codecov

Even through gulp has recipes to make things work, configuring browserify needs too much boilerplate and understanding about how things work. gulp-bro looks like any other gulp plugin, it does the exact same thing you can do manually, but hides the ugly stuff for you.

It also support incremental build out of the box, so you don't have to mess with watchify again.

Install

npm install --save-dev gulp-bro

Usage

Simple build

gulp.task('build', () =>
  gulp.src('app.js')
    .pipe(bro())
    .pipe(gulp.dest('dist'))
)

gulp.watch('*.js', ['build'])

Subsequent calls to build will be fast thanks to incremental build.

Browserify transforms

gulp.task('build', () =>
  gulp.src('app.js')
    .pipe(bro({
      transform: [babelify.configure({ presets: ['es2015'] })]
    })
    .pipe(gulp.dest('dist')
)

Multiple bundles

gulp.task('build', () =>
  gulp.src('*.js')
    .pipe(bro())
    .pipe(gulp.dest('dist')
)

API

bro([options], [callback])

options {object}

Except error, options are directly passed to browserify. So you can use bro as if you were using browerify. Here is a list of all available options.

error {'emit'|function}

Another pitfall of using browerify manually was that error reporting had to be done manually too or you ended up with a huge callstack and a crashed process. By default, bro reports nicely formatted errors:

You can customize things in 2 ways:

  • Set emit which will cause bro to emit the error, so you can catch it with on('error').
  • Set a callback that will handle the error.

FAQ

What is incremental build?

If you use vanilla browserify with gulp, you end up with long compile times if you watch for changes. The reason is that each time a new browserify instance is created and has to parse and compile the whole bundle. Even if only one file has changed, the whole bundle is processed.

Usually you use watchify to improve this, and only recompile files that have changed. The only problem with watchify is that it monitors file changes on its own and needs a lot of boilerplate to integrate with gulp, precisely because of this.

gulp already provide a file watch mechanism that we can use out of the box. bro caches already compiled files and only recompile changes. So you can call repeatedly bro with optimal compile times.

Known issues

The main entry does not update

This is a pending issue (#4). If you frequently make updates the main entry, then you should consider using { read: false } which seems to make the problem disappear:

gulp.src('app.js', { read: false })
    .pipe(bro())
    .pipe(gulp.dest('dist'))

Contributors

//: contributor-faces

Generated with contributors-faces.

License

MIT © Nicolas Gryman

gulp-bro's People

Contributors

ngryman avatar greenkeeperio-bot avatar dylanpiercey avatar shannonmoeller avatar

Watchers

James Cloos avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.