README

Broccoli Livereload Plugin

Broccoli plugin for adding livereload capabilities.

This plugin will inject the livereload script into the target html file and open a port to notify the script about changes. The plugin will not create a separate watcher. It relies on BroccoliJs's built in watcher and BroccoliFilter's caching functionality.

In case you only want to inject a livereload script you could use Dremora's broccoli-inject-livereload

Example using a single html target

const BroccoliLivereload = require('broccoli-livereload')

const reloadable = new BroccoliLivereload('app', {
    target: 'index.html'
})

module.exports = reloadable

Example using a regular expression to target multiple html files

const BroccoliLivereload = require('broccoli-livereload')

const reloadable = new BroccoliLivereload('app', {
    target: /^[a-zA-Z._-]+.html$/
})

module.exports = reloadable

Example using a custom port

const BroccoliLivereload = require('broccoli-livereload')

const reloadable = new BroccoliLivereload('app', {
    target: 'index.html', 
    options: {
        port: 12345
    }
})

module.exports = reloadable

Installation

npm install broccoli-livereload --save-dev

License

This project is distributed under the MIT license.

Usage no npm install needed!