Actually support Browserify scenarios

.gitignore

@@ -1,5 +1,6 @@
 .DS_Store
 lib/*.js
+lib/*/*.js
 node_modules/
 *.tgz
 npm-debug.log

Gruntfile.js

@@ -18,6 +18,11 @@ module.exports = function(grunt) {
         },
         src: ['lib/startup.js'],
         dest: 'dist/livereload.js'
+      },
+
+      test: {
+        src: ['test/html/browserified/main.js'],
+        dest: 'test/html/browserified/bundle.js'
       }
     },
 
@@ -35,7 +40,7 @@ module.exports = function(grunt) {
   grunt.loadNpmTasks('grunt-browserify');
   grunt.loadNpmTasks('grunt-mocha-test');
 
-  grunt.registerTask('build', ['coffee', 'browserify']);
+  grunt.registerTask('build', ['coffee', 'browserify:dist']);
   grunt.registerTask('test', ['mochaTest']);
   grunt.registerTask('default', ['build', 'test']);
 

README.md

@@ -53,22 +53,35 @@ Would love, but doesn't seem possible:
 * live JS reloading
 
 
-Installing using Bower and npm
-------------------------------
+Installing using Bower
+----------------------
 
-This script is published on Bower and npm. (But, to reiterate: the preferred method is to avoid installing it altogether, and instead use the one bundled with your LiveReload server/app/tool.)
+This script is published on Bower. (But, to reiterate: the preferred method is to avoid installing it altogether, and instead use the one bundled with your LiveReload server/app/tool.)
 
-Using Bower:
+Installation:
 
     bower install livereload-js --save-dev
 
 This gives you a component containing a single script file, `dist/livereload.js`.
 
-If you're using Browserify, you can require LiveReload via npm:
+
+Installing using npm and Browserify
+-----------------------------------
+
+Including livereload.js into your Browserify bundle probably makes no sense, because livereload.js isn't something you would ship to production.
+
+But if you insist _and_ you know what you're doing, you can install LiveReload via npm:
 
     npm install livereload-js --save
 
-Note that the package uses `window` and `document` globals, so won't run under Node.js environment.
+and then add this to your bundle:
+
+    window.LiveReloadOptions = { host: 'localhost' };
+    require('livereload-js');
+
+Note that livereload-js package uses `window` and `document` globals, so won't run under Node.js environment.
+
+The reason you need to specify `LiveReloadOptions` is that `livereload.js` won't be able to find its `<script>` tag and would normally bail out with an error message.
 
 
 Using livereload.js
@@ -121,6 +134,19 @@ Alternatively, instead of loading livereload.js from the LiveReload server, you
 ```
 
 
+Options
+-------
+
+Options can either be specified as query parameters of the `<script src="..../livereload.js">` tag's source URL, or as a global `window.LiveReloadOptions` dictionary. If the dictionary is specified, `livereload.js` does not even try looking for its `<script>` tag.
+
+The set of supported options is the same for both methods:
+
+* `host`: the host that runs a LiveReload server; required if specifying `LiveReloadOptions`, otherwise will be autodetected as the origin of the `<script>` tag
+* `port`: optional server port override
+* `mindelay`, `maxdelay`: range of reconnection delays (if `livereload.js` cannot connect to the server, it will attempt to reconnect with increasing delays); defaults to 1,000 ms minimum and 60,000 ms maximum
+* `handshake_timeout`: timeout for a protocol handshake to be completed after a connection attempt; mostly only needed if you're running an interactive debugger on your web socket server
+
+
 Issues & Limitations
 --------------------
 
@@ -173,6 +199,10 @@ To run tests:
 
     grunt
 
+Manual testing: open files in `test/html/*` in various browsers, make some changes and make sure they are applied.
+
+Testing the Browserify usage scenario: `grunt browserify:test`, then perform manual testing of `test/html/browserified/`.
+
 
 Releasing a new version
 -----------------------

src/livereload.coffee

@@ -23,9 +23,15 @@ exports.LiveReload = class LiveReload
       return
 
     # i can haz options?
-    unless @options = Options.extract(@window.document)
-      @console.error("LiveReload disabled because it could not find its own <SCRIPT> tag")
-      return
+    if 'LiveReloadOptions' of window
+      @options = new Options()
+      for own k, v of window['LiveReloadOptions']
+        @options.set(k, v)
+    else
+      @options = Options.extract(@window.document)
+      unless @options
+        @console.error("LiveReload disabled because it could not find its own <SCRIPT> tag")
+        return
 
     # i can haz reloader?
     @reloader = new Reloader(@window, @console, Timer)

test/html/browserified/.gitignore

@@ -0,0 +1 @@
+bundle.js

test/html/browserified/main.js

@@ -0,0 +1,6 @@
+window.LiveReloadOptions = { host: 'localhost' };
+require('../../../lib/startup.js');
+
+window.hellow = function hellow() {
+    return 42;
+}

test/html/browserified/test.css

@@ -0,0 +1,3 @@
+body {
+    background: green;
+}

test/html/browserified/test.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <title>LiveReload Test</title>
+    <link rel="stylesheet" href="test.css">
+</head>
+<body>
+    <script src="bundle.js?host=localhost"></script>
+    <p>Hello, world == <script>document.write(hellow());</script></p>
+</body>
+</html>