Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
@pmmmwh/react-refresh-webpack-plugin
Advanced tools
An **EXPERIMENTAL** Webpack plugin to enable "Fast Refresh" (also previously known as _Hot Reloading_) for React components.
The @pmmmwh/react-refresh-webpack-plugin npm package enables hot reloading of React components in webpack without losing their state. This is particularly useful during development as it allows developers to see changes in real-time without a full page reload.
Hot Module Replacement (HMR) for React components
This feature allows React components to be updated in the browser without a full page reload, preserving their state. The code sample shows how to include the plugin in a webpack configuration.
const ReactRefreshWebpackPlugin = require('@pmmmwh/react-refresh-webpack-plugin');
module.exports = {
// ... other webpack config settings ...
plugins: [
// ... other plugins ...
new ReactRefreshWebpackPlugin(),
],
};
React Hot Loader is a plugin that allows React components to be live reloaded without the loss of state. It is similar to @pmmmwh/react-refresh-webpack-plugin but has been largely superseded by the newer React Fast Refresh feature, which @pmmmwh/react-refresh-webpack-plugin leverages.
Webpack Hot Middleware is a middleware for webpack that allows for hot reloading of modules in development mode. It is similar to @pmmmwh/react-refresh-webpack-plugin in that it supports HMR, but it is more general-purpose and not specifically tailored to React.
An EXPERIMENTAL Webpack plugin to enable "Fast Refresh" (also previously known as Hot Reloading) for React components.
First - this plugin is not 100% stable. It works pretty reliably, and we have been testing it for some time, but there are still edge cases yet to be discovered. Please DO NOT use it if you cannot afford to face breaking changes in the future.
# if you prefer npm
npm install -D @pmmmwh/react-refresh-webpack-plugin react-refresh
# if you prefer yarn
yarn add -D @pmmmwh/react-refresh-webpack-plugin react-refresh
First, apply the plugin in your Webpack configuration as follows:
webpack.config.js
const ReactRefreshWebpackPlugin = require('@pmmmwh/react-refresh-webpack-plugin');
// ... your other imports
// You can tie this to whatever mechanisms you are using to detect a development environment.
// For example, as shown here, is to tie that to `NODE_ENV` -
// Then if you run `NODE_ENV=production webpack`, the constant will be set to false.
const isDevelopment = process.env.NODE_ENV !== 'production';
module.exports = {
// It is suggested to run the plugin in development mode only
// If you are an advanced user and would like to setup Webpack yourselves,
// you can also use the `none` mode,
// but you will need to set `forceEnable: true` in the plugin options.
mode: isDevelopment ? 'development' : 'production',
// ... other configurations
plugins: [
// ... other plugins
// You could also keep the plugin in your production config,
// It will simply do nothing.
isDevelopment && new ReactRefreshWebpackPlugin(),
].filter(Boolean),
};
Then, update your Babel configuration.
This can either be done in your Webpack config (via options of babel-loader
), or in the form of a .babelrc
/babel.config.js
.
webpack.config.js (if you choose to inline the config)
const isDevelopment = process.env.NODE_ENV !== 'production';
module.exports = {
// DO NOT apply the plugin in production mode!
mode: isDevelopment ? 'development' : 'production',
module: {
rules: [
// ... other rules
{
// for TypeScript, change the following to "\.[jt]sx?"
test: /\.jsx?$/,
exclude: /node_modules/,
use: [
// ... other loaders
{
loader: require.resolve('babel-loader'),
options: {
// ... other options
// DO NOT apply the Babel plugin in production mode!
plugins: [isDevelopment && require.resolve('react-refresh/babel')].filter(Boolean),
},
},
],
},
],
},
};
.babelrc.js (if you choose to extract the config)
module.exports = (api) => {
// This caches the Babel config by environment.
api.cache.using(() => process.env.NODE_ENV);
return {
// ... other options
plugins: [
// ... other plugins
// Applies the react-refresh Babel plugin on non-production modes only
!api.env('production') && 'react-refresh/babel',
].filter(Boolean),
};
};
More sample projects for common Webpack development setups are available in the examples folder.
Note: If you are using TypeScript (instead of Babel) as a transpiler, you will still need to use
babel-loader
to process your source code. Check out this sample project on how to set this up.
If you need to develop on IE11, you will need to polyfill the DOM URL API. This can be done by adding the following before any of your code in the main entry (either one is fine):
Using url-polyfill
import 'url-polyfill';
Using core-js
import 'core-js/features/url';
import 'core-js/features/url-search-params';
Using react-app-polyfill
import 'react-app-polyfill/ie11';
import 'react-app-polyfill/stable';
This plugin accepts a few options that are specifically targeted for advanced users.
options.forceEnable
Type: boolean
Default: false
Enables the plugin forcefully.
Useful if you want to use the plugin in production, or if you are using Webpack's none
mode without NODE_ENV
, for example.
options.overlay
Type: boolean | ErrorOverlayOptions
Default: undefined
Modifies how the error overlay integration works in the plugin.
If options.overlay
is not provided or is true
, the plugin will use the bundled error overlay interation.
If options.overlay
is false
, it will disable the error overlay integration.
If an ErrorOverlayOptions
object is provided:
(NOTE: This is an advanced option that exists mostly for tools like create-react-app
or Next.js
)
A module
property must be defined.
It should reference a JS file that exports at least two functions with footprints as follows:
function handleRuntimeError(error: Error) {}
function clearRuntimeErrors() {}
An optional entry
property could also be defined, which should also reference a JS file that contains code needed to set up your custom error overlay integration.
If it is not defined, the bundled error overlay entry will be used.
It expects the module
file to export two more functions:
function showCompileError(webpackErrorMessage: string) {}
function clearCompileErrors() {}
Note that webpackErrorMessage
is ANSI encoded, so you will need logic to parse it.
An example configuration:
const options = {
overlay: {
entry: 'some-webpack-entry-file',
module: 'some-error-overlay-module',
},
};
options.sockHost
Type: string
Default: effectively window.location.hostname
Set this if you are running webpack on a host other than window.location.hostname
. This is used by the error overlay module.
options.sockPort
Type: number
Default: effectively window.location.port
Set this if you are running webpack on a port other than window.location.port
options.sockPath
Type: string
Default: /sockjs-node
options.useLegacyWDSSockets
Type: boolean
Default: false
Set this to true if you are using a webpack-dev-server
version prior to 3.8 as it requires a custom SockJS implementation.
If you use this feature, you will also need to install sockjs-client
as a peer dependency.
FAQs
An **EXPERIMENTAL** Webpack plugin to enable "Fast Refresh" (also previously known as _Hot Reloading_) for React components.
The npm package @pmmmwh/react-refresh-webpack-plugin receives a total of 6,027,039 weekly downloads. As such, @pmmmwh/react-refresh-webpack-plugin popularity was classified as popular.
We found that @pmmmwh/react-refresh-webpack-plugin demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.