rollup-plugin-rld/readme.md

Rollup plugin to inject a live reload script into your bundle

<!-- @format -->

# Rollup-Plugin-Rld

[![Npm package version](https://badgen.net/npm/v/rollup-plugin-rld)](https://www.npmjs.com/package/rollup-plugin-rld) [![Npm package total downloads](https://badgen.net/npm/dt/rollup-plugin-rld)](https://npmjs.com/package/rollup-plugin-rld) [![Npm package license](https://badgen.net/npm/license/rollup-plugin-rld)](https://npmjs.com/package/rollup-plugin-rld)
[![Github tag](https://badgen.net/github/tag/iamsebastiandev/rollup-plugin-rld)](https://github.com/iamsebastiandev/rollup-plugin-rld/tags)

A [Rollup](https://rollupjs.org/guide/en/) plugin to reload your webpage when the created bundle is regenerated.

## Overview

The Plugin will inject a bootstrapping script into your bundle when Rollup is running watch mode. The script itself will inject a reloading script that listens to a event sent by the created server when Rollup bundles the code.

## Requirements

The Plugin was tested with Rollup v3.2.0+, but should run with earlier versions as well. The Plugin requires an [LTS](https://github.com/nodejs/Release) Node version (v14.0.0+).

## Installing

Using npm or yarn

```bash
npm install rollup-plugin-rld -D
#or
yarn add rollup-plugin-rld -D
```

## Usage

If you have not already created a `rollup.config.js` [configuration file](https://www.rollupjs.org/guide/en/#configuration-files), do so like shown below. Include the plugin in the `plugins` property.

```js
import { rld } from 'rollup-plugin-rld';

export default {
    input: '/src/index.js',
    output: {
        file: '/dist/bundle.js',
        format: 'iife',
    },
    plugins: [
        // The initialization object is optional.
        rld({
            port: 31415,
            host: 'localhost',
            url: 'rld',
        }),
    ],
};
```

## Options

### `port`

Type: `number`  
Default: `31415`

The port the plugin will use to listen and dispatch requests on. If your plugin throws an `EADDRINUSE` error, you can change the property to choose a port not yet used. This can also be useful when you use multiple instances of the plugin.

### `host`

Type: `string`  
Default: `localhost`

The hostname the server will use to listen to.

### `url`

Type: `string`  
Default: `/rld`

The url the server will expose. The reload script will use the url to connect to the reload server. The url can be given with or without leading slash.

### `attributes`

Type: `Record<string, string>`  
Default: `{}`

Attributes is a object that can be used to pass attributes to the created script tag. This can be useful when needing to set attributes like `nonce`, `referrerpolicy` or `crossorigin`.

### `log`

Type: `boolean`  
Default: `false`

A Boolean flag indicating if a log entry should be created inside the browser when a reload occurs.

## Contributing

If you would like to contribute, take a look at the [contribution guide](./contributing.md).

## License

The plugin is licensed under the [MIT License](https://opensource.org/licenses/MIT).