Builder 提供了丰富的配置项,以帮助使用者对构建行为进行定制。
Builder 中的配置可以分为以下几类:
你可以在 API Reference 页面找到所有配置项的详细说明。
Builder 为每个配置项预设了一个默认值,默认值可以满足大部分使用场景。同时,上层框架也会基于垂直场景的需求,覆盖一部分配置的默认值。
因此,在大多数情况下,你不需要声明任何 Builder 配置,直接开箱使用即可。
当你使用一个基于 Builder 的上层框架时,你可以直接通过框架的配置文件来定义 Builder 配置,上层框架会自动将相关配置透传给 Builder。
比如在 Modern.js 框架中,你可以直接在 modern.config.ts 文件里定义 Builder 的 source.alias 配置:
export default {
source: {
alias: {
'@common': './src/common',
},
},
};
当你通过 Node API 调用 Builder 时,你可以通过 Provider 的 builderConfig
配置项来传入 Builder 配置:
import { builderWebpackProvider } from '@modern-js/builder-webpack-provider';
const provider = builderWebpackProvider({
builderConfig: {
// some configs
},
});
关于 Node API 的完整用法,请参考 API - createBuilder。
通常来说,Builder 配置是框架配置的子集。
Builder 配置只处理构建相关行为,而框架配置涵盖的范围更大,还包括运行时、服务端、部署等方面,因此框架是在 Builder 配置的基础上扩展出来的。
在执行构建时,你可以添加 DEBUG=builder
环境变量来开启 Builder 的调试模式。
DEBUG=builder pnpm dev
在调试模式下,Builder 会将内部最终生成的 Builder 配置写入到产物目录下,便于开发者查看和调试。
Inspect config succeed, open following files to view the content:
- Builder Config: /Project/demo/dist/builder.config.js
- Webpack Config (web): /Project/demo/dist/webpack.config.web.js
打开生成的 /dist/builder.config.js
文件,即可查看 Builder 配置的完整内容。
关于调试模式的完整介绍,请查看 开启调试模式 章节。