指南
配置
插件
API
博客
关于
指南
配置
插件
API
博客
关于
简体中文

React

如何使用

Rspack 提供两种方案来支持 React：

  • 使用 Rsbuild：Rsbuild 提供对 React 开箱即用的支持，能够快速创建一个 React 项目，详见 "Rsbuild - React"。
  • 手动配置：你可以参考当前文档，手动添加 React 相关的配置。

配置 JSX/TSX

Rspack 使用 SWC 转译器支持 JSX/TSX。

添加 builtin:swc-loader 以支持 jsx 和 tsx:

rspack.config.js
module.exports = {
  module: {
    rules: [
      {
        test: /\.jsx$/,
        use: {
          loader: 'builtin:swc-loader',
          options: {
            jsc: {
              parser: {
                syntax: 'ecmascript',
                jsx: true,
              },
            },
          },
        },
        type: 'javascript/auto',
      },
      {
        test: /\.tsx$/,
        use: {
          loader: 'builtin:swc-loader',
          options: {
            jsc: {
              parser: {
                syntax: 'typescript',
                tsx: true,
              },
            },
          },
        },
        type: 'javascript/auto',
      },
    ],
  },
};

关于配置项的更多信息请参考 内置 swc-loader。

Fast Refresh

目前 Rspack 中有两种开启 React Fast Refresh 的方式：

builtins.react.refresh

Stability: Deprecated

早期 Rspack 为了部分项目的开箱即用，在 @rspack/dev-server 和 @rspack/core 中内置了 React Fast Refresh 功能，这意味着如果你使用了 @rspack/cli 或 @rspack/dev-server，在 dev 模式下会默认开启 React Fast Refresh 功能，你可以直接在项目中使用。这提升了 React 项目使用 Rspack 时的易用性，但也导致了很多其他问题。

这样做导致 Rspack 并不是真正意义上的框架无关，如果你在使用 Vue 等其他框架时，就需要手动通过 builtins.react.refresh 来禁用 React Fast Refresh 功能，以防止为一些 Vue 模块注入 React Fast Refresh 相关的代码。

我们意识到这一问题，希望通过 experiments.rspackFuture.disableTransformByDefault 和 @rspack/plugin-react-refresh 来帮助用户逐渐地迁移到更为正确的方式上来，即第二种方式。

@rspack/plugin-react-refresh

Added in v0.3.5
WARNING

@rspack/plugin-react-refresh 依赖于 experiments.rspackFuture.disableTransformByDefault

首先需要安装相关依赖：

npm
yarn
pnpm
bun
npm add @rspack/plugin-react-refresh react-refresh -D

React Fast Refresh 功能的开启主要分为两部分：代码注入和代码转换

rspack.config.js
const ReactRefreshPlugin = require('@rspack/plugin-react-refresh');
const isDev = process.env.NODE_ENV === 'development';

module.exports = {
  experiments: {
    rspackFuture: {
      disableTransformByDefault: true,
    },
  },
  // ...
  mode: isDev ? 'development' : 'production',
  module: {
    rules: [
      {
        test: /\.jsx$/,
        use: {
          loader: 'builtin:swc-loader',
          options: {
            jsc: {
              parser: {
                syntax: 'ecmascript',
                jsx: true,
              },
              transform: {
                react: {
                  development: isDev,
                  refresh: isDev,
                },
              },
            },
          },
        },
      },
    ],
  },
  plugins: [isDev && new ReactRefreshPlugin()].filter(Boolean),
};

相较于上一种方式，该方式将 React Fast Refresh 代码注入逻辑和转换逻辑解耦，代码注入逻辑统一通过 @rspack/plugin-react-refresh 插件完成，代码转换通过 loader 完成。这意味着该插件可以配合 builtin:swc-loader、swc-loader 或 babel-loader 使用：

集成 SVGR

SVGR 是一个用于将 SVG 转换为 React 组件的工具，

在 Rspack 中使用 SVGR 的方式与 webpack 中完全一致：

rspack.config.js
module.exports = {
  module: {
    rules: [
      {
        test: /\.svg$/i,
        issuer: /\.[jt]sx?$/,
        use: ['@svgr/webpack'],
      },
    ],
  },
};

对于 SVGR 的详细用法，请参考 SVGR 文档 - Webpack。