undefined
Create aliases to import or require certain modules, same as the resolve.alias config of Rspack.
For TypeScript projects, you only need to configure compilerOptions.paths in the tsconfig.json
file. The Rsbuild will automatically recognize it, so there is no need to configure the source.alias
option separately. For more details, please refer to Path Aliases.
The alias
can be an Object, and the relative path will be automatically converted to absolute path.
With above configuration, if @common/Foo.tsx
is import in the code, it will be mapped to the <project>/src/common/Foo.tsx
path.
The alias
can be a function, it will accept the previous alias object, and you can modify it.
You can also return a new object as the final result in the function, which will replace the previous alias object.
When you build for multiple environments, you can set different alias for each environment:
For example, set different alias for web
and node
environments:
By default, source.alias
will automatically match sub-paths, for example, with the following configuration:
It will match as follows:
You can add the $
symbol to enable exact matching, which will not automatically match sub-paths.
It will match as follows:
You can use alias
to resolve an npm package to a specific directory.
For example, if multiple versions of the react
are installed in the project, you can alias react
to the version installed in the root node_modules
directory to avoid bundling multiple copies of the React code.
When using alias to handle npm packages, please be aware of whether different major versions of the package are being used in the project.
For example, if a module or npm dependency in your project uses the React 18 API, and you alias React to version 17, the module will not be able to reference the React 18 API, resulting in code exceptions.