diff --git a/website/docs/en/guide/features/dev-server.mdx b/website/docs/en/guide/features/dev-server.mdx index 835d66f7ecd..4e600201253 100644 --- a/website/docs/en/guide/features/dev-server.mdx +++ b/website/docs/en/guide/features/dev-server.mdx @@ -2,6 +2,15 @@ Rspack CLI comes with a built-in `@rspack/dev-server` for development and debugging. Its capabilities are similar to `webpack-dev-server`, including features like Hot Module Replacement (HMR), proxy server and more. +:::warning + +`webpack-dev-server@5` is used in `@rspack/dev-server`, which has some differences from `webpack-dev-server@4`. + +- The minimum supported Node.js version for webpack-dev-server v5 is 18.12.0. +- Several configuration options have changed. Please refer to the [webpack-dev-server v5 migration guide](https://github.com/webpack/webpack-dev-server/blob/master/migration-v5.md) + +::: + ### HMR By default, Rspack enables HMR in dev mode. You can disable HMR by configuring the `devServer.hot` option in `rspack.config.js`. @@ -25,12 +34,13 @@ Rspack has a built-in simple proxy server. You can enable the proxy server by co ```js module.exports = { devServer: { - proxy: { - '/api': { + proxy: [ + { + context: ['/api'], target: 'http://localhost:3000', changeOrigin: true, }, - }, + ], }, }; ``` diff --git a/website/docs/en/guide/start/quick-start.mdx b/website/docs/en/guide/start/quick-start.mdx index 55b4811cf0e..3c6ade4b543 100644 --- a/website/docs/en/guide/start/quick-start.mdx +++ b/website/docs/en/guide/start/quick-start.mdx @@ -45,6 +45,8 @@ We recommend using [Rsbuild](https://rsbuild.dev/) to create new projects, simpl Rspack CLI is a tool comparable to Webpack CLI, offering the basic `serve` and `build` commands. +Rsbuild supports Node.js >= 16, but Rspack CLI requires Node.js version >= 18.12.0. + Run the following command to create an Rspack CLI project: diff --git a/website/docs/zh/guide/features/dev-server.mdx b/website/docs/zh/guide/features/dev-server.mdx index 857f3d808f6..a429130d03f 100644 --- a/website/docs/zh/guide/features/dev-server.mdx +++ b/website/docs/zh/guide/features/dev-server.mdx @@ -2,6 +2,15 @@ Rspack CLI 内置了 `@rspack/dev-server` 用于开发调试,它的能力与 `webpack-dev-server` 相似,内置了 HMR、代理服务器等功能。 +:::warning + +`@rspack/dev-server` 中使用了 `webpack-dev-server@5` ,与 `webpack-dev-server@4` 有一些差异。 + +- webpack-dev-server v5 最低支持的 Node.js 版本为 18.12.0。 +- 配置选项发生了若干变更,请参阅 [webpack-dev-server v5 的迁移指南](https://github.com/webpack/webpack-dev-server/blob/master/migration-v5.md)。 + +::: + ### HMR Rspack 在 dev 模式下默认开启了 HMR,你也可以在 `rspack.config.js` 中配置 `devServer.hot` 选项来关闭 HMR。 @@ -25,12 +34,13 @@ Rspack 内置了一个简单的代理服务器,你可以在 `rspack.config.js` ```js module.exports = { devServer: { - proxy: { - '/api': { + proxy: [ + { + context: ['/api'], target: 'http://localhost:3000', changeOrigin: true, }, - }, + ], }, }; ``` diff --git a/website/docs/zh/guide/start/quick-start.mdx b/website/docs/zh/guide/start/quick-start.mdx index b85e5cc74e9..64fdb6d5561 100644 --- a/website/docs/zh/guide/start/quick-start.mdx +++ b/website/docs/zh/guide/start/quick-start.mdx @@ -45,6 +45,8 @@ Rsbuild 是由 Rspack 驱动的高性能构建工具,由 Rspack 团队开发 Rspack CLI 是对标 Webpack CLI 的工具,提供基础的 `serve` 和 `build` 构建命令。 +Rsbuild 支持 Node.js >= 16,但是 Rspack CLI 要求 Node.js 版本 >= 18.12.0 + 执行如下命令即可创建基于 Rspack CLI 的项目: