命令行工具

Rsbuild 内置了一个轻量的命令行工具,包含 dev、build 等命令。

命令

rsbuild dev

rsbuild dev 命令用于启动一个本地开发服务器,对源代码进行开发环境编译。

Usage: rsbuild dev [options]

Options:
  --open                启动时是否在浏览器中打开页面
  -h, --help            显示命令帮助

rsbuild build

rsbuild build 命令默认会在 dist/ 目录下构建出可用于生产环境的产物。

Usage: rsbuild build [options]

Options:
  -h, --help            显示命令帮助

rsbuild preview

rsbuild preview 命令用于在本地预览生产环境构建的产物, 注意你需要提前执行 rsbuild build 命令构建出对应产物。

Usage: rsbuild preview [options]

Options:
  -h, --help            显示命令帮助

rsbuild inspect

rsbuild inspect 命令用于查看项目的 Rsbuild 配置以及 Rspack 配置。

Usage: rsbuild inspect [options]

Options:
  --env <env>           查看指定环境下的配置 (default: "development")
  --output <output>     指定在 dist 目录下输出的路径 (default: "/")
  --verbose             在结果中展示函数的完整内容
  -c --config <config>  指定配置文件路径,可以为相对路径或绝对路径
  -h, --help            显示命令帮助

当你在项目根目录下执行命令 npx rsbuild inspect 后,会在项目的 dist 目录生成以下文件:

  • rsbuild.config.js: 表示在构建时使用的 Rsbuild 配置。
  • rspack.config.web.js: 表示在构建时使用的 Rspack 配置。
➜ npx rsbuild inspect

Inspect config succeed, open following files to view the content:

  - Rsbuild Config: /project/dist/rsbuild.config.js
  - Rspack Config (web): /project/dist/rspack.config.web.js

指定环境

默认情况下,inspect 命令会输出开发环境的配置,你可以添加 --env production 选项来输出生产环境的配置:

rsbuild inspect --env production

完整内容

默认情况下,inspect 命令会省略配置对象中的函数内容,你可以添加 --verbose 选项来输出函数的完整内容:

rsbuild inspect --verbose

多种产物类型

如果当前项目有多种产物类型,比如同时构建了浏览器产物和 Node.js 产物,那么会在 dist 目录生成多份 Rspack 配置文件。

➜ npx rsbuild inspect

Inspect config succeed, open following files to view the content:

  - Rsbuild Config: /project/dist/rsbuild.config.js
  - Rspack Config (web): /project/dist/rspack.config.web.js
  - Rspack Config (node): /project/dist/rspack.config.node.js