nx/rspack-plugin.md at 28b48ad1f33c08b9673ad44dbaf3470c94ed5b54

docs(misc): update URls that should point to intro pages rather than API index pages (#31531 )

This PR fixes an issue introduced when we removed `/nx-api` pages:
https://github.com/nrwl/nx/pull/31453.

Most of the old `/nx-api/<plugin>` URLs should now go to
`/technologies/<plugin>/introduction`, since those pages contain what
was on the previous "overview" pages.

The only exception are places where we explicitly link to
`.../api/{generators,executors,migrations}` URLs, and the following
three blog posts that we want users to land on the API index.

-
https://github.com/nrwl/nx/blob/master/docs/blog/2022-03-29-the-react-cli-you-always-wanted-but-didnt-know-about.md?plain=1#L132
(https://nx.dev/blog/the-react-cli-you-always-wanted-but-didnt-know-about)
-
https://github.com/nrwl/nx/blob/master/docs/blog/2022-04-08-what-is-new-in-nx-13-10.md?plain=1#L245
(https://nx.dev/blog/what-is-new-in-nx-13-10)
-
https://github.com/nrwl/nx/blob/master/docs/blog/2022-05-02-nx-v14-is-out-here-is-all-you-need-to-know.md?plain=1#L253
(https://nx.dev/blog/nx-v14-is-out-here-is-all-you-need-to-know)

2025-06-10 15:08:29 -04:00

3.0 KiB

Raw Blame History

title	description
Overview of the Nx Rspack Plugin	The Nx Plugin for Rspack contains executors, generators, and utilities for managing Rspack projects in an Nx Workspace.

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

Setting Up @nx/rspack

Installation

{% callout type="note" title="Keep Nx Package Versions In Sync" %} 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. {% /callout %}

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.

3.0 KiB Raw Blame History