Configure Rsbuild#

Rsbuild provides a wide range of configuration options and sets a common default value for each option, which can meet the requirements of most use cases. Therefore, in most cases, you don't need to declare any Rsbuild configurations and can use it out of the box.

If you need to customize build behaviors, you can use these configuration options.

Configuration Structure#

The configuration structure of Rsbuild looks like this:

export default {
  plugins: [
    // configure Rsbuild plugins
  ],
  dev: {
    // options for local development
  },
  html: {
    // options for HTML generation
  },
  tools: {
    // options for the low-level tools
  },
  output: {
    // options for build outputs
  },
  resolve: {
    // options for module resolution
  },
  source: {
    // options for input source code
  },
  server: {
    // options for the Rsbuild Server,
    // will take effect during local development and preview
  },
  security: {
    // options for Web security
  },
  performance: {
    // options for build performance and runtime performance
  },
  moduleFederation: {
    // options for module federation
  },
  environments: {
    // define different Rsbuild configurations for each environment
  },
};

You can find detailed descriptions of all configs on the Configure Overview page.

Configuration File#

When you use the CLI of Rsbuild, Rsbuild will automatically read the configuration file in the root directory of the current project and resolve it in the following order:

• rsbuild.config.mjs
• rsbuild.config.ts
• rsbuild.config.js
• rsbuild.config.cjs
• rsbuild.config.mts
• rsbuild.config.cts

We recommend using the .mjs or .ts format for the configuration file and importing the defineConfig utility function from @rsbuild/core. It provides friendly TypeScript type hints and autocompletion, which can help you avoid errors in the configuration.

For example, in rsbuild.config.ts, you can define the Rsbuild resolve.alias configuration:

import { defineConfig } from '@rsbuild/core';

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

If you are developing a non-TypeScript project, you can use the .mjs format for the configuration file:

import { defineConfig } from '@rsbuild/core';

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

Specify Config File#

Rsbuild CLI uses the --config option to specify the config file, which can be set to a relative path or an absolute path.

For example, if you need to use the rsbuild.prod.config.mjs file when running build, you can add the following scripts to package.json:

{
  "scripts": {
    "build": "rsbuild build --config rsbuild.prod.config.mjs"
  }
}

You can also abbreviate the --config option to -c:

rsbuild build -c rsbuild.prod.config.mjs

Using Environment Variables#

In the configuration file, you can use Node.js environment variables such as process.env.NODE_ENV to dynamically set different configurations:

import { defineConfig } from '@rsbuild/core';

export default defineConfig({
  resolve: {
    alias: {
      '@request':
        process.env.NODE_ENV === 'development'
          ? './src/request.dev.js'
          : './src/request.prod.js',
    },
  },
});

Export Function#

Rsbuild supports the export of a function in the config file, where you can dynamically compute the config and return it to Rsbuild.

import { defineConfig } from '@rsbuild/core';

export default defineConfig(({ env, command, envMode }) => ({
  resolve: {
    alias: {
      '@foo': env === 'development' ? './src/foo.dev.ts' : './src/foo.prod.ts',
    },
  },
}));

The function accepts the following parameters:

env#

• Type: string
• Default: process.env.NODE_ENV

The current running environment.

• When running rsbuild dev, the default value of env is development.
• When running rsbuild build or rsbuild preview, the default value of env is production.

envMode#

• Type: string
• Default: process.env.NODE_ENV

The current value of the CLI parameter --env-mode.

For example, when running rsbuild build --env-mode test, the value of envMode is test.

command#

• Type: string

The current running CLI command, such as dev, build, preview.

Export Async Function#

Rsbuild also supports the export of an async function in the config file, where you can perform some async operations:

import { defineConfig } from '@rsbuild/core';

export default defineConfig(async ({ env, command }) => {
  const result = await someAsyncFunction();

  return {
    html: {
      title: result,
    },
  };
});

Merge Configurations#

You can use the mergeRsbuildConfig function exported by @rsbuild/core to merge multiple configurations.

import { defineConfig, mergeRsbuildConfig } from '@rsbuild/core';

const config1 = defineConfig({
  dev: { port: '3000' },
});
const config2 = defineConfig({
  dev: { port: '3001' },
});

// { dev: { port: '3001' }
export default mergeRsbuildConfig(config1, config2);

Debug the config#

You can enable Rsbuild's debug mode by adding the DEBUG=rsbuild environment variable when executing a build.

DEBUG=rsbuild pnpm dev

In debug mode, Rsbuild will write the Rsbuild config to the dist directory, which is convenient for developers to view and debug.

Open the generated /dist/.rsbuild/rsbuild.config.mjs file to see the complete content of the Rsbuild config.

For a complete introduction to debug mode, see the Debug Mode chapter.