resolve.alias#

• Type:

type Alias = Record<string, string | false | (string | false)[]> | Function;

• Default:

const defaultAlias = {
  '@swc/helpers': path.dirname(require.resolve('@swc/helpers/package.json')),
};

• Version: >=1.1.7

Set the alias for the module path, which is used to simplify the import path or redirect the module reference.

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 resolve.alias option separately. For more details, please refer to Path Aliases.

Basic usage#

resolve.alias can be an object, the key is the module path in the source code to be replaced, and the value is the target path to which the module will be mapped.

export default {
  resolve: {
    alias: {
      '@common': './src/common',
    },
  },
};

With the above configuration, if @common/Foo.tsx is imported in the code, it will be mapped to the <project-root>/src/common/Foo.tsx.

Function usage#

The resolve.alias can be a function, it will accept the previous alias object, and you can modify it.

export default {
  resolve: {
    alias: (alias) => {
      alias['@common'] = './src/common';
    },
  },
};

To remove the built-in @swc/helpers alias, delete it in the function:

export default {
  resolve: {
    alias: (alias) => {
      delete alias['@swc/helpers'];
    },
  },
};

You can also return a new object as the final result in the function, which will replace the preset alias object.

export default {
  resolve: {
    alias: (alias) => {
      return {
        '@common': './src/common',
      };
    },
  },
};

Differences with Rspack#

Rsbuild's resolve.alias is similar to Rspack's resolve.alias configuration, but there are some differences:

• If the value of resolve.alias is a relative path, Rsbuild will automatically convert it to an absolute path to ensure that the path is relative to the project root.

export default {
  resolve: {
    alias: {
      // Will be converted to `<project-root>/src/common`
      '@common': './src/common',
    },
  },
};

• Rsbuild additionally supports the function type.

Set by environment#

When you build for multiple environments, you can set different alias for each environment:

For example, set different alias for web and node environments:

export default {
  environments: {
    web: {
      resolve: {
        alias: {
          '@common': './src/web/common',
        },
      },
      output: {
        target: 'web',
      },
    },
    node: {
      resolve: {
        alias: {
          '@common': './src/node/common',
        },
      },
      output: {
        target: 'node',
      },
    },
  },
};

Exact matching#

By default, resolve.alias will automatically match sub-paths, for example, with the following configuration:

import path from 'node:path';

export default {
  resolve: {
    alias: {
      '@common': './src/common',
    },
  },
};

It will match as follows:

import a from '@common'; // resolved to `./src/common`
import b from '@common/util'; // resolved to `./src/common/util`

You can add the $ symbol to enable exact matching, which will not automatically match sub-paths.

import path from 'node:path';

export default {
  resolve: {
    alias: {
      '@common$': './src/common',
    },
  },
};

It will match as follows:

import a from '@common'; // resolved to `./src/common`
import b from '@common/util'; // remains as `@common/util`

Handling npm packages#

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.

import path from 'node:path';

export default {
  resolve: {
    alias: {
      react: path.resolve(__dirname, './node_modules/react'),
    },
  },
};

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 19 API, and you alias React to version 17, the module will not be able to reference the React 19 API, resulting in code exceptions.

Handling loader#

resolve.alias does not support creating aliases for loaders.

To create aliases for loaders, use Rspack's resolveLoader configuration.

export default {
  tools: {
    rspack: {
      resolveLoader: {
        alias: {
          'amazing-loader': require.resolve('path-to-your-amazing-loader'),
        },
      },
    },
  },
};