gulp.js

gulp

Original author(s)	Eric Schoffstall
Developer(s)	Blaine Bublitz, Eric Schoffstall
Initial release	26 September 2013 (2013-09-26)
Stable release	5.0.0 / 29 March 2024 (2024-03-29)
Repository	github.com/gulpjs/gulp
Written in	JavaScript
Operating system	Linux, macOS, Windows
Platform	Node.js
Type	Toolkit
License	MIT License
Website	gulpjs.com

gulp is an open-source JavaScript toolkit, used as a streaming build system (similar to a more package-focused Make) in front-end web development.

It is a task runner built on Node.js and npm, used for automation of time-consuming and repetitive tasks involved in web development like minification, concatenation, cache busting, unit testing, linting, optimization, etc.

gulp uses a code-over-configuration approach to define its tasks and relies on its small, single-purpose plugins to carry them out. The gulp ecosystem includes more than 3500 such plugins.

Overview

gulp is a build tool in JavaScript built on node streams. These streams facilitate the connection of file operations through pipelines. gulp reads the file system and pipes the data at hand from one single-purposed plugin to another through the .pipe() operator, doing one task at a time. The original files are not affected until all the plugins are processed. It can be configured either to modify the original files or to create new ones. This grants the ability to perform complex tasks through linking its numerous plugins. The users can also write their own plugins to define their own tasks. Unlike other task runners that run tasks by configuration, gulp requires knowledge of JavaScript and coding to define its tasks. gulp is a build system which means apart from running tasks, it is also capable of copying files from one location to another, compiling, deploying, creating notifications, unit testing, linting, etc.

Need for a task runner

Task-runners like gulp and Grunt are built on Node.js rather than npm because the basic npm scripts are inefficient when executing multiple tasks. Even though some developers prefer npm scripts because they can be simple and easy to implement, there are numerous ways where gulp and Grunt seem to have an advantage over each other, and the default provided scripts. Grunt runs tasks by transforming files and saves them as new ones in temporary folders, and the output of one task is taken as input for another and so on until the output reaches the destination folder. This involves a lot of I/O calls and the creation of many temporary files. Whereas gulp streams through the file system do not require any of these temporary locations, decreasing the number of I/O calls thus, improving performance. Grunt uses configuration files to perform tasks, whereas gulp requires its build file to be coded. In Grunt, each plugin needs to be configured to match its input location to the previous plugin's output. In gulp, the plugins are automatically pipe-lined.

Operation

The gulp tasks are run from a command-line interface (CLI) shell and require two files, package.json, which is used to list the various plugins for gulp, and gulpfile.js (or simply gulpfile), These, as per build tool convention, are often found in the root directory of the package's source code. The gulpfile contains most of the logic that gulp needs to run its build tasks. First, all the necessary modules are loaded and then tasks are defined in the gulpfile. All the necessary plugins specified in the gulpfile are listed in the devDependencies section of package.json. The default task runs by $gulp. Individual tasks can be defined by gulp.task and are run by gulp <task> <othertask>. Complex tasks are defined by chaining the plugins with the help of .pipe() operator.

Anatomy of gulpfile

gulpfile is the place where all the operations are defined in gulp. The basic anatomy of the gulpfile consists of required plugins included at the top, definition of the tasks and a default task at the end.

Plugins

Any installed plugin that is required to perform a task is to be added at the top of the gulpfile as a dependency in the following format.

//Adding dependencies
var gulp = require ('gulp');

Tasks

The tasks can then be created. A gulp task is defined by gulp.task and takes the name of the task as the first parameter and a function as the second parameter.

The following example shows the creation of a gulp tasks. The first parameter taskName is mandatory and specifies the name by which the task in the shell can be executed.

gulp.task('taskName', function () {
  //do something
});

Alternatively, a task that performs several predefined functions can be created. Those functions are passed as the second parameter in the form of an array.

function fn1 () {
  // do something
}

function fn2 () {
 // do something
}

// Task with array of function names
gulp.task('taskName', gulp.parallel(fn1, fn2));

Default task

The default task is to be defined at the end of the gulpfile. It can be run by the gulp command in the shell. In the case below, the default task does nothing.

// Gulp default task
gulp.task('default', fn);

The default task is used in gulp to run any number of dependent sub tasks defined above in a sequential order automatically. gulp can also monitor source files and run an appropriate task when changes are made to the files. The sub tasks are to be mentioned as the elements of the array in the second parameter. The process can be triggered by simply running the default task by gulp command.

Example tasks

Image Task

The module definition can be at the beginning of Gulpfile.js like so:

var imagemin = require('gulp-imagemin');

The subsequent image task optimizes images. gulp.src() retrieves all the images with the extension .png, .gif or .jpg in the directory 'images-orig/'.

.pipe(imagemin()) channels the images found, through the optimization process and with .pipe(gulp.dest()) the optimized images are saved to the 'images/' folder. Without gulp.dest() the images would indeed be optimized, but are not stored. Since the optimized images are stored to another folder, the original images remain unaltered.

// Images task
gulp.task('images', function () {
    return gulp.src('images/*.{png,gif,jpg}')
        .pipe(imagemin())
        .pipe(gulp.dest('dist/images/'));
});

Scripts Task

In the following example, all JavaScript files from the directory scripts/ are optimized with .pipe(uglify()) and gulp.dest('scripts/') overwrites the original files with the output. For this, one must first return to the required gulp-uglify plugin on npm package installer and at the beginning of gulpfile, the module should be defined.

// Script task
gulp.task('scripts', function () {
    return gulp.src('scripts/*.js')
        .pipe(uglify())
        .pipe(gulp.dest('scripts/'));
});

Watch Task

The Watch-task serves to react to changes in files. In the following example, the tasks with the names scripts and images are called when any of JavaScript files or images change in the specified directories.

// Rerun the task When a file changes
gulp.task('watch', function (cb) {
    gulp.watch('scripts/js/**', scripts);
    gulp.watch('images/**', images);
    cb();
});

Furthermore, it is possible to accomplish an update of the browser content using the Watch-tasks. For this, there are numerous options and plugins.

See also

• Grunt (software)
• Browserify

Literature

• Jed Mao; Maximilian Schmitt; Tomasz Stryjewski; Cary Country Holt; William Lubelski (2014). Developing a Gulp Edge (1st ed.). Bleeding Edge Press. ISBN 978-1-939902-14-6.
• Den Odell (2014). "Build Tools and Automation". Pro JavaScript Development Coding, Capabilities, and Tooling. Apress. ISBN 978-1-4302-6268-8.
• Maynard, Travis (2015). Getting Started with Gulp. Packt Publishing Ltd. ISBN 9781784393472.

External links

• Official website
• gulp on GitHub