gulp-server-livereload

Gulp plugin to run a local webserver with livereload enabled via socket.io

gulp-server-livereload

Gulp plugin to run a local webserver with live reload using socket.io

Serve a folder over HTTP and watch it for changes, telling the browser to reload itself when a change happens.

  • Uses socket.io - livereload mechanism works even if your browser does not support WebSockets (PhoneGap developers rejoice!).

  • window.console capture - it can capture console output from the client-side and transmit it to the back-end for display. This is useful for when testing from Phonegap, etc.

  • Supports CSS injection (no need to reload the whole page if just your CSS has changed).

  • Comes with a command-line runnable.

This was originally a fork of gulp-webserver.

$ npm install --save-dev gulp-server-livereload

The folder supplied to gulp.src() will be the root folder from which files will be served.

var gulp = require('gulp');
var server = require('gulp-server-livereload');
 
gulp.task('webserver', function() {
  gulp.src('app')
    .pipe(server({
      livereload: true,
      directoryListing: true,
      open: true
    }));
});

If you run gulp webserver your browser should automatically open up to http://localhost:8000 and show a directory listing of the app folder.

Note: In order for the livereload browser-side code to be injected properly your HTML must have a closing ` tag.

Install the package globally:

$ npm install -g gulp-server-livereload

Then you can run the livereload command to serve files out of the current folder. Here are the available options:

$ livereload help
 
  Usage: livereload [options]
 
  Options:
 
    -h, --help        output usage information
    -V, --version     output the version number
    -n, --no-browser  do not open the localhost server in a browser
    -l, --log [type]  log level (default: info)
    -p, --port <n>    the port to run on

Note: not all of these options are currently available via the CLI executable

KeyTypeDefaultDescription
hostStringlocalhosthostname of the webserver
portNumber8000port of the webserver
livereloadBoolean/Objectfalsewhether to use livereload. For advanced options, provide an object.
livereload.portNumber35729port for livereload server to listen on.
livereload.filterFunction-function to filter out files to watch (default filters out node_modules).
livereload.clientConsoleBooleanfalsewhether to capture window.console output from the client and send it to the back-end for display.
directoryListingBoolean/Objectfalsewhether to display a directory listing. For advanced options, provide an object. You can use the path property to set a custom path or theoptions` property to set custom serve-index options.
defaultFileStringindex.htmldefault file to show when root URL is requested. If directoryListing is enabled then this gets disabled.
openBoolean/Objectfalseopen the localhost server in the browser
httpsBoolean/Objectfalsewhether to use https or not. By default, gulp-server-livereload provides you with a development certificate but you remain free to specify a path for your key and certificate by providing an object like this one: {key: 'path/to/key.pem', cert: 'path/to/cert.pem'}.
logStringinfoIf set to debug you will see all requests logged to the console.

By default when a file changes the livereload script in the browser does the following:

  1. Checks to see whether the changed file is a CSS file
  2. If it is a CSS file then it reloads the changed CSS files in the browser
  3. Otherwise it reloads the whole page

To override the default behaviour define the following method in Javascript:

/** 
 * This method gets called by the livereload script when the server notifies it 
 * that something has changed.
 * 
 * @param  {Object} file File which changed.
 */
window._onLiveReloadFileChanged = function(file) {
  // do whatever you want here, e.g. location.reload();   
}

The file parameter has the following structure:

{
  "path": ...full path to file which changed...
  "name": ...file name (without path)...
  "ext": ...file extension name...
}

Set 0.0.0.0 as the host option.

Set the defaultFile to main.html:

gulp.task('webserver', function() {
  gulp.src('app')
    .pipe(server({
      defaultFile: 'main.html'
    }));
});

In the livereload object, set the enable to true and provide filter function in filter:

gulp.task('webserver', function() {
  gulp.src('app')
    .pipe(server({
      livereload: {
        enable: true,
        filterfunction(filePathcb) {
          cb( !(/node_modules/.test(filePath)) );
        }
      }
    }));
});

MIT - see LICENSE.md