Rspack.Configuration | Function | undefined
undefined
tools.rspack
is used to configure Rspack.
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.
tools.rspack
can be configured as an object to be deep merged with the built-in Rspack configuration through webpack-merge.
For example, add resolve.alias
configuration:
tools.rspack
can be configured as a function. The first parameter of this function is the built-in Rspack configuration object, you can modify this object, and then return it. For example:
The object returned by the tools.rspack
function is used directly as the final Rspack configuration and is not merged with the built-in Rspack configuration.
tools.rspack
can also be an async function:
The second parameter of this function is an object, which contains some utility functions and properties, as follows:
'development' | 'production' | 'test'
The env
parameter can be used to determine whether the current environment is development, production or test. For example:
boolean
Used to determine whether the current build is a development build, such as:
boolean
Used to determine whether the current build is a production build, such as:
'web' | 'node' | 'web-worker' | 'service-worker'
The target
parameter can be used to determine the build target environment. For example:
boolean
Determines whether the target environment is node
, equivalent to target === 'node'
.
boolean
Determines whether the target environment is web-worker
, equivalent to target === 'web-worker'
.
Rspack
The Rspack instance. For example:
(rules: RuleSetRule | RuleSetRule[]) => void
Add additional Rspack rules.
For example:
(plugins: BundlerPluginInstance | BundlerPluginInstance[]) => void
Add additional plugins to the head of the internal Rspack plugins array, and the plugin will be executed first.
(plugins: BundlerPluginInstance | BundlerPluginInstance[]) => void
Add additional plugins at the end of the internal Rspack plugins array, the plugin will be executed last.
(name: string) => void
Remove the internal Rspack plugin, the parameter is the constructor.name
of the plugin.
For example, remove the internal webpack-bundle-analyzer:
(...configs: RspackConfig[]) => RspackConfig
Used to merge multiple Rspack configs, same as webpack-merge.
The mergeConfig method will create a new config object without modifying the original config object, so you need to return the result of mergeConfig.