close
Guide
Config
Plugin
API
Community
Guide
Config
Plugin
API
Community

environments

Rsbuild supports building outputs for multiple environments. You can use environments to define different Rsbuild configurations for each environment.

Please refer to Multi-Environment Builds for more information.

  • Type:
interface EnvironmentConfig {
  plugins?: RsbuildPlugins;
  dev?: Pick<
    DevConfig,
    'hmr' | 'assetPrefix' | 'progressBar' | 'lazyCompilation' | 'writeToDisk'
  >;
  html?: HtmlConfig;
  tools?: ToolsConfig;
  source?: SourceConfig;
  output?: OutputConfig;
  resolve?: ResolveConfig;
  security?: SecurityConfig;
  performance?: PerformanceConfig;
  moduleFederation?: ModuleFederationConfig;
}

type Environments = {
  [name: string]: EnvironmentConfig;
};
  • Default: undefined

Example

Configure Rsbuild configuration for web (client) and node (SSR) environments:

rsbuild.config.ts
export default {
  // Shared configuration for all environments
  resolve: {
    alias: {
      '@common': './src/common',
    },
  },
  environments: {
    // configuration for client
    web: {
      source: {
        entry: {
          index: './src/index.client.js',
        },
      },
      output: {
        target: 'web',
      },
      resolve: {
        alias: {
          '@common1': './src/web/common1',
        },
      },
    },
    // configuration for SSR
    node: {
      source: {
        entry: {
          index: './src/index.server.js',
        },
      },
      output: {
        target: 'node',
      },
      resolve: {
        alias: {
          '@common1': './src/ssr/common1',
        },
      },
    },
  },
};

For the web environment, the merged Rsbuild configuration is:

const webConfig = {
  source: {
    entry: {
      index: './src/index.client.js',
    },
  },
  output: {
    target: 'web',
  },
  resolve: {
    alias: {
      '@common': './src/common',
      '@common1': './src/web/common1',
    },
  },
};

For the node environment, the merged Rsbuild configuration is:

const nodeConfig = {
  source: {
    entry: {
      index: './src/index.server.js',
    },
  },
  output: {
    target: 'node',
  },
  resolve: {
    alias: {
      '@common': './src/common',
      '@common1': './src/ssr/common1',
    },
  },
};
ON THIS PAGE