React Refresh Plugin

Enables support for React Fast Refresh, so that you can develop your app faster.

Usage

Setup

Install it using npm

npm i -D @reboost/plugin-react-refresh

Import it from the package

const { start } = require('reboost');
const ReactRefreshPlugin = require('@reboost/plugin-react-refresh');

Add it to the plugins array

const { start } = require('reboost');
const ReactRefreshPlugin = require('@reboost/plugin-react-refresh');

start({
  plugins: [
    ReactRefreshPlugin({
      // Options
    })
  ]
})

Options

excludeNodeModules

Type: boolean
Default: true

Excludes all files which match /node_modules/. Disabling it will decrease performance.

Minimal setup needed

If you want this plugin to work, please part up your components and renderers to different files.

This won't work

index.jsx

import * as React from 'react';
import * as ReactDOM from 'react-dom';

const App = () => {
  return (
    <div>Hi there!</div>
  )
}

ReactDOM.render(<App />, document.querySelector('#app'));

This works

index.jsx

import * as React from 'react';
import * as ReactDOM from 'react-dom';
import { App } from './App';

ReactDOM.render(<App />, document.querySelector('#app'));

App.jsx

import * as React from 'react';

export const App = () => {
  return (
    <div>Hi there!</div>
  )
}

Example

Improving performance by excluding unrelated files

By default, it runs the transformation on all files. You can run the transformation only on the files which need it by using UsePlugin.

const {
  start,
  builtInPlugins: {
    UsePlugin
  }
} = require('reboost');
const ReactRefreshPlugin = require('@reboost/plugin-react-refresh');

start({
  // Other options
  plugins: [
    // Other plugins
    UsePlugin({
      include: /\.[jt]sx?$/, // Selects only the files with .js, .ts, .jsx or .tsx extension
      use: ReactRefreshPlugin()
    })
  ]
  // ...
})

License

Licensed under the MIT License.