gulp

The streaming build system

Like what we do?

Support us via Gratipay

Documentation

For a Getting started guide, API docs, recipes, making a plugin, etc. see the documentation page!

Sample gulpfile.js

This file is just a quick sample to give you a taste of what gulp does.

vargulp=require('gulp');varcoffee=require('gulp-coffee');varconcat=require('gulp-concat');varuglify=require('gulp-uglify');varimagemin=require('gulp-imagemin');varsourcemaps=require('gulp-sourcemaps');vardel=require('del');varpaths={scripts: ['client/js/**/*.coffee','!client/external/**/*.coffee'],images: 'client/img/**/*'};// Not all tasks need to use streams// A gulpfile is just another node program and you can use all packages available on npmgulp.task('clean',function(cb){// You can use multiple globbing patterns as you would with `gulp.src`del(['build'],cb);});gulp.task('scripts',['clean'],function(){// Minify and copy all JavaScript (except vendor scripts)// with sourcemaps all the way downreturngulp.src(paths.scripts).pipe(sourcemaps.init()).pipe(coffee()).pipe(uglify()).pipe(concat('all.min.js')).pipe(sourcemaps.write()).pipe(gulp.dest('build/js'));});// Copy all static imagesgulp.task('images',['clean'],function(){returngulp.src(paths.images)// Pass in options to the task.pipe(imagemin({optimizationLevel: 5})).pipe(gulp.dest('build/img'));});// Rerun the task when a file changesgulp.task('watch',function(){gulp.watch(paths.scripts,['scripts']);gulp.watch(paths.images,['images']);});// The default task (called when you run `gulp` from cli)gulp.task('default',['watch','scripts','images']);

Incremental Builds

We recommend these plugins:

• gulp-changed - only pass through changed files
• gulp-cached - in-memory file cache, not for operation on sets of files
• gulp-remember - pairs nicely with gulp-cached
• gulp-newer - pass through newer source files only, supports many:1 source:dest

Want to contribute?

Anyone can help make this project better - check out the Contributing guide!