Gathering detailed insights and metrics for @rspack/plugin-react-refresh
An interesting fact about npm is that it started as a weekend project by its creator, Isaac Z. Schlueter, in 2009. It was officially launched in January 2010.
Installations
npm install @rspack/plugin-react-refreshScore
95
Supply Chain
96.5
Quality
88.8
Maintenance
100
Vulnerability
100
License
Contributors
8
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4){kind=avatar}
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?v=4){kind=avatar}
Developer
rspack-contrib
Module System
BETA
CommonJS, ESM
Statistics
11 Stars
17 Commits
2 Forks
3 Watching
1 Branches
8 Contributors
Updated on 08 Nov 2024
Languages
JavaScript (71.36%)
TypeScript (28.64%)
Total Downloads
Cumulative downloads
Total Downloads
3,727,864
Last day
-11.5%
3,791
Compared to previous day
Last week
4.5%
142,090
Compared to previous week
Last month
8.7%
587,055
Compared to previous month
Last year
2,964.2%
3,610,052
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Versions
@rspack/plugin-react-refresh
React refresh plugin for Rspack.
Installation
First you need to install this plugin and its dependencies:
1npm add @rspack/plugin-react-refresh react-refresh -D 2# or 3yarn add @rspack/plugin-react-refresh react-refresh -D 4# or 5pnpm add @rspack/plugin-react-refresh react-refresh -D 6# or 7bun add @rspack/plugin-react-refresh react-refresh -D
Usage
Enabling React Fast Refresh functionality primarily involves two aspects: code injection and code transformation.
- Code injection will inject some code from the react-refresh package, as well as some custom runtime code, all of which are integrated in this plugin and can be injected through.
- Code transformation can be added through loaders, such as jsc.transform.react.refresh for swc-loader or the react-refresh/babel for babel-loader.
1const ReactRefreshPlugin = require("@rspack/plugin-react-refresh"); 2const isDev = process.env.NODE_ENV === "development"; 3 4module.exports = { 5 experiments: { 6 rspackFuture: { 7 disableTransformByDefault: true, 8 }, 9 }, 10 // ... 11 mode: isDev ? "development" : "production", 12 module: { 13 rules: [ 14 { 15 test: /\.jsx$/, 16 use: { 17 loader: "builtin:swc-loader", 18 options: { 19 jsc: { 20 parser: { 21 syntax: "ecmascript", 22 jsx: true, 23 }, 24 transform: { 25 react: { 26 development: isDev, 27 refresh: isDev, 28 }, 29 }, 30 }, 31 }, 32 }, 33 }, 34 ], 35 }, 36 plugins: [isDev && new ReactRefreshPlugin()].filter(Boolean), 37};
Compared to the previous approach, this method decouples the React Fast Refresh code injection logic from the transformation logic. The code injection logic is handled uniformly by this plugin, while the code transformation is handled by loaders. This means that this plugin can be used in conjunction with builtin:swc-loader, swc-loader, or babel-loader.
Example
- For usage with
builtin:swc-loader, you can refer to the example at examples/react-refresh, When using withswc-loader, simply replacebuiltin:swc-loaderwithswc-loader. - For usage with
babel-loader, you can refer to the example at examples/react-refresh-babel-loader
Options
include
- Type: Rspack.RuleSetCondition
- Default:
/\.([cm]js|[jt]sx?|flow)$/i
Include files to be processed by the plugin. The value is the same as the rule.test option in Rspack.
1new ReactRefreshPlugin({ 2 include: [/\.jsx$/, /\.tsx$/], 3});
exclude
- Type: Rspack.RuleSetCondition
- Default:
/node_modules/
Exclude files from being processed by the plugin. The value is the same as the rule.exclude option in Rspack.
1new ReactRefreshPlugin({
2 exclude: [/node_modules/, /some-other-module/],
3});forceEnable
- Type:
boolean - Default:
false
Whether to force enable the plugin.
By default, the plugin will not be enabled in non-development environments. If you want to force enable the plugin, you can set this option to true.
1new ReactRefreshPlugin({
2 forceEnable: true,
3});It is useful if you want to:
- Use the plugin in production.
- Use the plugin with the
nonemode without settingNODE_ENV. - Use the plugin in environments we do not support, such as
electron-prerender(WARNING: Proceed at your own risk).
library
- Type:
string - Default:
output.uniqueName || output.library
Sets a namespace for the React Refresh runtime.
It is most useful when multiple instances of React Refresh is running together simultaneously.
overlay
- Type:
boolean | OverlayOptions - Default:
false
Modify the behavior of the error overlay.
- Enable the error overlay:
1new ReactRefreshPlugin({
2 overlay: true,
3});- Configure the error overlay:
1new ReactRefreshPlugin({ 2 overlay: { 3 // ... 4 }, 5});
Credits
Thanks to the react-refresh-webpack-plugin created by @pmmmwh, which inspires implement this plugin.
License
@rspack/plugin-react-refresh is MIT licensed.
No vulnerabilities found.
No security vulnerabilities found.