gulp-auto-reload

gulp-auto-reload

Adds (simple) automatic browser reloading to gulp.

The plugin uses WebSocket technology to pass compile events to browser.

Derived from Paul Miller's auto-reload-brunch

Installation

Install the plugin via npm with npm install --save-dev gulp-auto-reload.

Usage

var gulp       = require('gulp');
var concat     = require('gulp-concat');
var autoReload = require('gulp-auto-reload');

// some paths to build from
var paths = {
  html: "src/**/*.html",
  css: "src/**/*.css"
};

// the output
var outapp = "dist";

// this transformer is used to inject <script>
// tags into the html when reloader is enabled
var htmlInject = function() {
  return gutil.noop();
};

gulp.task('html', function() {
  gulp.src(paths.html)
    .pipe(htmlInject())      // inject <script>
    .pipe(gulp.dest(outapp));
});

gulp.task('css', function() {
  gulp.src(paths.css)
    .pipe(concat('ui/app.css'))
    .pipe(gulp.dest(outapp));
});

gulp.task('reloader', function() {
  // start a server for reloading
  var reloader = autoReload();
  // copy the auto-reload.js script to
  // the output
  reloader.script()
    .pipe(gulp.dest(outapp));
  // inject the script into html pages
  htmlInject = reloader.inject;
  // start watching the output for changes
  gulp.watch(outapp + "/**/*", reloader.onChange);
});

// building html/css causes no <script> injection
gulp.task('default', ['html', 'css']);

// 'reloader' sets htmlInject, and 'html' task will
// make injected html page
gulp.task('watch', ['reloader', 'html'], function() {
  // watch all source for rebuild
  gulp.watch('./src/**/*', ['default']);
});

Details

autoReload() starts a server process that listens for websockets on port 9485. On a changed file, the server emits either a 'page' or 'stylesheets' event to all connected clients.

auto-reload.js should be loaded in the client browser. It connects to the server and performs page or stylesheets reload.

License

The original work's license is here: DERIVED.md.

The MIT License (MIT)

Copyright (c) 2015 Martin Algesten

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.