The Nx Plugin for Rspack contains executors, generators, and utilities for managing Rspack projects in an Nx Workspace.
Setting Up @nx/rspack
Installation
Make sure to install the @nx/rspack version that matches the version of nx in your repository. If the version numbers get out of sync, you can encounter some difficult to debug errors. You can fix Nx version mismatches with this recipe.
In any Nx workspace, you can install @nx/rspack by running the following command:
❯
nx add @nx/rspack
This will install the correct version of @nx/rspack.
How @nx/rspack Infers Tasks
The @nx/rspack plugin will create a task for any project that has a Rspack configuration file present. Any of the following files will be recognized as a Rspack configuration file:
rspack.config.jsrspack.config.tsrspack.config.mjsrspack.config.mtsrspack.config.cjsrspack.config.cts
View Inferred Tasks
To view inferred tasks for a project, open the project details view in Nx Console or run nx show project my-project --web in the command line.
@nx/rspack Configuration
The @nx/rspack/plugin is configured in the plugins array in nx.json.
1{
2 "plugins": [
3 {
4 "plugin": "@nx/rspack/plugin",
5 "options": {
6 "buildTargetName": "build",
7 "previewTargetName": "preview",
8 "serveTargetName": "serve",
9 "serveStaticTargetName": "serve-static"
10 }
11 }
12 ]
13}
14The buildTargetName, previewTargetName, serveTargetName and serveStaticTargetName options control the names of the inferred Rspack tasks. The default names are build, preview, serve and serve-static.
Using @nx/rspack
Generate a new project using Rspack
You can generate a React application or library that uses Rspack. The @nx/react:app and @nx/react:lib generators accept the bundler option, where you can pass rspack. This will generate a new application configured to use Rspack, and it will also install all the necessary dependencies, including the @nx/rspack plugin.
To generate a React application using Rspack, run the following:
1nx g @nx/react:app my-app --bundler=rspack
2To generate a React library using Rspack, run the following:
1nx g @nx/react:lib my-lib --bundler=rspack
2Modify an existing React project to use Rspack
You can use the @nx/rspack:configuration generator to change your React to use Rspack. This generator will modify your project's configuration to use Rspack, and it will also install all the necessary dependencies, including the @nx/rspack plugin.
You can read more about this generator on the @nx/rspack:configuration generator page.