better-livereload

Better LiveReload server

npm install better-livereload
1 downloads in the last day
10 downloads in the last week
62 downloads in the last month

better-livereload

A drop-in replacement for node-livereload. The purpose of this fork is two-fold:

  1. To make the most recent version accessible from npm
  2. To add some performance enhancements

Original README starts below (slightly edited and updated)...


An implementation of the LiveReload server in Node.js. It's an alternative to the graphical http://livereload.com/ application, which monitors files for changes and reloads your web browser.

Example Usage

First, install the LiveReload browser plugins by visiting http://help.livereload.com/kb/general-use/browser-extensions.

To use livereload from the command line:

$ npm install -g better-livereload
$ livereload [path]

Or to use the api within a project:

$ npm install better-livereload

Then, simply create a server and fire it up.

livereload = require('better-livereload');
server = livereload.createServer();
server.watch(__dirname + "/public");

You can also use this with a Connect server:

connect = require('connect');
connect.createServer(
  connect.compiler({ src: __dirname + "/public", enable: ['less'] }),
  connect.staticProvider(__dirname + "/public")
).listen(3000);

livereload = require('better-livereload');
server = livereload.createServer({exts: ['less']});
server.watch(__dirname + "/public");

Options

The createServer() method supports a few basic options, passed as a JavaScript object:

  • port is the listening port. It defaults to 35729 which is what the LiveReload extensions use currently.
  • exts is an array of extensions you want to observe. The default extensions are html, css, js, png, gif, jpg, php, php5, py, rb, and erb
  • applyJSLive tells LiveReload to reload JavaScript files in the background instead of reloading the page. The default for this is false.
  • applyCSSLive tells LiveReload to reload CSS files in the background instead of refreshing the page. The default for this is true.
  • exclusions lets you specify files to ignore. By default, this includes .git/, .svn/, and .hg/

License

Copyright John-Kim Murphy
Original copyright (c) 2010-2012 Joshua Peek and Brian P. Hogan.

Released under the MIT license. See LICENSE for details.

npm loves you