From 9c509ff166509ee1d305d42583d4bce67aa4bc96 Mon Sep 17 00:00:00 2001 From: gaoyuan Date: Wed, 31 Jul 2024 19:52:59 +0800 Subject: [PATCH] docs: add environment dependencies (#3085) Co-authored-by: neverland --- .../docs/en/guide/advanced/environments.mdx | 21 +++++++++++++++++++ .../docs/zh/guide/advanced/environments.mdx | 21 +++++++++++++++++++ 2 files changed, 42 insertions(+) diff --git a/website/docs/en/guide/advanced/environments.mdx b/website/docs/en/guide/advanced/environments.mdx index a4765218ac..17dd01b97e 100644 --- a/website/docs/en/guide/advanced/environments.mdx +++ b/website/docs/en/guide/advanced/environments.mdx @@ -293,3 +293,24 @@ export async function startDevServer() { ``` For detailed usage, please refer to: [SSR + Express Example](https://github.com/rspack-contrib/rspack-examples/tree/main/rsbuild/ssr-express). + +## Add environment dependencies + +By default, Rsbuild builds all environments in parallel. If an environment in your project depends on other environments to be compiled first, you can add the name of the environment you need to depend on to Rspack's [dependencies](https://rspack.dev/config/other-options#dependencies) configuration. + +For example, the node environment depends on the web environment to be compiled first. You can add the following configuration: + +```ts title=rsbuild.config.ts +export default { + environments: { + web: {}, + node: { + tools: { + rspack: { + dependencies: ['web'], + }, + }, + }, + }, +}; +``` diff --git a/website/docs/zh/guide/advanced/environments.mdx b/website/docs/zh/guide/advanced/environments.mdx index b98a4ddccc..3044a1071b 100644 --- a/website/docs/zh/guide/advanced/environments.mdx +++ b/website/docs/zh/guide/advanced/environments.mdx @@ -293,3 +293,24 @@ export async function startDevServer() { ``` 详细使用情况可参考:[SSR + Express 示例](https://github.com/rspack-contrib/rspack-examples/tree/main/rsbuild/ssr-express)。 + +## 添加 environment 依赖 + +默认情况下,Rsbuild 会并行构建所有环境。如果你的项目中某一个环境依赖其他环境预先编译完成,可以将你需要依赖的环境名称添加到 Rspack 的 [dependencies](https://rspack.dev/zh/config/other-options#dependencies) 配置中。 + +例如,node 环境依赖 web 环境预先编译完成,可以添加如下配置: + +```ts title=rsbuild.config.ts +export default { + environments: { + web: {}, + node: { + tools: { + rspack: { + dependencies: ['web'], + }, + }, + }, + }, +}; +```