Overview of the Nx Rspack Plugin

The Nx Plugin for Rspack contains executors, generators, and utilities for managing Rspack projects in an Nx Workspace.

Setting Up @nx/rspack

Installation

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.js
rspack.config.ts
rspack.config.mjs
rspack.config.mts
rspack.config.cjs
rspack.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.

{
  "plugins": [
    {
      "plugin": "@nx/rspack/plugin",
      "options": {
        "buildTargetName": "build",
        "previewTargetName": "preview",
        "serveTargetName": "serve",
        "serveStaticTargetName": "serve-static"
      }
    }
  ]
}

The 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 that uses Rspack. The @nx/react:app generator accepts 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:

nx g @nx/react:app my-app --bundler=rspack

Modify 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.