close
  • 简体中文
  • 开启调试模式

    为了便于排查问题,Rsbuild 提供了调试模式,你可以在执行构建时添加 DEBUG=rsbuild 环境变量来开启 Rsbuild 的调试模式。

    # 调试开发模式
    DEBUG=rsbuild pnpm dev
    
    # 调试生产模式
    DEBUG=rsbuild pnpm build

    在调试模式下,Rsbuild 会输出一些额外的日志信息,并将内部最终生成的 Rsbuild 配置和 Rspack 配置写入到产物目录下,便于开发者查看和调试。

    日志信息

    在调试模式下,你会看到 terminal 中输出了一些以 rsbuild 开头的日志,包括 Rsbuild 内部执行的操作、当前使用的 Rspack 版本等。

    $ DEBUG=rsbuild pnpm dev
    
      ...
      rsbuild 10:00:00 configuration loaded from: /path/to/...
      rsbuild 10:00:00 registering default plugins
      rsbuild 10:00:00 default plugins registered
      ...

    此外,terminal 中还会输出以下日志,表示 Rsbuild 将内部生成的构建配置写入到磁盘中,此时你可以打开这些配置文件来查看相应的内容。

    config inspection completed, generated files:
    
      - Rsbuild config: /Project/demo/dist/.rsbuild/rsbuild.config.mjs
      - Rspack config (web): /Project/demo/dist/.rsbuild/rspack.config.web.mjs

    Rsbuild 配置文件

    在调试模式下,Rsbuild 会自动生成 dist/.rsbuild/rsbuild.config.mjs 文件,这里面包含了最终生成的 Rsbuild 配置。在这个文件里,你可以了解到你传入的 Rsbuild 配置在经过框架层和 Rsbuild 处理后的最终结果。

    该文件的大致结构如下:

    rsbuild.config.mjs
    export default {
      dev: {
        // some configs...
      },
      source: {
        // some configs...
      },
      // other configs...
    };

    关于 Rsbuild 配置项的完整介绍,请查看 配置 Rsbuild 章节。

    Rspack 配置文件

    在调试模式下,Rsbuild 还会自动生成 dist/.rsbuild/rspack.config.web.mjs 文件,这里面包含了最终生成的 Rspack 配置。在这个文件里,你可以了解到 Rsbuild 最终传递给 Rspack 的配置里包含了哪些内容。

    该文件的大致结构如下:

    rspack.config.web.mjs
    export default {
      resolve: {
        // some resolve configs...
      },
      module: {
        // some Rspack loaders...
      },
      plugins: [
        // some Rspack plugins...
      ],
      // other configs...
    };

    关于 Rspack 配置项的完整介绍,请查看 Rspack 官方文档