node-livereload
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
You can use this by either adding a snippet of code to the bottom of your HTML pages or install the Browser Extensions.
Method 1: Add browser extension
Install the LiveReload browser plugins by visiting http://help.livereload.com/kb/general-use/browser-extensions.
Only Google Chrome supports viewing file:/// URLS, and you have to specifically enable it. If you are using other browsers and want to use file:/// URLs, add the JS code to the page as shown in the next section.
Method 2: Add code to page
Add this code:
<script>
document.write('<script src="http://' + (location.host || 'localhost').split(':')[0] +
':35729/livereload.js?snipver=1"></' + 'script>')
</script>
Note: If you are using a different port other than 35729 you will
need to change the above script.
Running LiveReload
You can run LiveReload two ways:
Option 1: Command line
To use livereload from the command line:
$ npm install -g livereload
$ livereload [path]
Option 2: From within your own project
To use the api within a project:
$ npm install livereload
Then, create a server and fire it up.
livereload = require('livereload');
server = livereload.createServer();
server.watch(__dirname + "/public");
You can also use this with a Connect server. Here's an example of a simple server
using connect and a few other modules just to give you an idea:
var connect = require('connect');
var compiler = require('connect-compiler');
var static = require('serve-static');
var server = connect();
server.use(
compiler({
enabled : [ 'coffee', 'uglify' ],
src : 'src',
dest : 'public'
})
);
server.use( static(__dirname + '/public'));
server.listen(3000);
livereload = require('livereload');
server = livereload.createServer();
server.watch(__dirname + "/public");
You can then start up the server which will listen on port 3000.
Watching multiple paths:
Passing an array of paths or glob patterns will allow you to watch multiple directories. All directories have the same configuration options.
server;Command line:
$ livereload "path1, path2, path3"Using the originalPath option:
// server.jsvar server = livereload;server;Then run the server:
$ node server.js
Then, assuming your HTML file has a stylesheet link like this:
<!-- html --> When /User/Workspace/test/css/style.css is modified, the stylesheet will be reload.
Command-line Options
The commandline options are
-por--portto specify the listening port-dor--debugto show debug messages when the browser reloads.-eor--extsto include additional extentions that you want to observe. An example being -e 'jade scss'.-uor--usepollingto poll for file system changes. Set this to true to successfully watch files over a network.-wor--waitto add a delay (in miliseconds) between when livereload detects a change to the filesystem and when it notifies the browser
Specify the path when using the options.
$ livereload . -w 1000 -d
API Options
The createServer() method supports a few basic options, passed as a JavaScript object:
httpsis an optional object of options to be passed to https.createServer (if not provided,http.createServeris used instead)portis the listening port. It defaults to35729which is what the LiveReload extensions use currently.extsis an array of extensions you want to observe. The default extensions arehtml,css,js,png,gif,jpg,php,php5,py,rb,erb, and "coffee."applyJSLivetells LiveReload to reload JavaScript files in the background instead of reloading the page. The default for this isfalse.applyCSSLivetells LiveReload to reload CSS files in the background instead of refreshing the page. The default for this istrue.applyImgLivetells LiveReload to reload image files in the background instead of refreshing the page. The default for this istrue. Namely for these extensions: jpg, jpeg, png, gifexclusionslets you specify files to ignore. By default, this includes.git/,.svn/, and.hg/originalPathSet URL you use for development, e.g 'http:/domain.com', then LiveReload will proxy this url to local path.overrideURLlets you specify a different host for CSS files. This lets you edit local CSS files but view a live site. See http://feedback.livereload.com/knowledgebase/articles/86220-preview-css-changes-against-a-live-site-then-uplo for details.usePollingPoll for file system changes. Set this to true to successfully watch files over a network.delayadd a delay (in miliseconds) between when livereload detects a change to the filesystem and when it notifies the browser. Useful if the browser is reloading/refreshing before a file has been compiled, for example, by browserify.
License
Copyright (c) 2010-2016 Brian P. Hogan and Joshua Peek
Released under the MIT license. See LICENSE for details.