@electric-eloquence/gulp

The streaming build system

This package provides long-term support for gulp at major version 3.

This includes maintenance fixes and security updates.

The scoping of this package makes it an entirely different package from unscoped gulp and precludes any access from any gulp plugins if it installed with the usual npm install command.

Instead, follow these instructions:

Install

• Latest version (without Git):
  • npm install --save https://github.com/electric-eloquence/gulp/tarball/v3-lts@3.9.3
  • Or add "gulp": "https://github.com/electric-eloquence/gulp/tarball/v3-lts@3.9.3" as a dependency in package.json.
• Latest version (with Git):
  • npm install --save electric-eloquence/gulp
• Specific version (with Git):
  • npm install --save electric-eloquence/gulp#3.9.3
• Semver range (with Git):
  • npm install --save electric-eloquence/gulp#semver:^3.9.3
• When installed one of these ways, other packages depending on gulp will get gulp 3 with long-term support.

What is gulp?

• Automation - gulp is a toolkit that helps you automate painful or time-consuming tasks in your development workflow.
• Platform-agnostic - Integrations are built into all major IDEs and people are using gulp with PHP, .NET, Node.js, Java, and other platforms.
• Strong Ecosystem - Use npm modules to do anything you want + over 2000 curated plugins for streaming file transformations.
• Simple - By providing only a minimal API surface, gulp is easy to learn and simple to use.

Documentation

For a Getting Started guide, API docs, recipes, making a plugin, etc. check out our docs!

• Documentation for gulp 3
• Why stay on gulp 3?

Sample gulpfile.js

This file will give you a taste of what gulp does.

var gulp = require('gulp');
var coffee = require('gulp-coffee');
var concat = require('gulp-concat');
var uglify = require('gulp-uglify');
var imagemin = require('gulp-imagemin');
var sourcemaps = require('gulp-sourcemaps');
var del = require('del');

var paths = {
  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 any package available on npm
gulp.task('clean', function() {
  // You can use multiple globbing patterns as you would with `gulp.src`
  return del(['build']);
});

gulp.task('scripts', ['clean'], function() {
  // Minify and copy all JavaScript (except vendor scripts)
  // with sourcemaps all the way down
  return gulp.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 images
gulp.task('images', ['clean'], function() {
  return gulp.src(paths.images)
    // Pass in options to the task
    .pipe(imagemin({optimizationLevel: 5}))
    .pipe(gulp.dest('build/img'));
});

// Rerun the task when a file changes
gulp.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

Install Troubleshooting

• npm ERR! code EINTEGRITY
  • If npm warns that the tarball data seems to be corrupted, delete your package-lock.json, and install again.

Changelog

3.9.3

• Better handling of renamed and removed directories
• Better handling of paths when cwd is submitted