index int64 0 0 | repo_id stringlengths 16 181 | file_path stringlengths 28 270 | content stringlengths 1 11.6M | __index_level_0__ int64 0 10k |
|---|---|---|---|---|
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/html/faviconByEntries.md | - **类型：** `Record<string, string>`
- **默认值：** `undefined`
用于在多页面的场景下，为不同的页面设置不同的 favicon。
整体用法与 `favicon` 一致，并且可以使用「入口名称」作为 key ，对各个页面进行单独设置。
`faviconByEntries` 的优先级高于 `favicon`，因此会覆盖 `favicon` 中设置的值。
### 示例
```js
export default {
html: {
favicon: './src/assets/default.png',
faviconByEntries: {
foo... | 6,900 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/html/inject.md | - **类型：** `'head' | 'body'| 'true' | false`
- **默认值：** `'head'`
修改构建产物中 `<script>` 标签在 HTML 中的插入位置。
可以设置为以下值：
- `'head'`: script 标签会插入在 HTML 的 head 标签内。
- `'body'`: script 标签会插入在 HTML 的 body 标签尾部。
- `true`: 最终表现取决于 `html-webpack-plugin` 的 scriptLoading 配置项。
- `false`: script 标签不插入 HTML 中。
#### 默认插入位置
script 标签默认在 ... | 6,901 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/html/injectByEntries.md | - **类型：** `Record<string, boolean | string>`
- **默认值：** `undefined`
用于在多页面的场景下，为不同的页面设置不同的 script 标签插入位置。
整体用法与 `inject` 一致，并且可以使用「入口名称」作为 key ，对各个页面进行单独设置。
`injectByEntries` 的优先级高于 `inject`，因此会覆盖 `inject` 中设置的值。
### 示例
```js
export default {
html: {
inject: 'head',
injectByEntries: {
foo: 'body',
... | 6,902 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/html/meta.md | - **类型：** `Record<string, false | string | Record<string, string | boolean>>`
- **默认值：** `undefined`
配置 HTML 页面的 `<meta>` 标签。
### String 类型
当 `meta` 对象的 `value` 为字符串时，会自动将对象的 `key` 映射为 `name`，`value` 映射为 `content`。
比如设置 `description`：
```js
export default {
html: {
meta: {
description: 'a description o... | 6,903 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/html/metaByEntries.md | - **类型：** `Record<string, Meta>`
- **默认值：** `undefined`
用于在多页面的场景下，为不同的页面设置不同的 meta 标签。
整体用法与 `meta` 一致，并且可以使用「入口名称」作为 key ，对各个页面进行单独设置。
`metaByEntries` 的优先级高于 `meta`，因此会覆盖 `meta` 中设置的值。
### 示例
```js
export default {
html: {
meta: {
description: 'ByteDance',
},
metaByEntries: {
foo: {
... | 6,904 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/html/mountId.md | - **类型：** `string`
- **默认值：** `'root'`
默认情况下，HTML 模板中包含了 `root` 节点用于组件挂载，通过 `mountId` 可以修改该节点的 id。
```html
<body>
<div id="root"></div>
</body>
```
### 示例
修改 DOM 挂载节点 `id` 为 `app`：
```js
export default {
html: {
mountId: 'app',
},
};
```
编译后：
```html
<body>
<div id="app"></div>
</body>
```
### 注意事项
... | 6,905 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/html/scriptLoading.md | - **类型：** `'defer' | 'blocking' | 'module'`
- **默认值：** `'defer'`
用于设置 `<script>` 标签的加载方式。
### defer
默认情况下，Builder 生成的 `<script>` 标签会自动设置 `defer` 属性，以避免阻塞页面的解析和渲染。
```html
<head>
<script defer src="/static/js/main.js"></script>
</head>
<body></body>
```
:::tip
当浏览器遇到带有 defer 属性的 `<script>` 标签时，它会异步地下载脚本文件，不会阻塞页面的... | 6,906 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/html/tags.md | - **类型：** `ArrayOrNot<HtmlInjectTag | HtmlInjectTagHandler>`
- **默认值：** `undefined`
添加和修改最终注入到 HTML 页面的标签。
#### 对象形式
```ts
export interface HtmlInjectTag {
tag: string;
attrs?: Record<string, string | boolean | null | undefined>;
children?: string;
/** @default false */
hash?: boolean | string | ((url: str... | 6,907 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/html/tagsByEntries.md | - **类型：** `Record<string, ArrayOrNot<HtmlInjectTag | HtmlInjectTagHandler>>`
- **默认值：** `undefined`
用于在多页面的场景下，为不同的页面注入不同的标签。
整体用法与 `tags` 一致，并且可以使用「入口名称」作为 key ，对各个页面进行单独设置。
`tagsByEntries` 的优先级高于 `tags`，因此会覆盖 `tags` 中设置的值。
### 示例
```js
export default {
html: {
tags: [{ tag: 'script', attrs: { src: 'a.js' }... | 6,908 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/html/template.md | - **类型：** `string`
- **默认值：**
定义 HTML 模板的文件路径，对应 [html-webpack-plugin](https://github.com/jantimon/html-webpack-plugin) 的 `template` 配置项。
### 示例
使用自定义的 HTML 模板文件替代默认模板，可以添加如下设置：
```js
export default {
html: {
template: './static/index.html',
},
};
```
| 6,909 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/html/templateByEntries.md | - **类型：** `Object`
- **默认值：** `undefined`
用于在多页面的场景下，为不同的页面设置不同的 HTML 模板。
整体用法与 `template` 一致，并且可以使用「入口名称」作为 key ，对各个页面进行单独设置。
`templateByEntries` 的优先级高于 `template`，因此会覆盖 `template` 设置的值。
### 示例
```js
export default {
html: {
template: './static/index.html',
templateByEntries: {
foo: './src/pages/f... | 6,910 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/html/templateParameters.md | - **类型：** `Object | Function`
- **默认值：**
```ts
type DefaultParameters = {
meta: string; // 对应 html.meta 配置
title: string; // 对应 html.title 配置
mountId: string; // 对应 html.mountId 配置
entryName: string; // 入口名称
assetPrefix: string; // 对应 output.assetPrefix 配置
compilation: webpack.Compilation; // 对应 webpack 的 ... | 6,911 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/html/templateParametersByEntries.md | - **类型：** `Object`
- **默认值：** `undefined`
用于在多页面的场景下，为不同的页面设置不同的模板参数。
整体用法与 `templateParameters` 一致，并且可以使用「入口名称」作为 key ，对各个页面进行单独设置。
`templateParametersByEntries` 的优先级高于 `templateParameters`，因此会覆盖 `templateParameters` 中设置的值。
### 示例
```js
export default {
html: {
templateParametersByEntries: {
foo: {
... | 6,912 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/html/title.md | - **类型：** `string`
- **默认值：** `undefined`
配置 HTML 页面的 title 标签，例如：
```js
export default {
html: {
title: 'example',
},
};
```
| 6,913 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/html/titleByEntries.md | - **类型：** `Record<string, string>`
- **默认值：** `undefined`
用于在多页面的场景下，为不同的页面设置不同的 `title`。
整体用法与 `title` 一致，并且可以使用「入口名称」作为 key ，对各个页面进行单独设置。
`titleByEntries` 的优先级高于 `title`，因此会覆盖 `title` 中设置的值。
### 示例
```js
export default {
html: {
title: 'ByteDance',
titleByEntries: {
foo: 'TikTok',
},
},
};
... | 6,914 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/assetPrefix.md | - **类型：** `string`
- **默认值：** `'/'`
在生产环境使用 CDN 部署时，可使用该选项设置静态资源的 URL 前缀。
`assetPrefix` 会影响构建产物中绝大部分静态资源的 URL，包括 JavaScript 文件、CSS 文件、图片、视频等。如果指定了一个错误的值，则在加载这些资源时可能会出现 404 错误。
该配置项仅用于生产环境。在开发环境下，请使用 `dev.assetPrefix` 配置项进行设置。
设置后，项目的 JavaScript、CSS、图片等静态资源的 URL 都会加上 `output.assetPrefix` 作为前缀：
### 示例
```js
export ... | 6,915 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/assetsRetry.md | - **类型：** `Object`
`output.assetsRetry` 用于配置资源加载失败时的重试逻辑。配置类型如下:
```ts
export type AssetsRetryHookContext = {
times: number;
domain: string;
url: string;
tagName: string;
};
export type AssetsRetryOptions = {
type?: string[];
domain?: string[];
max?: number;
test?: string | ((url: string) => boolean)... | 6,916 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/charset.md | - **类型：** `'ascii' | 'utf8'`
- **默认值：** `'ascii'`
默认情况下，Builder 的产物内容是纯 ASCII 的，并且会转义所有非 ASCII 字符。
如果不希望进行转义，而是输出所有原始字符，可以将 `output.charset` 设置为 `utf8`。
```js
export default {
output: {
charset: 'utf8',
},
};
```
当 `output.charset` 为 `utf8` 时，Builder 会自动将 `<meta charset="utf-8">` 添加到生成的 HTML 文件中。
| 6,917 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/cleanDistPath.md | - **类型：** `boolean`
- **默认值：** `true`
是否在构建开始前清理 dist 目录下的所有文件。
默认情况下，Builder 会自动清理 dist 目录下的文件，你可以把 `cleanDistPath` 设置为 `false` 来禁用该行为。
```js
export default {
output: {
cleanDistPath: false,
},
};
```
| 6,918 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/convertToRem.md | - **类型：** `boolean | object`
- **默认值：** `false`
通过设置 `output.convertToRem`，Builder 可进行如下处理：
- 将 CSS 中的 px 转成 rem
- 在 HTML 模版中插入运行时代码，对根元素 fontSize 进行设置
### Boolean 类型
当设置 `output.convertToRem` 为 `true`，将开启 rem 处理能力。
```js
export default {
output: {
convertToRem: true,
},
};
```
此时，rem 配置默认如下：
```js
{
e... | 6,919 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/copy.md | - **类型：** `CopyPluginOptions | CopyPluginOptions['patterns']`
- **默认值：** `undefined`
将指定的文件或目录拷贝到构建输出目录中。
例如，将 `src/assets` 下的文件直接拷贝到 dist 目录：
```js
export default {
output: {
copy: [{ from: './src/assets', to: '' }],
},
};
```
更详细的配置项请参考：[copy-webpack-plugin](https://github.com/webpack-contrib/copy-webpack... | 6,920 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/cssModuleLocalIdentName.md | - **类型：** `string`
- **默认值：**
```ts
// isProd 表示生产环境构建
const localIdentName = isProd
? '[local]-[hash:base64:6]'
: '[path][name]__[local]-[hash:base64:6]';
```
设置 CSS Modules 编译后生成的 className 格式。
### 默认值
`cssModuleLocalIdentName` 在开发环境和生产环境有不同的默认值。
在生产环境，Builder 会生成更简短的类名，从而减少构建产物的体积。
```ts
import styles from... | 6,921 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/cssModules.md | - **类型：**
```ts
type CssModuleLocalsConvention =
| 'asIs'
| 'camelCase'
| 'camelCaseOnly'
| 'dashes'
| 'dashesOnly';
type CssModules = {
auto?: boolean | RegExp | ((resourcePath: string) => boolean);
exportLocalsConvention?: CssModuleLocalsConvention;
};
```
- **默认值：**
```ts
const defaultCssModules = ... | 6,922 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/dataUriLimit.md | - **类型：**
```ts
type DataUriLimitConfig = {
svg?: number;
font?: number;
image?: number;
media?: number;
};
```
- **默认值：**
```js
const defaultDatUriLimit = {
svg: 10000,
font: 10000,
image: 10000,
media: 10000,
};
```
设置图片、字体、媒体等静态资源被自动内联为 base64 的体积阈值。
默认情况下，体积小于 10KB 的图片、字体、媒体等文件，会自动经过 Base64 编码，... | 6,923 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/disableCssExtract.md | - **类型：** `boolean`
- **默认值：** `false`
是否禁用 CSS 提取逻辑，并将 CSS 文件内联到 JS 文件中。
默认情况下，Builder 会把 CSS 提取为独立的 `.css` 文件，并输出到构建产物目录。设置该选项为 `true` 后，CSS 文件会被内联到 JS 文件中，并在运行时通过 `<style>` 标签插入到页面上。
### 示例
```ts
export default {
output: {
disableCssExtract: true,
},
};
```
| 6,924 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/disableCssModuleExtension.md | - **类型：** `boolean`
- **默认值：** `false`
是否将源码目录下的所有样式文件当做 CSS Modules 模块进行处理。
在默认情况下，只有 `*.module.css` 结尾的文件才被视为 CSS Modules 模块。开启该配置项之后，会将源码目录下的所有 `*.css` 样式文件当做 CSS Modules 模块。
`.sass`、`.scss` 和 `.less` 文件的处理规则与 `.css` 文件一致，也会受到 `disableCssModuleExtension` 的影响。
:::tip
我们不推荐开启此配置项，因为开启 `disableCssModuleExtension` 后... | 6,925 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/disableFilenameHash.md | - **类型：** `boolean`
- **默认值：** `false`
移除生产环境的构建产物名称中的 hash 值。
在生产环境构建后，会自动在文件名中间添加 hash 值，如果不需要添加，可以通过 `output.disableFilenameHash` 配置来禁用该行为。
### 示例
默认情况下，构建后的产物名称为：
```bash
File Size Gzipped
dist/static/css/187.7879e19d.css 126.99 KB 9.17 KB
dist/static/js/m... | 6,926 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/disableInlineRuntimeChunk.md | - **类型：** `boolean`
- **默认值：** `false`
用于控制是否将打包工具的 runtime 代码内联到 HTML 中。
:::tip 什么是 runtimeChunk
当 Builder 构建完成后，会在 dist 目录生成 `builder-runtime.js` 文件，该文件为 webpack 或 Rspack 的 runtime 代码，即 runtimeChunk。
runtimeChunk 是一段运行时代码，它由 webpack 或 Rspack 提供，包含必要的模块处理逻辑，比如模块加载、模块解析等，具体可参考 [Runtime](https://webpack.js.org/conce... | 6,927 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/disableMinimize.md | - **类型：** `boolean`
- **默认值：** `false`
是否禁用生产环境下的代码压缩。
默认情况下，JS 代码和 CSS 代码会在生产环境构建时被自动压缩，从而提升页面性能。如果你不希望执行代码压缩，可以将 `disableMinimize` 设置为 `true`。
```js
export default {
output: {
disableMinimize: true,
},
};
```
:::tip
该配置项通常用于代码调试和问题排查，不建议在生产环境禁用代码压缩，否则会导致页面性能显著下降。
:::
| 6,928 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/disableSourceMap.md | - **类型：**
```ts
type DisableSourceMap =
| boolean
| {
js?: boolean;
css?: boolean;
};
```
- **默认值：**
```ts
const defaultDisableSourceMap = {
js: false,
css: process.env.NODE_ENV === 'production',
};
```
是否禁用 Source Map 生成。
:::tip 什么是 Source Map
Source Map 是保存源代码映射关系的信息文件，它记录了编译后的代码的每一个位置，以及... | 6,929 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/disableSvgr.md | - **类型：** `boolean`
- **默认值：** `false`
是否调用 SVGR 将 SVG 转化为 React 组件。如果设置为 true，将把所有的.svg 文件视为资源处理。
默认情况下，在 JS 文件中引用 SVG 资源时，Builder 会调用 SVGR，将 SVG 图片转换为一个 React 组件。
如果你确定项目内的所有 SVG 资源都没有当成 React 组件使用时，可以通过将 `disableSvgr` 设置为 true 来关闭此项转换，以提升构建性能。
```js
export default {
output: {
disableSvgr: true,
},
};
```
| 6,930 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/disableTsChecker.md | - **类型：** `boolean`
- **默认值：** `false`
是否禁用编译过程中的 TypeScript 类型检查。
默认情况下，Builder 执行构建的过程中，会在一个独立的进程里运行 TypeScript 类型检查工具，它的检查逻辑与 TypeScript 原生的 `tsc` 命令一致，你可以通过 `tsconfig.json` 或是 Builder 的 `tools.tsChecker` 配置项来自定义检查行为。
### 阻塞编译
- 在开发环境构建时，类型错误不会阻塞编译流程。
- 在生产环境构建时，类型错误会导致构建失败，以保证生产环境代码的稳定性。
### 示例
禁用 TypeScript ... | 6,931 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/distPath.md | - **类型：**
```ts
type DistPathConfig = {
root?: string;
html?: string;
js?: string;
css?: string;
svg?: string;
font?: string;
wasm?: string;
image?: string;
media?: string;
server?: string;
worker?: string;
};
```
- **默认值：**
```js
const defaultDistPath = {
root: 'dist',
html: 'html',
js: ... | 6,932 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/enableAssetFallback.md | - **类型：** `boolean`
- **默认值：** `false`
开启该选项后，当编译过程中遇到无法识别的文件类型时，会直接将该文件直接输出到产物目录；否则会抛出一个异常。
### 示例
开启配置项：
```js
export default {
output: {
enableAssetFallback: true,
},
};
```
在代码中引用一个未知类型的模块：
```js
import './foo.xxx';
```
编译后，`foo.xxx` 会被自动输出到 `dist/static/media` 目录下。
你可以通过 `output.distPath.media` 和 `... | 6,933 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/enableAssetManifest.md | - **类型：** `boolean`
- **默认值：** `false`
是否生成 manifest 文件，该文件包含所有构建产物的信息。
### 示例
添加以下配置来开启：
```js
export default {
output: {
enableAssetManifest: true,
},
};
```
开启后，当编译完成时，会自动生成 `dist/asset-manifest.json` 文件：
```json
{
"files": {
"main.css": "/static/css/main.45b01211.css",
"main.js": "/static/js... | 6,934 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/enableCssModuleTSDeclaration.md | - **类型：** `boolean`
- **默认值：** `false`
是否生成 CSS Modules 的 TypeScript 声明文件。
### Example
启用 CSS Module TypeScript 声明，比如：
```js
export default {
output: {
enableCssModuleTSDeclaration: true,
},
};
```
项目构建完成后，每个 CSS Module 文件都会生成一个 `.d.ts` 文件。例如：
```ts
interface CssExports {
title: string;
}
export const c... | 6,935 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/enableInlineScripts.md | - **类型：**
```ts
type EnableInlineScripts =
| boolean
| RegExp
| ((params: { size: number; name: string }) => boolean);
```
- **默认值：** `false`
- **打包工具：** `仅支持 webpack`
用来控制生产环境中是否用 `<script>` 标签将产物中的 script 文件（.js 文件）inline 到 HTML 中。
注意，如果开启了这个选项，那么 script 文件将不会被写入产物目录中，而只会以 inline 脚本的形式存在于 HTML 文件中。
:::tip
... | 6,936 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/enableInlineStyles.md | - **类型：**
```ts
type EnableInlineStyles =
| boolean
| RegExp
| ((params: { size: number; name: string }) => boolean);
```
- **默认值：** `false`
用来控制生产环境中是否用 `<style>` 标签将产物中的 style 文件（.css 文件）inline 到 HTML 中。
注意，如果开启了这个选项，那么 style 文件将不会被写入产物目录中，而只会以 inline 样式的形式存在于 HTML 文件中。
:::tip
当使用约定式路由时，如果开启了这个选项，需要将 [outp... | 6,937 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/enableLatestDecorators.md | - **类型：** `boolean`
- **默认值：** `false`
是否要使用 [新版 decorator 提案](https://github.com/tc39/proposal-decorators/tree/7fa580b40f2c19c561511ea2c978e307ae689a1b) 进行编译。
默认情况下，Builder 在编译装饰器时采用 [旧版 decorator 提案](https://github.com/wycats/javascript-decorators/blob/e1bf8d41bfa2591d949dd3bbf013514c8904b913/README.md)。
将 `output... | 6,938 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/externals.md | - **类型：** `string | object | function | RegExp`
- **默认值：** `undefined`
在构建时，防止将代码中某些 `import` 的依赖包打包到 bundle 中，而是在运行时再去从外部获取这些依赖。
详情请见: [webpack 外部扩展 (Externals)](https://webpack.docschina.org/configuration/externals/)
### 示例
将 `react-dom` 依赖从构建产物中剔除。为了在运行时获取这个模块, `react-dom` 的值将全局检索 `ReactDOM` 变量。
```js
export de... | 6,939 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/filename.md | - **类型：**
```ts
type FilenameConfig = {
js?: string;
css?: string;
svg?: string;
font?: string;
image?: string;
media?: string;
};
```
- **默认值：**
```js
// 开发环境
const devDefaultFilename = {
js: '[name].js',
css: '[name].css',
svg: '[name].[contenthash:8].svg',
font: '[name].[contenthash:8][ext]',
... | 6,940 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/legalComments.md | - **类型：** `'linked' | 'inline' | 'none'`
- **默认值：** `'linked'`
配置 legal comment 的处理方式。
legal comment 是 JS 或 CSS 文件中的一些特殊注释，这些注释包含 `@license` 或 `@preserve`，或是以 `//!` 开头。默认情况下，这些注释保留在输出文件中，因为这遵循了代码原作者的意图。
你可以通过 `legalComments` 来配置相关行为：
- `linked`：将所有 legal comments 移至 .LEGAL.txt 文件并通过注释链接到它们。
- `inline`：保留所有 legal co... | 6,941 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/overrideBrowserslist.md | - **类型：** `string[] | Record<BuilderTarget, string[]>`
- **默认值：** `undefined`
指定项目兼容的目标浏览器范围。该值会被 [@babel/preset-env](https://babeljs.io/docs/en/babel-preset-env) 和 [autoprefixer](https://github.com/postcss/autoprefixer) 用来确定需要转换的 JavaScript 语法特性和需要添加的 CSS 浏览器前缀。
#### 优先级
`overrideBrowserslist` 配置的优先级高于项目中的 `.browse... | 6,942 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/polyfill.md | - **类型：** `'entry' | 'usage' | 'ua' | 'off'`
- **默认值：** `'entry'`
通过 `output.polyfill` 你可以配置 Polyfill 的注入方式。
### 配置项
#### entry
当 `output.polyfill` 配置为 `'entry'` 时，会在每个入口文件中注入 Polyfill。
等价于 `@babel/preset-env` 的 `useBuiltIns: 'entry'` 配置。
#### usage
当 `output.polyfill` 配置为 `'usage'` 时，会在每个文件中根据代码中使用的 API 注入 Poly... | 6,943 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/output/svgDefaultExport.md | - **类型：** `'url' | 'component'`
- **默认值：** `'url'`
`output.svgDefaultExport` 可以用来配置 SVG 文件的默认导出。
当 `output.svgDefaultExport` 配置为 `url` 时，SVG 文件的默认导出是文件的 URL。例如：
```js
import logo from './logo.svg';
console.log(logo); // => 资源 url
```
当 `output.svgDefaultExport` 配置为 `component` 时，SVG 文件的默认导出是文件的 React 组件。例如：
```js... | 6,944 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/performance/buildCache.md | - **类型：**
```ts
type BuildCacheConfig =
| {
/**
* webpack 文件缓存系统的缓存目录
*/
cacheDirectory?: string;
/**
* 根据 cacheDigest 内容设置不同的缓存名称
*/
cacheDigest?: Array<string | undefined>;
}
| boolean;
```
- **默认值：**
```js
const defaultBuildCacheConfig = {
cacheDirecto... | 6,945 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/performance/bundleAnalyze.md | - **类型：** `Object | undefined`
用于开启 [webpack-bundle-analyzer](https://github.com/webpack-contrib/webpack-bundle-analyzer) 插件来分析产物体积。
默认情况下，Builder 不会开启 `webpack-bundle-analyzer`。当开启该功能后，内部的默认配置如下:
```js
const defaultConfig = {
analyzerMode: 'static',
openAnalyzer: false,
// target 为编译目标，如 `web`、`node` 等
repo... | 6,946 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/performance/chunkSplit.md | - **类型：** `Object`
- **默认值：** `{ strategy: 'split-by-experience' }`
`performance.chunkSplit` 用于配置 Builder 的拆包策略。配置项的类型 `ChunkSplit` 如下:
```ts
type ForceSplitting = RegExp[] | Record<string, RegExp>;
interface BaseChunkSplit {
strategy?:
| 'split-by-module'
| 'split-by-experience'
| 'all-in-one'
| '... | 6,947 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/performance/dnsPrefetch.md | - **类型：** `undefined | string[]`
- **默认值：** `undefined`
为哪些资源配置 [dns-prefetch](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel/dns-prefetch) 属性。
配置该属性可以在请求资源之前解析域名，降低请求延迟，提升加载性能。
更多信息可参考：[Using dns-prefetch](https://developer.mozilla.org/en-US/docs/Web/Performance/dns-prefetch)
### 示例
```js
expor... | 6,948 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/performance/preconnect.md | - **类型：** `undefined | Array<string | PreconnectOption>`
```ts
interface PreconnectOption {
href: string;
crossorigin?: boolean;
}
```
- **默认值：** `undefined`
为哪些资源配置 [preconnect](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel/preconnect) 属性。
配置该属性会预先建立与服务器的连接，如果站点是 HTTPS 的，则此过程包括 DNS 解析，建立 TCP 连... | 6,949 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/performance/prefetch.md | - **类型：** `undefined | true | PrefetchOption`
```ts
type IncludeType = 'async-chunks' | 'initial' | 'all-assets' | 'all-chunks';
type Filter = Array<string | RegExp> | ((filename: string) => boolean);
interface PrefetchOption {
type?: IncludeType;
include?: Filter;
exclude?: Filter;
}
```
- **默认值：** `undefined`... | 6,950 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/performance/preload.md | - **类型：** `undefined | true | PreloadOption`
```ts
type IncludeType = 'async-chunks' | 'initial' | 'all-assets' | 'all-chunks';
type Filter = Array<string | RegExp> | ((filename: string) => boolean);
interface PreloadOption {
type?: IncludeType;
include?: Filter;
exclude?: Filter;
}
```
- **默认值：** `undefined`
... | 6,951 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/performance/printFileSize.md | - **类型：** `boolean`
- **默认值：** `true`
是否在生产环境构建后输出所有静态资源文件的体积。
```bash
info Production file sizes:
File Size Gzipped
dist/static/js/lib-react.09721b5c.js 152.6 kB 49.0 kB
dist/html/main/index.html 5.8 kB 2.5 kB
dist/static/js/main... | 6,952 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/performance/profile.md | - **类型：** `boolean`
- **默认值：** `false`
是否捕获每个模块的耗时信息，对应 webpack / Rspack 的 [profile](https://webpack.js.org/configuration/other-options/#profile) 配置。
### 示例
```js
export default {
performance: {
profile: true,
},
};
```
开启后，Webpack / Rspack 生成一些有关模块的统计数据的 JSON 文件会将模块构建的耗时信息也包含进去。
| 6,953 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/performance/removeConsole.md | - **类型：** `boolean | ConsoleType[]`
- **默认值：** `false`
在生产环境构建时，是否自动移除代码中的 `console.xx`。
#### 移除所有 console
当 `removeConsole` 被设置为 `true` 时，会移除所有类型的 `console.xx`：
```ts
export default {
performance: {
removeConsole: true,
},
};
```
#### 移除特定的 console
你也可以指定仅移除特定类型的 `console.xx`，比如移除 `console.log` 和 `consol... | 6,954 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/performance/removeMomentLocale.md | - **类型：** `boolean`
- **默认值：** `false`
是否移除 [moment.js](https://momentjs.com/) 的语言包文件。
`moment.js` 默认包含了大量的语言包文件，会导致打包后的包体积增大。
当项目中使用了 `moment.js` 时，推荐开启此选项，自动排除所有的语言包文件：
```js
export default {
performance: {
removeMomentLocale: true,
},
};
```
开启后，可以通过以下方式来加载语言包文件：
```js
import moment from 'moment';
impo... | 6,955 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/performance/transformLodash.md | - **类型：** `boolean`
- **默认值：** `true`
- **打包工具：** `仅支持 webpack`
是否模块化 [lodash](https://www.npmjs.com/package/lodash) 的导入，删除未使用的 lodash 模块，从而减少 lodash 代码体积。
这项优化基于 [babel-plugin-lodash](https://www.npmjs.com/package/babel-plugin-lodash) 和 [swc-plugin-lodash](https://github.com/web-infra-dev/swc-plugins/tree/main/crate... | 6,956 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/security/checkSyntax.md | - **类型：**
```ts
type CheckSyntax =
| boolean
| {
targets?: string[];
exclude?: RegExp | RegExp[];
ecmaVersion?: EcmaVersion;
};
```
- **默认值：** `false`
用于分析构建产物中是否存在当前浏览器范围下不兼容的高级语法。如果存在，会将详细信息打印在终端。
### 启用检测
你可以将 `checkSyntax` 设置为 `true` 来启用语法检测。
```ts
export default {
security: {
... | 6,957 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/security/nonce.md | - **类型：**
```ts
type Nonce = string;
```
- **默认值：** `undefined`
为 HTML 所引入的脚本资源添加随机属性值 nonce，使浏览器在解析到带有匹配 nonce 值的内联脚本时，能判断该脚本是否能执行。
#### nonce 介绍
nonce 机制在 Content Security Policy（CSP，内容安全策略）中起到关键作用，用于提升网页安全性。其允许开发者在 CSP 中为内联 `<script>` 标签定义一个唯一且随机的字符串值，即 `nonce`。
浏览器在解析到带有匹配 `nonce` 值的内联脚本时，会允许其执行或应用，否则 CSP 将阻止... | 6,958 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/security/sri.md | - **类型：**
```ts
type SRIOptions =
| {
hashFuncNames?: string[];
enabled?: 'auto' | boolean;
hashLoading?: 'eager' | 'lazy';
}
| boolean;
```
- **默认值：** `undefined`
- **打包工具：** `仅支持 webpack`
为 HTML 所引入的子资源添加完整性属性 —— `integrity`，使浏览器能够验证引入资源的完整性，以此防止下载的资源被篡改。
启动该选项后会将 webpack 的 [output.cross... | 6,959 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/source/alias.md | - **类型：** `Record<string, string | string[]> | Function`
- **默认值：** `undefined`
设置文件引用的别名，对应 webpack 和 Rspack 的 [resolve.alias](https://webpack.js.org/configuration/resolve/#resolvealias) 配置。
:::tip
对于 TypeScript 项目，你只需要在 `tsconfig.json` 中配置 [compilerOptions.paths](https://www.typescriptlang.org/tsconfig#paths) 即可，Bu... | 6,960 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/source/aliasStrategy.md | - **类型：** `'prefer-tsconfig' | 'prefer-alias'`
- **默认值：** `'prefer-tsconfig'`
`source.aliasStrategy` 用于控制 `tsconfig.json` 中的 `paths` 选项与打包工具的 `alias` 选项的优先级。
### prefer-tsconfig
`source.aliasStrategy` 默认为 `'prefer-tsconfig'`，此时 `tsconfig.json` 中的 `paths` 选项和打包工具的 `alias` 选项都会生效，但 tsconfig paths 选项的优先级更高。
比如同时配置以下内容... | 6,961 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/source/compileJsDataURI.md | - **类型：** `boolean`
- **默认值：** `true`
该选项用于控制是否编译 data URI 中的 JavaScript 代码。
默认情况下，Builder 会使用 Babel 或 SWC 对 data URI 中的代码进行编译。比如以下代码：
```js
import x from 'data:text/javascript,export default 1;';
import 'data:text/javascript;charset=utf-8;base64,Y29uc29sZS5sb2coJ2lubGluZSAxJyk7';
```
### 示例
添加以下配置来关闭：
```js
exp... | 6,962 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/source/define.md | - **类型：** `Record<string, unknown>`
- **默认值：** `{}`
构建时将代码中的变量替换成其它值或者表达式，可以用于在代码逻辑中区分开发环境与生产环境等场景。
传入的配置对象的键名是需要替换变量的名称，或者是用 `.` 连接的多个标识符，配置项的值则根据类型进行不同的处理：
- 字符串会被当作代码片段。
- 包括函数在内的其他类型会被转换成字符串。
- 嵌套对象的父子键名之间会用 `.` 连接作为需要替换的变量名。
- 以 typeof 开头的键名会用来替换 typeof 调用。
更多细节参考 [webpack - DefinePlugin](https://webpack.js.or... | 6,963 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/source/exclude.md | - **类型：** `Array<string | RegExp>`
- **默认值：** `[]`
- **打包工具：** `仅支持 webpack`
指定不需要编译的 JavaScript/TypeScript 文件。用法与 webpack 中的 [Rule.exclude](https://webpack.js.org/configuration/module/#ruleexclude) 一致，支持传入字符串或正则表达式来匹配模块的路径。
:::tip
在使用 Rspack 作为打包工具时，默认**所有文件**都会经过编译，同时，不支持通过 `source.exclude` 排除。
:::
比如:
```js
imp... | 6,964 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/source/globalVars.md | - **类型：** `Record<string, JSONValue> | Function`
- **默认值：**
```ts
// Builder 默认会添加环境变量 `process.env.NODE_ENV`，因此你不需要手动添加它。
const defaultGlobalVars = {
'process.env.NODE_ENV': process.env.NODE_ENV,
};
```
用于在构建时将类似 `process.env.FOO` 的全局变量表达式替换为指定的值，比如：
```js
console.log(process.env.NODE_ENV);
// ⬇️ Turn into being... | 6,965 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/source/include.md | - **类型：** `Array<string | RegExp>`
- **默认值：** `[]`
- **打包工具：** `仅支持 webpack`
出于编译性能的考虑，默认情况下，Builder 不会编译 node_modules 下的 JavaScript/TypeScript 文件，也不会编译当前工程目录外部的 JavaScript/TypeScript 文件。
通过 `source.include` 配置项，可以指定需要 Builder 额外进行编译的目录或模块。`source.include` 的用法与 webpack 中的 [Rule.include](https://webpack.js.org/configu... | 6,966 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/source/moduleScopes.md | - **类型：** `Array<string | Regexp> | Function`
- **默认值：** `undefined`
- **打包工具：** `仅支持 webpack`
限制源代码的引用路径。配置该选项后，所有源文件只能从约定的目录下引用代码，从其他目录引用代码会产生对应的报错提示。
### 示例
首先我们配置 `moduleScopes` 仅包含 `src` 目录：
```js
export default {
source: {
moduleScopes: ['./src'],
},
};
```
然后在 `src/App.tsx` 中导入 `src` 目录外部的 `utils/a`... | 6,967 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/source/preEntry.md | - **类型：** `string | string[]`
- **默认值：** `undefined`
在每个页面的入口文件前添加一段代码，这段代码会早于页面的代码执行，因此可以用于执行一些全局的代码逻辑，比如注入 polyfill、设置全局样式等。
#### 添加单个脚本
首先创建一个 `src/polyfill.ts` 文件：
```js
console.log('I am a polyfill');
```
然后将 `src/polyfill.ts` 配置到 `source.preEntry` 上：
```js
export default {
source: {
preEntry: './src/p... | 6,968 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/source/resolveExtensionPrefix.md | - **类型：** `string | Record<BuilderTarget, string>`
- **默认值：** `undefined`
用于为 [resolve.extensions](https://webpack.js.org/configuration/resolve/#resolveextensions) 添加统一的前缀。
如果多个文件拥有相同的名称，但具有不同的文件后缀，Builder 会根据 extensions 数组的顺序进行识别，解析数组中第一个被识别的文件，并跳过其余文件。
### 示例
下面是配置 `.web` 前缀的例子。
```js
export default {
source: ... | 6,969 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/source/resolveMainFields.md | - **类型：**
```ts
type Fields = (string | string[])[];
type ResolveMainFields = Fields | Record<BuilderTarget, Fields>;
```
- **默认值：** `undefined`
该配置项将决定你使用 `package.json` 哪个字段导入 `npm` 模块。对应 webpack 的 [resolve.mainFields](https://webpack.js.org/configuration/resolve/#resolvemainfields) 配置。
### 示例
```js
export defa... | 6,970 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/source/transformImport.md | 用于按需引入组件库的代码和样式，能力等价于 [babel-plugin-import](https://www.npmjs.com/package/babel-plugin-import)。
它与 [babel-plugin-import](https://www.npmjs.com/package/babel-plugin-import) 的区别在于，`source.transformImport` 不与 Babel 耦合。Builder 会自动识别当前使用的编译工具是 Babel、SWC 还是 Rspack，并添加相应的按需引入配置。
- **类型：**
```ts
type Config =
| false
| ... | 6,971 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/tools/autoprefixer.md | - **类型：** `Object | Function`
- **默认值：**
```js
{
flexbox: 'no-2009',
// browserslist 取决于项目中的 browserslist 配置
// 以及 `output.overrideBrowserslist`(优先级更高) 配置
overrideBrowserslist: browserslist,
}
```
通过 `tools.autoprefixer` 可以修改 [autoprefixer](https://github.com/postcss/autoprefixer) 的配置。
### Object 类型
当 `tool... | 6,972 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/tools/babel.md | - **类型：** `Object | Function`
- **默认值：** `undefined`
通过 `tools.babel` 可以修改 [babel-loader](https://github.com/babel/babel-loader) 的配置项。
### 使用场景
请留意 `tools.babel` 在以下使用场景中的局限性：
- Rspack 场景：在使用 Rspack 作为打包工具时，使用 `tools.babel` 配置项将会明显拖慢 Rspack 构建速度。因为 Rspack 默认使用的是 SWC 编译，配置 Babel 会导致代码需要被编译两次，产生了额外的编译开销。
- webpack + ... | 6,973 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/tools/bundlerChain.mdx | - **类型：** `Function | undefined`
- **默认值：** `undefined`
你可以通过 `tools.bundlerChain` 来修改默认的 webpack 和 Rspack 配置，它的值为 `Function` 类型，接收两个参数：
- 第一个参数为 `bundler-chain` 对象实例，你可以通过这个实例来修改 webpack 和 Rspack 的配置。
- 第二个参数为一个工具集合，包括`env`、`isProd`、`CHAIN_ID` 等。
:::tip 什么是 BundlerChain
Bundler chain 是 webpack chain 的子集，其中包含一部分 we... | 6,974 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/tools/cssExtract.md | - **类型：** `Object | Function`
- **默认值：**
```js
const defaultOptions = {
// Loader 配置
loaderOptions: {},
// Plugin 配置
pluginOptions: {
// cssPath 默认为 static/css, cssFilename 默认为 [name].[contenthash:8].css
filename: `${cssPath}/${cssFilename}`,
chunkFilename: `${cssPath}/async/${cssFilename}`,
ig... | 6,975 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/tools/cssLoader.md | - **类型：** `Object | Function`
- **默认值：** `undefined`
通过 `tools.cssLoader` 可以修改 [css-loader](https://github.com/webpack-contrib/css-loader) 的配置项。默认配置如下:
```js
{
modules: {
auto: true,
exportLocalsConvention: 'camelCase',
localIdentName: config.output.cssModuleLocalIdentName,
// isServer 表示 node (SSR)... | 6,976 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/tools/devServer.md | - **类型：** `Object`
- **默认值：** `{}`
通过 `tools.devServer` 可以修改开发环境服务器的配置。
:::tip
Modern.js 中并没有直接使用 [webpack-dev-server](https://webpack.js.org/api/webpack-dev-server/) 或 [@rspack/dev-server](https://www.rspack.dev/guide/dev-server.html), 而是基于 [webpack-dev-middleware](https://github.com/webpack/webpack-dev-middleware) ... | 6,977 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/tools/htmlPlugin.md | - **类型：** `false | Object | Function`
- **默认值：**
```js
const defaultHtmlPluginOptions = {
inject, // 对应 html.inject 配置项
favicon, // 对应 html.favicon 配置项
filename, // 基于 output.distPath 和 entryName 生成
template, // 默认为内置的 HTML 模板路径
templateParameters, // 对应 html.templateParameters 配置项
chunks: [entryName],
m... | 6,978 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/tools/inspector.md | - **类型：** `Object | Function | undefined`
- **默认值：** `undefined`
- **打包工具：** `仅支持 webpack`
你可以通过 `tools.inspector` 开启或者配置 webpack 调试工具 [webpack inspector](https://github.com/web-infra-dev/webpack-inspector)。
当配置不为 `undefined` 时，则表示开启了 `webpack-inspector`，此时 `tools.inspector` 的类型可以为 `Object` 或者 `Function`。
### Object... | 6,979 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/tools/less.md | - **类型：** `Object | Function`
- **默认值：**
```js
const defaultOptions = {
lessOptions: {
javascriptEnabled: true,
},
// 默认在开发环境下启用 CSS 的 Source Map
sourceMap: isDev,
};
```
你可以通过 `tools.less` 修改 [less-loader](https://github.com/webpack-contrib/less-loader) 的配置。
### Object 类型
当 `tools.less` 的值为 `Object` 类型... | 6,980 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/tools/minifyCss.md | - **类型：** `Object | Function | undefined`
- **默认值：**
```js
const defaultOptions = {
minimizerOptions: {
preset: [
'default',
{
mergeLonghand: false,
},
],
},
};
```
在生产环境构建时，Builder 会通过 [css-minimizer-webpack-plugin](https://github.com/webpack-contrib/css-minimizer-webpack-plugin... | 6,981 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/tools/postcss.md | - **类型：** `Object | Function`
- **默认值：**
```js
const defaultOptions = {
postcssOptions: {
plugins: [
// 以下插件默认启用
require('postcss-nesting'),
require('postcss-media-minmax'),
require('postcss-flexbugs-fixes'),
require('autoprefixer')({
flexbox: 'no-2009',
}),
// 以... | 6,982 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/tools/pug.md | - **类型：** `true | Object | Function | undefined`
- **默认值：** `false`
配置 [Pug](https://pugjs.org/) 模板引擎。
### Boolean 类型
Builder 默认不启用 Pug 模板引擎，你可以将 `tools.pug` 设置为 `true` 来启用它。
```ts
export default {
tools: {
pug: true,
},
};
```
启用后，你可以在 `html.template` 中指定使用 `index.pug` 作为模板文件。
### Object 类型
当 `tools.ter... | 6,983 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/tools/rspack.md | - **类型：** `Object | Function | undefined`
- **默认值：** `undefined`
- **打包工具：** `仅支持 Rspack`
`tools.rspack` 选项用于配置原生的 [Rspack](https://www.rspack.dev/)。
### Object 类型
`tools.rspack` 可以配置为一个对象，这个对象将会和内置的 Rspack 配置通过 [webpack-merge](https://github.com/survivejs/webpack-merge) 进行深层合并。
比如添加 `resolve.alias` 配置：
```js
expo... | 6,984 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/tools/sass.md | - **类型：** `Object | Function`
- **默认值：**
```js
const defaultOptions = {
// 默认在开发环境下启用 CSS 的 Source Map
sourceMap: isDev,
};
```
你可以通过 `tools.sass` 修改 [sass-loader](https://github.com/webpack-contrib/sass-loader) 的配置。
### Object 类型
当 `tools.sass` 的值为 `Object` 类型时，会与默认配置通过 Object.assign 进行浅层合并，值得注意的是，`sassOptions... | 6,985 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/tools/styleLoader.md | - **类型：** `Object | Function`
- **默认值：** `{}`
通过 `tools.styleLoader` 可以设置 [style-loader](https://github.com/webpack-contrib/style-loader) 的配置项。
值得注意的是，Builder 默认不会开启 `style-loader`，你可以通过 `output.disableCssExtract` 配置项来开启它。
### Object 类型
当此值为 Object 类型时，与默认配置通过 Object.assign 合并。比如：
```js
export default {
tools: {... | 6,986 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/tools/styledComponents.md | - **类型：** `Object | Function | false`
- **默认值：**
```js
{
displayName: true,
// 在 SSR 构建中 isSSR 为 true
ssr: isSSR,
// 在生产环境构建时启用 `pure` 来优化包体积
pure: isProd,
transpileTemplateLiterals: true,
}
```
- **打包工具：** `仅支持 webpack`
对应 [babel-plugin-styled-components](https://github.com/styled-components/babel-plugi... | 6,987 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/tools/terser.md | - **类型：** `Object | Function | undefined`
- **默认值：**
```js
const defaultTerserOptions = {
terserOptions: {
mangle: {
safari10: true,
},
},
};
```
- **打包工具：** `仅支持 webpack`
在生产环境构建时，Builder 会通过 [terser-webpack-plugin](https://github.com/webpack-contrib/terser-webpack-plugin) 对 JavaScript 代码进行压缩优化。可以... | 6,988 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/tools/tsChecker.md | - **类型：** `Object | Function`
- **默认值：**
```js
const defaultOptions = {
typescript: {
// avoid OOM issue
memoryLimit: 8192,
// use tsconfig of user project
configFile: tsconfigPath,
// use typescript of user project
typescriptPath: require.resolve('typescript'),
},
issue: {
exclude: [... | 6,989 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/tools/tsLoader.md | - **类型：** `Object | Function | undefined`
- **默认值：** `undefined`
- **打包工具：** `仅支持 webpack`
项目中默认不开启 ts-loader，当 `tools.tsLoader` 不为 undefined 则表示开启 ts-loader，同时禁用 babel-loader 对 TypeScript 的编译。
### Object 类型
当此值为 Object 类型时，与默认配置通过 Object.assign 合并。
默认配置如下:
```json
{
"compilerOptions": {
"target": "es5",
... | 6,990 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/tools/webpack.md | - **类型：** `Object | Function | undefined`
- **默认值：** `undefined`
- **打包工具：** `仅支持 webpack`
`tools.webpack` 选项用于配置原生的 [webpack](https://webpack.js.org/)。
> `tools.bundlerChain` 同样可以修改 webpack 配置，并且功能更加强大，建议优先使用 `tools.bundlerChain`。
### Object 类型
`tools.webpack` 可以配置为一个对象，这个对象将会和内置的 webpack 配置通过 [webpack-merge](http... | 6,991 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/config/tools/webpackChain.md | - **类型：** `Function | undefined`
- **默认值：** `undefined`
- **打包工具：** `仅支持 webpack`
你可以通过 `tools.webpackChain` 来修改默认的 webpack 配置，它的值为 `Function` 类型，接收两个参数：
- 第一个参数为 `webpack-chain` 对象实例，你可以通过这个实例来修改默认的 webpack 配置。
- 第二个参数为一个工具集合，包括`env`、`isProd`、`CHAIN_ID` 等。
相比于 `tools.webpack`，**webpack-chain 不仅支持链式调用，而且能够基于别名来定位到内置... | 6,992 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/guide/features.mdx | # 功能导航
在这里，你可以了解到 Modern.js Builder 支持的主要功能。
## JavaScript 编译
| 功能 | 描述 | 相关链接 ... | 6,993 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/guide/glossary.mdx | # 名词解释
## Bundler
import Bundler from '@zh/shared/bundler.md';
<Bundler />
## Builder
import Builder from '@zh/shared/builder.md';
<Builder />
## Builder Provider
Builder Provider 是 Builder 的组成部分之一，Provider 基于特定 bundler 实现了对应的构建能力。
目前 Builder 提供了两个 Provider：
- `@modern-js/builder-webpack-provider`：底层基于 webpac... | 6,994 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/guide/introduction.mdx | # 介绍
Modern.js Builder 是**一个基于 Rspack 的 Web 构建工具**。
随着前端生态的发展，社区中出现了多样化的编译工具和插件。对于大部分开发者来说，构建一个 Web 应用所需的配置和依赖已变得十分复杂。在追求最佳实践的过程中，开发者需要付出的成本也在不断上升。
为了减少构建的复杂性，降低上手门槛，我们基于 Modern.js 在 Web 应用构建方面的实践经验，抽象其中的构建能力，打造出 Modern.js Builder 这个构建工具。
## Rust 化
近年来，前端工具链的发展趋势是使用 Rust 等编程语言重新实现 —— 以获得更好的性能表现。社区中出现 [Rspack](http... | 6,995 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/guide/quick-start.mdx | # 快速上手
## 环境准备
import NodeVersion from '@zh/shared/nodeVersion.md';
<NodeVersion />
## 使用 Modern.js 框架
**Modern.js 框架默认使用 Modern.js Builder 作为构建工具**。因此，如果你是一名业务开发者，那么不需要手动接入 Builder，只需要创建一个 Modern.js 项目，就可以使用 Builder 提供的所有能力。
```bash
npx @modern-js/create@latest my-app
```
请阅读 [Modern.js - 介绍](https://modernjs.d... | 6,996 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/guide | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/guide/advanced/alias.mdx | # 路径别名
import Alias from '@zh/shared/alias.md';
<Alias />
| 6,997 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/guide | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/guide/advanced/browser-compatibility.md | # 浏览器兼容性
本章节介绍如何使用 Builder 提供的能力来处理浏览器兼容性问题。
## 设置浏览器范围
在处理兼容性问题之前，首先需要明确你的项目需要支持的浏览器范围，并添加相应的 browserslist 配置。
- 如果你还没有设置浏览器范围，请先阅读 [设置浏览器范围](/guide/advanced/browserslist.html) 章节。
- 如果你已经设置了浏览器范围，那么 Builder 会自动根据该范围进行编译，对 JavaScript 语法和 CSS 语法进行降级处理，并注入所需的 polyfill 代码。大部分情况下，你可以放心地使用现代 ECMAScript 特性，无须担心兼容性问题。
... | 6,998 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/guide | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/guide/advanced/browserslist.md | # 设置浏览器范围
Builder 支持通过 [Browserslist](https://browsersl.ist/) 来设置 Web 应用需要兼容的浏览器范围。
## 什么是 Browserslist
由于各种浏览器对 ECMAScript 和 CSS 的支持程度不同，因此开发者需要根据业务需求，为 Web 应用设置正确的浏览器范围。
[Browserslist](https://browsersl.ist/) 可以指定 Web 应用能够在哪些浏览器中正常运行，它提供了统一的配置格式，并且已经成为了前端社区中的标准。Browserslist 被 Autoprefixer, Babel, ESLint, PostCSS，... | 6,999 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.