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'
| 'client'
| 'liveReload'
| '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
environments does not support configuring server options and some dev options, because multiple environments share the same server instance.
Example
Configure Rsbuild configuration for web (client) and node (SSR) environments:
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',
},
},
};Environment name
Since environment names are used for directory names and object property names, we recommend using only letters, numbers, -, _, and $. When other characters are used, Rsbuild will display a warning.
export default {
environments: {
someName: {}, // ✅
some_name: {}, // ✅
'some-name': {}, // ✅
'some:name': {}, // ❌
},
};