Rsbuild supports directly modifying the Rspack configuration object, and also supports modifying the built-in Rspack configuration of Rsbuild through rspack-chain
.
The built-in Rspack config in Rsbuild may change with iterations, and these changes won't be reflected in semver. Therefore, your custom config may become invalid when you upgrade Rsbuild.
Rsbuild provides the rsbuild inspect command to view the final Rspack config generated by Rsbuild.
You can also view it through debug mode.
You can use the tools.rspack option of Rsbuild to modify the Rspack config object.
For example, register Rspack plugins or webpack plugins:
Or modify the Rspack config with a function:
Please refer to the tools.rspack documentation for detailed usage.
rspack-chain is a utility library for configuring Rspack. It provides a chaining API, making the configuration of Rspack more flexible. By using rspack-chain
, you can more easily modify and extend Rspack configurations without directly manipulating the complex configuration object.
Rsbuild provides the tools.bundlerChain config to modify the rspack-chain. Its value is a function that takes two arguments:
rspack-chain
instance, which you can use to modify the Rspack config.env
, isProd
, CHAIN_ID
, etc.Here's a basic example:
tools.bundlerChain
can also be an async function:
Before using the rspack-chain to modify the Rspack configuration, it is recommended to familiarize yourself with some basics.
In short, the rspack-chain requires users to set a unique ID for each rule, loader, plugin, and minimizer. With this ID, you can easily find the desired object from deeply nested objects.
Rsbuild exports all internally defined IDs through the CHAIN_ID
object, so you can quickly locate the loader or plugin you want to modify using these exported IDs, without the need for complex traversal in the Rspack configuration object.
For example, you can remove the built-in HTML plugin using CHAIN_ID.PLUGIN.HTML
:
The CHAIN_ID
object contains various IDs, which correspond to the following configurations:
CHAIN_ID Field | Corresponding Configuration | Description |
---|---|---|
CHAIN_ID.PLUGIN |
plugins[i] |
Corresponds to a plugin in the Rspack configuration |
CHAIN_ID.RULE |
module.rules[i] |
Corresponds to a rule in the Rspack configuration |
CHAIN_ID.USE |
module.rules[i].loader |
Corresponds to a loader in the Rspack configuration |
CHAIN_ID.MINIMIZER |
optimization.minimizer |
Corresponds to a minimizer in the Rspack configuration |
CHAIN_ID.RESOLVE_PLUGIN |
resolve.plugins[i] |
Corresponds to a resolve plugin in the Rspack configuration |
Here are examples of adding, modifying, and removing Rspack loaders.
.md
files:Note: Rspack loaders are executed in reverse order.
Here are examples of adding, modifying, and deleting Rspack plugins.
In the tools.bundlerChain
function, you can access various environment identifiers in the second parameter, such as development/production build, SSR build, Web Worker build, to achieve configuration modifications for different environments.
The above are some common configuration examples. For the complete rspack-chain API, please refer to the rspack-chain documentation.
Rsbuild supports modifying the Rspack configuration object through tools.rspack
, tools.bundlerChain
, modifyBundlerChain
, etc.
The order of execution between them is: