Rslib adapter reference
For setup, see the Rslib integration overview. This page contains the complete adapter API, configuration mapping, cache behavior, and debugging workflow.
API
withRslibConfig(options)
Returns a configuration function that loads or accepts Rslib config and converts it to Rstest configuration.
cwd
- Type:
string - Default:
process.cwd()
The cwd is the working directory to resolve the Rslib config file.
When your Rslib config is in a different directory or you are running tests in a monorepo (where your process.cwd() is not your config directory), you can specify the cwd option to resolve the Rslib config file from a different directory.
configPath
- Type:
string - Default:
'./rslib.config.ts'
Path to rslib config file.
If both config and configPath are provided, config takes precedence as the config content.
config
- Type:
RslibConfig - Default:
undefined
The inline Rslib config object to convert directly. When config is provided, the adapter does not call Rslib's loadConfig.
If configPath is also provided, the adapter uses it as config file metadata for forceRerunTriggers and build cache dependency resolution, but the inline config still takes precedence as the config content.
libId
- Type:
string - Default:
undefined
The lib config id in lib field to use. Set to a string to use the lib config with matching id.
By default, the adapter uses the common configuration from Rslib. If your Rslib config has multiple lib configurations:
You can then reference specific lib configurations in your Rstest config. Rstest will adapt the Rslib shared configuration and the lib configuration with a matching libId to Rstest format.
This still does not copy the whole lib config verbatim. The adapter only takes the lib's source, output, tools, plugins, and resolve fields that are relevant to test execution, then merges them with the shared config before converting the result to Rstest format.
When you need to test multiple parts of your application with different configurations independently, you can define multiple Rstest projects. Each project can extend a specific lib configuration by setting the libId option.
modifyLibConfig
- Type:
(config: RslibConfig) => RslibConfig | void - Default:
undefined
Modify the Rslib config before it gets converted to Rstest config:
Cache behavior
When performance.buildCache is enabled in your Rslib config, withRslibConfig() passes it through to Rstest and Rstest will still append its own cache defaults, such as runtime digest inputs and config-file-based invalidation.
If your Rslib config does not enable performance.buildCache, Rstest keeps it disabled by default. Enable it explicitly in your Rstest config when you want persistent cache for test builds:
Configuration mapping
The adapter automatically maps these Rslib options to Rstest:
Only the fields listed below are inherited. Rslib options that are not listed are ignored by default, which means test-irrelevant sections such as dev, server, and html are automatically pruned during conversion.
Debug config
To see the resolved configuration returned by the adapter, wrap it and log the result: