Skip to content

thgh/rollup-plugin-livereload

Repository files navigation

Rollup plugin LiveReload

Software License Issues JavaScript Style Guide NPM Latest Version

Installation

npm install --save-dev rollup-plugin-livereload

Usage

// rollup.config.js
import livereload from 'rollup-plugin-livereload'

export default {
  input: 'entry.js',
  output: { file: 'bundle.js' },
  plugins: [livereload()],
}

To make it a real dev-server, combine this plugin with rollup-plugin-serve.

// rollup.config.js
import serve from 'rollup-plugin-serve'
import livereload from 'rollup-plugin-livereload'

export default {
  input: 'entry.js',
  output: { file: 'bundle.js' },
  plugins: [
    serve(), // index.html should be in root of project
    livereload(),
  ],
}

Options

By default, it watches the current directory. If you also have css output, pass the folder to which the build files are written.

This plugin supports the following options:

  • clientUrl: provide an alternative URL to the livereload.js script/resource. This URL is always preferred over all other generated URLs.
  • clientHostname: alternative hostname used instead of localhost or the site's current host, where the bundle is fetched from. Use this option when you include your bundle from a different host.

All remaining options are passed to livereload.createServer().

Example:

livereload('dist')

// --- OR ---

livereload({
  watch: 'dist',
  verbose: false, // Disable console output

  // other livereload options
  port: 12345,
  delay: 300,
  https: {
      key: fs.readFileSync('keys/agent2-key.pem'),
      cert: fs.readFileSync('keys/agent2-cert.pem')
  }
})

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Contributions and feedback are very welcome.

To get it running:

  1. Clone the project.
  2. npm install
  3. npm run build

Credits

License

The MIT License (MIT). Please see License File for more information.

About

LiveReload your Rollup bundle!

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 20