Guide
Config
Plugin
API
Guide
Config
Plugin
API

Rsbuild Core

This section describes some of the core methods provided by Rsbuild.

createRsbuild

Create a Rsbuild instance object.

  • Type:
function createRsbuild(options: CreateRsbuildOptions): Promise<RsbuildInstance>;
  • Example:
import { createRsbuild } from '@rsbuild/core';

const rsbuild = await createRsbuild({
  // options
});

options

The first parameter of createRsbuild is a options object, you can pass in the following options:

type RsbuildEntry = Record<string, string | string[]>;

type CreateRsbuildOptions = {
  cwd?: string;
  rsbuildConfig?: RsbuildConfig;
};

Description:

  • cwd: The root path of the current build, the default value is process.cwd().
  • provider: Used to switch the underlying bundler.
  • rsbuildConfig: Rsbuild configuration object. Rsbuild provides a rich set of configuration options that allow you to customize the build behavior flexibly. You can find all available configuration options in the Configuration section.

loadConfig

Load Rsbuild configuration file.

  • Type:
function loadConfig(params: {
  // Default is process.cwd()
  cwd: string;
  // Specify the configuration file, can be a relative or absolute path
  path?: string;
}): Promise<RsbuildConfig>;
  • Example:
const config = await loadConfig();

console.log(config); // -> RsbuildConfig

loadEnv

Load the .env file and return all environment variables starting with the specified prefixes.

  • Type:
function loadEnv(params: {
  // Default is process.cwd()
  cwd?: string;
  // Default is ['PUBLIC_']
  prefixes?: string[];
}): Promise<{
  // All environment variables in the .env file
  parsed: Record<string, string>;
  // Environment variables starting with the specified prefixes
  publicVars: Record<string, string>;
}>;
  • Example:
const { parsed, publicVars } = await loadEnv();

mergeRsbuildConfig(
  {
    source: {
      define: publicVars,
    },
  },
  userConfig,
);

This method will also load files such as .env.local and .env.[mode], see Environment Variables for details.

mergeRsbuildConfig

Used to merge multiple Rsbuild configuration objects.

The mergeRsbuildConfig function takes multiple configuration objects as parameters. It deep merges each configuration object, automatically combining multiple function values into an array of sequentially executed functions, and returns a merged configuration object.

  • Type:
function mergeRsbuildConfig(...configs: RsbuildConfig[]): RsbuildConfig;
  • Example:
import { mergeRsbuildConfig } from '@rsbuild/core';

const config1 = {
  dev: {
    https: false,
  },
};
const config2 = {
  dev: {
    https: true,
  },
};

const mergedConfig = mergeRsbuildConfig(config1, config2);

console.log(mergedConfig); // { dev: { https: true } }

This method will not modify the config object in the input parameter.

logger

Used to output log information in a unified format, based on rslog.

  • Example:
import { logger } from '@rsbuild/core';

// A gradient welcome log
logger.greet(`\n➜ Rsbuild v1.0.0\n`);

// Info
logger.info('This is a info message');

// Start
logger.start('This is a start message');

// Warn
logger.warn('This is a warn message');

// Ready
logger.ready('This is a ready message');

// Success
logger.success('This is a success message');

// Error
logger.error('This is a error message');
logger.error(new Error('This is a error message with stack'));

// Debug
logger.debug('This is a debug message');

// Same as console.log
logger.log('This is a log message');