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/guide | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/docs/zh/guide/advanced/custom-webpack-config.md | # 修改 webpack 配置
Builder 支持直接修改 webpack 配置对象，也支持通过 webpack-chain 来深度定制 webpack 配置。
## 修改 webpack 配置对象
你可以使用 [tools.webpack](/api/config-tools.html#toolswebpack) 来修改 webpack 配置对象。
```ts
export default {
tools: {
webpack: (config, { env }) => {
if (env === 'development') {
config.devtool = 'cheap-m... | 7,000 |
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/define.md | # 环境变量
Builder 支持在编译过程中向代码中注入环境变量或表达式，这对于区分运行环境、注入常量值等场景很有帮助。本章节会介绍环境变量的使用方式。
## 默认环境变量
### process.env.NODE_ENV
默认情况下，Builder 会自动设置 `process.env.NODE_ENV` 环境变量，在开发模式为 `'development'`，生产模式为 `'production'`。
你可以在 Node.js 和运行时代码中直接使用 `process.env.NODE_ENV`。
```ts
if (process.env.NODE_ENV === 'development') {
conso... | 7,001 |
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/hmr.md | # 模块热更新
模块热更新（HMR - hot module replacement）功能会在应用程序运行过程中，替换、添加或删除模块，而无需重新加载整个页面。主要是通过以下几种方式，来显著加快开发速度：
- 保留在完全重新加载页面期间丢失的应用程序状态。
- 只更新变更内容，以节省宝贵的开发时间。
- 在源代码中 CSS/JS 产生修改时，会立刻在浏览器中进行更新，这几乎相当于在浏览器 devtools 直接更改样式。
## 启用 HMR
Builder 已内置了对 HMR 的支持，在开发环境下默认启用。
如果你不需要使用 HMR 能力，可以将 [dev.hmr](/api/config-dev.html#devhmr)... | 7,002 |
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/rem.md | # 开启 REM 适配
Builder 支持通过 [output.convertToRem](/api/config-output.html#outputconverttorem) 一键开启 REM 适配能力，能够根据屏幕大小来动态调整字体大小，让网页在不同大小的屏幕上都能够自适应显示。
## 开启 REM 的适配能力
开启 `convertToRem` 后，会对页面进行如下两个操作：
1. 将 CSS 属性中的 px 转成 rem。
2. 对根元素的字体大小进行动态设置。
```ts
export default {
output: {
convertToRem: true,
},
};
```
## ... | 7,003 |
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/rspack-start.mdx | # 使用 Rspack
这篇文档会向你介绍如何在 Builder 中开启 Rspack 构建模式。
import Rspack from '@zh/shared/rspackTip.mdx';
<Rspack />
## 启用 Rspack
### 在 Modern.js 框架中启用
Modern.js 框架默认使用 webpack 作为打包工具。如果希望启用 Rspack 作为打包工具，可参考：[使用 Rspack](https://modernjs.dev/guides/advanced-features/rspack-start.html)。
### 在前端框架中接入
如果你基于 Builder 开发了一个前端... | 7,004 |
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/source-build.md | # 源码构建模式
源码构建模式用于 monorepo 开发场景，它允许开发者直接引用 monorepo 中其他子项目的源码进行开发。
## 使用场景
**monorepo 中项目互相引用主要有产物引用和源码引用两种方式**。我们以一个最简单的 monorepo 为例子，来介绍源码引用的使用场景。
比如 monorepo 中包含了一个 app 应用和一个 lib 包：
```ts
monorepo
├── app
└── lib
└── src
└── index.ts
```
其中，app 是基于 Modern.js Builder 构建的，app 依赖了 lib 中的一些方法：
```json... | 7,005 |
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/storybook.md | # 使用 Storybook
[Storybook](https://storybook.js.org/) 是一个专门用于组件调试的工具，它围绕着组件开发提供了：
- 丰富多样的调试能力
- 可与一些测试工具结合使用
- 可重复使用的文档内容
- 可分享能力
- 工作流程自动化
在使用 Storybook 时，难免会遇到各种配置问题，需要手动配置 Babel 插件，手动配置 Webpack 去支持 less，sass 等。而 Modern.js builder 包含了许多强大的功能，使用 Modern.js builder 开发 Storybook 项目会极大的简化配置成本。
使用 Modern.js builder 还可以... | 7,006 |
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/basic/build-target.md | # 构建产物类型
Builder 支持多种构建产物类型，分别适用于不同的目标运行环境。在设置正确的产物类型后，Builder 会针对该环境优化打包结果，在构建过程中启用一些对应的插件或者配置。
你可以通过 [createBuilder](/api/builder-core.html#createbuilder) 方法的 `target` 参数来设置产物类型。
## 默认产物
默认情况下，`target` 会被设置为 `'web'`，并构建出**运行在浏览器环境里的产物**。
同时，Builder 会读取项目中的 [Browserslist 配置](https://github.com/browserslist/browse... | 7,007 |
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/basic/builder-cli.mdx | # 使用 Builder CLI
Modern.js Builder 提供了一个轻量的 CLI 工具，包含 dev、build 等基础命令，它主要用于构建非 React 项目。
- 对于 React 项目，我们建议直接使用 Modern.js 框架，参考 [Modern.js - 快速上手](https://modernjs.dev/guides/get-started/quick-start.html)。
- 对于非 React 项目，比如开发一个 Vue 项目，那么你可以使用 Builder CLI 工具来构建你的项目。
## 安装
你需要安装两个包，其中：
- `@modern-js/builder-cli`：Bui... | 7,008 |
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/basic/builder-config.mdx | # Builder 配置项
Builder 提供了丰富的配置项，以帮助使用者对构建行为进行定制。
## 配置分类
Builder 中的配置可以分为以下几类：
- [Dev Config](/api/config-dev.html)：与本地开发有关的配置。
- [Html Config](/api/config-html.html)：与 HTML 有关的配置。
- [Tools Config](/api/config-tools.html)：与底层工具有关的配置。
- [Source Config](/api/config-source.html)：与源代码解析、编译方式相关的配置。
- [Output Config](/ap... | 7,009 |
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/basic/css-modules.md | # 使用 CSS Modules
[CSS Modules](https://github.com/css-modules/css-modules) 让我们能以模块化的方式编写 CSS 代码，并且可以在 JavaScript 文件中导入和使用这些样式。使用 CSS Modules 可以自动生成唯一的类名，隔离不同模块之间的样式，避免类名冲突。
Builder 默认支持使用 CSS Modules，无需添加额外的配置。我们约定使用 `[name].module.css` 文件名来启用 CSS Modules。
以下样式文件会被视为 CSS Modules：
- `*.module.scss`
- `*.module.less`... | 7,010 |
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/basic/css-usage.md | # 引用样式资源
Builder 内置多种常用的样式资源处理方式，包括 Less / Sass 预处理器、PostCSS、CSS Modules、CSS 内联和 CSS 压缩。
除此之外，Builder 也提供了多个配置项来自定义样式资源的处理规则。
## 使用 Less、Sass 和 Stylus
Builder 内置了社区流行的 CSS 预处理器，包括 Less 和 Sass。
默认情况下，你不需要对 Less 和 Sass 进行任何配置。如果你有自定义 loader 配置的需求，可以通过配置 [tools.less](/api/config-tools.html#toolsless)、[tools.sass](/ap... | 7,011 |
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/basic/html-template.md | # 配置 HTML 模板
在构建的过程中，Builder 会基于 HTML 模板文件和模板参数进行编译，生成若干份 HTML 文件。
Builder 提供了一些配置项来对 HTML 模板进行设置。通过本章节你可以了解到这些配置项的基本用法。
## 设置模板文件
通常来说，HTML 模板文件是由上层框架预先定义的。
比如在 Modern.js 框架中，默认会预设一份 HTML 模板，同时也支持用户自定义模板的内容。你可以阅读 [「Modern.js - HTML 模板」](https://modernjs.dev/guides/basic-features/html.html) 章节来了解相关内容。
在 Builder 中... | 7,012 |
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/basic/json-files.md | # 引用 JSON 文件
Builder 支持在代码中引用 JSON 文件，也支持引用 [YAML](https://yaml.org/) 和 [TOML](https://toml.io/en/) 文件并将其转换为 JSON 格式。
## JSON 文件
你可以直接在 JavaScript 文件中引用 JSON 文件。
### 示例
```json title="example.json"
{
"name": "foo",
"items": [1, 2]
}
```
```js title="index.js"
import example from './example.json';
console.log... | 7,013 |
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/basic/output-files.md | # 构建产物目录
本章节主要介绍构建产物的目录结构，以及如何控制不同类型产物的输出目录。
## 默认产物目录
下面是最基础的产物目录结构，默认情况下，构建产物会生成在当前项目的 `dist` 目录下。
```bash
dist
├── static
│ ├── css
│ │ ├── [name].[hash].css
│ │ └── [name].[hash].css.map
│ │
│ └── js
│ ├── [name].[hash].js
│ ├── [name].[hash].js.LICENSE.txt
│ └── [name].[hash].js... | 7,014 |
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/basic/static-assets.md | # 引用静态资源
Builder 支持在代码中引用图片、字体、媒体类型的静态资源。
:::tip 什么是静态资源
静态资源是指 Web 应用中不会发生变化的文件。常见的静态资源包括图片、字体、视频、样式表和 JavaScript 文件。这些资源通常存储在服务器或 CDN 上，当用户访问 Web 应用时会被传送到用户的浏览器。由于它们不会发生变化，静态资源可以被浏览器缓存，从而提高 Web 应用的性能。
:::
## 静态资源格式
以下是 Builder 默认支持的静态资源格式：
- **图片**：png、jpg、jpeg、gif、svg、bmp、webp、ico、apng、avif、tiff。
- **字体**：woff、... | 7,015 |
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/basic/svg-assets.md | # 引用 SVG 资源
Builder 支持在代码中引用 SVG 资源，并将 SVG 图片转换为 React 组件或 URL。
:::tip 什么是 SVG
SVG 是 Scalable Vector Graphics 的缩写，意为可伸缩矢量图形。SVG 是一种用来描述二维矢量图形的 XML-based 格式，可以用来创建可以无限放大或缩小而不失真的图像。因为 SVG 图形是由矢量图形元素组成的，所以可以轻松地在各种尺寸和分辨率下渲染。
:::
## 在 JS 文件中引用
在 JS 文件中引用 SVG 资源时，如果你具名导入 `ReactComponent` 对象，Builder 会调用 [SVGR](https://rea... | 7,016 |
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/basic/typescript.md | # 使用 TypeScript
Builder 对 TypeScript 的转译和类型检查做了默认支持，无需任何配置即可在项目中使用 `.ts` 和 `.tsx` 文件。
## TypeScript 转译
Builder 有三种可选方式处理 TypeScript 文件。
**Babel**
在默认配置下，源码中所有的 TypeScript 文件会经过 Babel 转译。
可能你在查阅较老旧的资料时会发现，Babel 无法处理 `const enum` 以及 `namespace alias` 语法，但是其实在 [7.15](https://babeljs.io/blog/2021/07/26/7.15.0) 版本已经得到了... | 7,017 |
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/basic/wasm-assets.md | # 引用 Wasm 资源
Builder 支持在代码引用 WebAssembly 资源。
:::tip 什么是 WebAssembly
WebAssembly（缩写为 wasm）是一种可移植、高性能的字节码格式，被设计用来在现代 Web 浏览器中执行 CPU 密集型计算任务，为 Web 平台带来了接近本地编译代码的性能和可靠性。
:::
## 引用方式
你可以直接在 JavaScript 文件中引用一个 WebAssembly 模块：
```js title="index.js"
import { add } from './add.wasm';
console.log(add); // [native code]
co... | 7,018 |
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/debug/debug-mode.md | # 开启调试模式
为了便于排查问题，Builder 提供了调试模式，你可以在执行构建时添加 `DEBUG=builder` 环境变量来开启 Builder 的调试模式。
```bash
# 调试开发环境
DEBUG=builder pnpm dev
# 调试生产环境
DEBUG=builder pnpm build
```
在调试模式下，Builder 会输出一些额外的日志信息，并将内部最终生成的 Builder 配置和 webpack 配置写入到产物目录下，便于开发者查看和调试。
## 日志信息
在调试模式下，你会看到 Shell 中输出了一些额外的信息，其中以 `debug` 开头的是一些流程日志，表明 Builde... | 7,019 |
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/debug/inspector.md | # 使用 Webpack Inspector
Builder 内置了 [webpack inspector](https://github.com/web-infra-dev/webpack-inspector) 来辅助调试 webpack 构建问题。
## 介绍
由于 webpack 内部的工作流程比较黑盒，在使用 webpack 时，我们常常会遇到如下的一些问题:
- 在使用上层框架时，不知道最终生成的 webpack 配置包含哪些内容。
- 每个模块会经过不同的 loader 处理，经过各个 loader 的编译结果难以感知。
- 难以感知 webpack 各个编译环节 (比如 babel-loader、ts-load... | 7,020 |
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/faq/exceptions.md | # 异常类问题
### webpack 编译出现 'compilation' argument 报错？
如果编译时出现以下报错，通常是由于项目中安装了错误的 webpack 版本，或者安装了多个 webpack 版本引起：
```bash
TypeError: The 'compilation' argument must be an instance of Compilation
```
webpack 版本问题有以下几种情况：
1. 项目的 package.json 中直接声明了 webpack 依赖，并且与 Builder 依赖的 webpack 版本范围不同，无法匹配到同一个版本。
2. 项目里安装的多个 npm ... | 7,021 |
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/faq/features.md | # 功能类问题
### 如何配置组件库按需引入？
如果需要配置组件库的按需引入，你可以通过 [source.transformImport](/api/config-source.html#sourcetransformimport) 配置，这个配置的能力等价于 [babel-plugin-import](https://www.npmjs.com/package/babel-plugin-import)。
```ts
export default {
source: {
transformImport: [
{
libraryName: 'xxx-components',
... | 7,022 |
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/faq/general.md | # 通用类问题
### Modern.js Builder 和 Modern.js 的关系？
Modern.js 的构建能力是基于 Modern.js Builder 实现的。
在开发 Modern.js 的过程中，我们把 Builder 作为独立的模块进行设计，并明确划分 Builder 与 Modern.js 的职责界限。
因此，Builder 可以脱离 Modern.js 框架使用，被单独应用于其他框架或场景。
---
### Builder 能否用于构建工具库或组件库？
Builder 专注于解决 Web 应用构建场景，我们不推荐你使用 Builder 来构建工具库或组件库。
如果需要构建工具库或组件库，推荐使... | 7,023 |
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/faq/hmr.md | # 热更新问题
### 热更新不生效，如何排查？
热更新不生效有很多种可能的原因，在这篇文档中会介绍大部分常见的原因，你可以参照以下内容进行排查。
在开始排查之前，请简单了解一下热更新的原理：
:::tip 热更新原理
1. 浏览器和开发服务器建立一个 Web Socket 连接，用于实时通信。
2. 当开发服务器每次重新编译完成后，会通过 Web Socket 通知浏览器，浏览器向开发服务器发送 `hot-update.xxx` 请求，从而加载编译后的新模块。
3. 当浏览器收到新的模块后，如果是 React 项目，则会通过 React 官方的 React Refresh 来更新 React 组件，其他框架也是类似。
... | 7,024 |
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/framework/vue2.mdx | # 构建 Vue 2 应用
尽管 Modern.js 框架是基于 React 实现的，但底层的 Modern.js Builder 并不与 React 耦合。因此，你可以使用 Modern.js Builder 来构建你的 Vue 应用，并使用 Modern.js Builder 提供的绝大多数能力。
在这篇文档中，你可以了解到如何基于 Modern.js Builder 来构建一个 Vue 2 应用。
import Vue2Project from '@zh/shared/vue2Project.md';
<Vue2Project />
import CliToolVue from '@zh/shared/cliTool... | 7,025 |
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/framework/vue3.mdx | # 构建 Vue 3 应用
尽管 Modern.js 框架是基于 React 实现的，但底层的 Modern.js Builder 并不与 React 耦合。因此，你可以使用 Modern.js Builder 来构建你的 Vue 应用，并使用 Modern.js Builder 提供的绝大多数能力。
在这篇文档中，你可以了解到如何基于 Modern.js Builder 来构建一个 Vue 3 应用。
import Vue3Project from '@zh/shared/vue3Project.md';
<Vue3Project />
import CliToolVue from '@zh/shared/cliTool... | 7,026 |
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/optimization/build-performance.mdx | # 提升构建性能
Modern.js Builder 默认对构建性能进行了充分优化，但是随着业务场景变复杂、项目代码量变大，你可能会遇到一些构建性能的问题。
本文档提供了一些可选的提速策略，**开发者可以根据实际场景选取其中的部分策略**，从而进一步提升构建速度。
:::tip 📢 注意
在[优化产物体积](/guide/optimization/optimize-bundle.html)一文中介绍的策略也可以用于提升构建性能，这里不再重复介绍。
:::
## 通用优化策略
以下是一些通用的优化策略，对开发环境和生产环境均有提速效果，其中部分策略对包体积也有优化。
### 升级 Node.js 版本
通常来说，将 N... | 7,027 |
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/optimization/inline-assets.md | # 静态资源内联
静态资源内联是一种优化网页性能的方法，它指的是将静态资源直接内联到 HTML 或 JS 文件中，而不是使用外部文件引用的方式。这样做的好处是减少了浏览器发起的请求数，从而提高页面的加载速度。
不过，静态资源内联也有一些缺点，比如增加了单个文件的体积，可能会导致加载变慢。所以在实际应用中，需要根据具体情况来决定是否使用静态资源内联。
Builder 默认会自动内联体积小于 10KB 的静态资源，但有时候你可能需要手动控制某些特殊资源，让其强制内联或者强制不内联，这篇文档阐述了如何进行精确地控制静态资源内联行为。
## 自动内联
默认情况下，当图片、字体、媒体等类型的文件体积小于阈值（默认为 10KB）时，B... | 7,028 |
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/optimization/optimize-bundle.md | # 产物体积优化
产物体积的优化在生产环境中是非常重要的，因为它直接影响到了线上的用户体验。在这篇文档中，我们将介绍在 Builder 中一些常见的产物体积优化方式。
## 减少重复依赖
在业务项目中，会存在某些第三方依赖被安装了多个版本的现象。重复依赖会导致包体积变大、构建速度变慢。
我们可以通过社区中的一些工具来检测或消除重复依赖。
- 如果你在使用 `pnpm >= 7.26.0`，可以使用 pnpm 自带的 [pnpm dedupe](https://pnpm.io/cli/dedupe) 命令来升级和消除其中的重复依赖。
```bash
pnpm dedupe
```
- 如果你在使用 `pnpm < 7.2... | 7,029 |
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/optimization/split-chunk.md | # 拆包最佳实践
良好的拆包策略对于提升应用的加载性能是十分重要的，可以充分利用浏览器的缓存机制，减少请求数量，加快页面加载速度。
在 Builder 中内置了多种拆包策略，可以满足大部分应用的需求，你也可以根据自己的业务场景，自定义拆包配置。
## 拆包策略
> Builder 的拆包配置集中在 [performance.chunkSplit](/api/config-performance.html#performancechunksplit) 中。
Builder 支持设置以下几种拆包策略：
- `split-by-experience`: 根据经验制定的拆分策略，自动将一些常用的 npm 包拆分为体积适中的 ch... | 7,030 |
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/plugins/introduction.md | # 插件系统
Builder 提供了一套轻量强大的插件系统，用以实现自身的大多数功能，并允许用户进行扩展。
开发者编写的插件能够修改 Builder 的默认行为并添加各类额外功能，包括但不限于：
- 修改 bundler 配置
- 处理新的文件类型
- 修改或编译文件
- 部署产物
Builder 底层支持 webpack 和 Rspack 等 bundler，并提供统一的 Node.js API 来抹平插件开发的差异，进而接入不同的上层框架、降低用户对底层 bundler 切换的感知。
## 开发插件
插件提供类似 `(options?: PluginOptions) => BuilderPlugin` 的函数作为入口，... | 7,031 |
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/plugins/list.md | # 总览
## 官方插件
- [@modern-js/builder-plugin-vue](/plugins/plugin-vue.html)：用于构建 Vue 3 应用。
- [@modern-js/builder-plugin-vue2](/plugins/plugin-vue2.html)：用于构建 Vue 2 应用。
- [@modern-js/builder-plugin-swc](/plugins/plugin-swc.html)：使用 SWC 进行代码编译和压缩以提升构建性能。
- [@modern-js/builder-plugin-stylus](/plugins/plugin-stylus.html)：使用... | 7,032 |
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/plugins/plugin-esbuild.mdx | # Esbuild 插件
import Esbuild from '@zh/shared/esbuild.md';
<Esbuild />
:::tip 推荐使用 SWC
相较于 esbuild，我们更推荐使用 SWC 来编译和压缩代码，因为 SWC 支持更多的语法特性、提供更好的代码压缩能力，并且产物具备更好的兼容性。
因此，我们建议你使用 SWC 而不是 esbuild，用法请参考 [SWC 插件](/plugins/plugin-swc)。
:::
## 快速开始
### 在 Modern.js 框架中使用
Modern.js 框架默认集成了 Builder 的 esbuild 插件，因此，你不需要手动安装和注... | 7,033 |
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/plugins/plugin-image-compress.mdx | # Image Compress 插件
Image Compress 插件会将项目中用到的图片资源进行压缩处理，进而在图片视觉观感不受影响的同时减小产物体积。
## 快速开始
### 安装插件
你可以通过如下的命令安装插件:
import { PackageManagerTabs } from '@theme';
<PackageManagerTabs command="add @modern-js/builder-plugin-image-compress -D" />
### 注册插件
在 Modern.js 等上层框架中，你可以通过 `builderPlugins` 配置项来注册 Image Compress ... | 7,034 |
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/plugins/plugin-node-polyfill.mdx | # Node Polyfill 插件
:::tip Node Polyfill 介绍
通常情况下，我们不会在浏览器端使用 Node 模块。但在当前代码需要同时在 Node 端和浏览器端运行时，用到一些 Node 模块是有可能的。Node Polyfill 为这些 Node 模块提供了浏览器版本的 polyfills。
:::
通过使用 Node Polyfill 插件，会自动注入 Node 核心模块在浏览器端的 polyfills，让你可以在浏览器端放心使用这些模块。
## 快速开始
### 在 Modern.js 框架中使用
Modern.js 框架默认集成了 Builder 的 Node Polyfill 插件，因此，... | 7,035 |
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/plugins/plugin-stylus.mdx | # Stylus 插件
Stylus 是一个富于表现力、动态的、健壮的 CSS 预处理器，本章节介绍如何在 Builder 中使用 Stylus。
## 快速开始
### 安装插件
你可以通过如下的命令安装插件:
import { PackageManagerTabs } from '@theme';
<PackageManagerTabs command="add @modern-js/builder-plugin-stylus -D" />
### 注册插件
在 Modern.js 等上层框架中，你可以通过 `builderPlugins` 配置项来注册 Stylus 插件：
```ts
import { bu... | 7,036 |
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/plugins/plugin-swc.mdx | # SWC 插件
import SWC from '@zh/shared/swc.md';
<SWC />
## 适用场景
在使用 SWC 插件之前，请先了解一下 SWC 插件的适用场景和局限性，以明确你的项目是否需要使用 SWC 插件。
### Rspack 场景
如果你的项目中已经使用了 Rspack 作为打包工具，那么你不需要接入 SWC 插件，因为 Rspack 默认会使用 SWC 进行转译和压缩，各个 SWC 编译能力可以开箱即用。
如果你使用 Rspack 时配置了当前的 SWC 插件，它将不会产生任何效果。
### Babel 插件
如果你的项目需要注册一些自定义的 Babel 插件，由于 SWC 替... | 7,037 |
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/plugins/plugin-vue.mdx | # Vue 插件
Vue 插件提供了对 Vue 3 应用构建的支持，插件内部集成了 [vue-loader](https://vue-loader.vuejs.org/) 和 [@vue/babel-plugin-jsx](https://github.com/vuejs/babel-plugin-jsx)。
## 快速开始
### 安装插件
你可以通过如下的命令安装插件:
import { PackageManagerTabs } from '@theme';
<PackageManagerTabs command="add @modern-js/builder-plugin-vue -D" />
### 注册插件
... | 7,038 |
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/plugins/plugin-vue2.mdx | # Vue 2 插件
Vue 2 插件提供了对 Vue 2 应用构建的支持，插件内部集成了 [vue-loader](https://vue-loader.vuejs.org/) 和 [@vue/babel-preset-jsx](https://github.com/vuejs/jsx-vue2)。
## 快速开始
### 安装插件
你可以通过如下的命令安装插件:
import { PackageManagerTabs } from '@theme';
<PackageManagerTabs command="add @modern-js/builder-plugin-vue2 -D" />
### 注册插件
你可... | 7,039 |
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/shared/alias.md | 路径别名（alias）允许开发者为模块定义别名，以便于在代码中更方便的引用它们。当你想要使用一个简短、易于记忆的名称来代替冗长复杂的路径时，这将非常有用。
例如，假如你在项目中经常引用 `src/common/request.ts` 模块，你可以为它定义一个别名 `@request`，然后在代码中通过 `import request from '@request'` 来引用它，而不需要每次都写出完整的相对路径。同时，这也允许你将模块移动到不同的位置，而不需要更新代码中的所有 import 语法。
在 Modern.js Builder 中，你有两种方式可以设置路径别名:
- 通过 `tsconfig.json` 中的 `pat... | 7,040 |
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/shared/builder.md | Modern.js Builder 指的是 Modern.js 的构建工具，它的目标是「复用构建工具的最佳实践」。
因为 webpack 等打包工具是比较底层的，如果我们基于 webpack 来构建一个项目，需要充分理解 webpack 的各个配置项和三方插件，并进行繁琐的配置组合和调试工作。
而 Builder 比 Bundler 的封装程度更高，并默认集成代码转换、代码压缩等能力。通过接入 Builder，你可以快速获得构建 Web 应用的能力。
Modern.js Builder 内部的分层如下：
、[Rspack](https://www.rspack.dev/) 等模块打包工具。
打包工具的主要目标是将 JavaScript、CSS 等文件打包在一起，打包后的文件可以在浏览器、Node.js 等环境中使用。当 Bundler 处理 Web 应用时，它会构建一个依赖关系图，其中包含应用需要的各个模块，然后将所有模块打包成一个或多个 bundle。
| 7,042 |
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/shared/bundlerChain.md | Bundler chain 是 webpack chain 的子集，其中包含一部分 webpack chain API，你可以用它来同时修改 webpack 和 Rspack 的配置。
通过 bundler chain 修改的配置，在 webpack 和 Rspack 构建时均可生效。需要注意的是，bundler chain 只支持修改 webpack 和 Rspack 间无差异部分的配置。如，修改 devtool 配置项(webpack 和 Rspack 的 devtool 属性值类型相同)，或添加一个[Rspack 兼容](https://www.rspack.dev/zh/guide/plugin-compat.html)的... | 7,043 |
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/shared/cliToolVue.md | ## CLI 工具
在开始构建 Vue 项目之前，你需要一个 CLI 工具来提供基本的命令。
你可以直接使用 Builder 提供的 [CLI 工具](/guide/basic/builder-cli)，也可以基于 Builder 的 [Node API](/api/builder-core) 搭建属于你自己的 CLI 工具。
| 7,044 |
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/shared/deployApp.md | ## 部署应用
当你执行 `builder build` 构建应用后，你会在 `dist` 目录下得到一份静态资源产物，这份产物可以被部署到任意平台或服务器上。
请留意 Builder 默认的产物结构并不适用于所有的平台，因为不同的平台对产物目录结构有不同的要求。你可以参考 [构建产物目录](/guide/basic/output-files) 章节对目录结构进行修改，以满足部署平台的要求。
此外，如果你需要在本地预览待部署的产物，可以使用 Builder CLI 提供的 [builder serve](/guide/basic/builder-cli#builder-serve) 命令。
| 7,045 |
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/shared/enableSwc.md | 首先，你需要执行 `pnpm run new` 启用 SWC 编译：
```bash
? 请选择你想要的操作 启用可选功能
? 请选择功能名称 启用「SWC 编译」
```
执行完成后，你只需在 `modern.config.ts` 文件中注册 Modern.js 的 SWC 插件，即可启用 SWC 编译和压缩能力。
```ts title="modern.config.ts"
import { appTools, defineConfig } from '@modern-js/app-tools';
import { swcPlugin } from '@modern-js/plugin-swc';
export defa... | 7,046 |
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/shared/esbuild.md | [esbuild](https://esbuild.github.io/) 是一款基于 Golang 开发的前端构建工具，具有打包、编译和压缩 JavaScript 代码的功能，相比传统的打包编译工具，esbuild 在性能上有显著提升。在代码压缩方面，相比 webpack 内置的 terser 压缩器，esbuild 在性能上有数十倍的提升。
Modern.js Builder 提供了 esbuild 插件，让你能使用 esbuild 代替 babel-loader、ts-loader 和 terser 等库进行代码编译和压缩。在大型工程中启用 esbuild 后，**可以大幅度减少代码编译和压缩所需的时间，同时有效避免 OOM... | 7,047 |
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/shared/getBuilderConfig.md | 获取 Builder 配置，该方法必须在 `modifyBuilderConfig` 钩子执行完成后才能被调用。
- **类型**
```ts
function GetBuilderConfig(): Readonly<BuilderConfig>;
```
| 7,048 |
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/shared/getHTMLPaths.md | 获取所有 HTML 产物的路径信息。
该方法会返回一个对象，对象的 key 为 entry 名称，value 为 HTML 文件在产物目录下的相对路径。
- **类型**
```ts
function GetHTMLPaths(): Record<string, string>;
```
| 7,049 |
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/shared/getNormalizedConfig.md | 获取归一化后的 Builder 配置，该方法必须在 `modifyBuilderConfig` 钩子执行完成后才能被调用。
相较于 `getBuilderConfig` 方法，该方法返回的配置经过了归一化处理，配置的类型定义会得到收敛，比如 `config.html` 的 `undefined` 类型将被移除。
推荐优先使用该方法获取配置。
- **类型**
```ts
function GetNormalizedConfig(): Readonly<NormalizedConfig>;
```
| 7,050 |
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/shared/isPluginExists.md | 判断某个插件是否已经被注册。
- **类型**
```ts
function IsPluginExists(pluginName: string): boolean;
```
| 7,051 |
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/shared/micro-frontend.md | 微前端（Micro-frontend，简称 MFE）是一种类似于微服务的架构，是一种由独立交付的多个前端应用组成整体的架构风格，它将前端应用分解成一些更小、更简单的能够独立开发、测试、部署的应用，而在用户看来仍然是内聚的单个产品。
它主要解决了两个问题：
- 随着项目迭代应用越来越庞大，难以维护。
- 跨团队或跨部门协作开发项目导致效率低下的问题。
| 7,052 |
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/shared/module-federation.md | 模块联邦（Module Federation，简称 MF）是 Webpack 的一个特性。它允许 JavaScript 应用从另一个应用动态加载代码，并在此过程中共享依赖关系。如果使用联邦模块的应用缺少联邦代码所需的依赖项，Webpack 将从该联邦的构建源下载缺失的依赖项。
这使得可以创建微前端风格的应用程序，多个系统可以共享代码，并在不需要重新构建整个应用程序的情况下进行动态更新。
Modern.js 提供了一个 Module Federation 的示例项目，请参考 [module-federation-examples - modernjs](https://github.com/module-federation/mo... | 7,053 |
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/shared/nodeVersion.md | 在开始使用前，你需要安装 [Node.js](https://nodejs.org/)，并保证 Node.js 版本不低于 14.17.6，**我们推荐使用 Node.js 18 的 LTS 版本**。
你可以通过以下命令检查当前使用的 Node.js 版本：
```bash
node -v
```
如果你当前的环境中尚未安装 Node.js，或是安装的版本低于 14.17.6，可以通过 [nvm](https://github.com/nvm-sh/nvm) 或 [fnm](https://github.com/Schniz/fnm) 安装需要的版本。
下面是通过 nvm 安装 Node.js 18 LTS 版本的例子：
... | 7,054 |
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/shared/onAfterBuild.md | `onAfterBuild` 是在执行生产环境构建后触发的回调函数，你可以通过 `stats` 参数获取到构建结果信息：
- 如果当前打包工具为 webpack，则获取到的是 webpack Stats。
- 如果当前打包工具为 Rspack，则获取到的是 Rspack Stats。
- **类型**
```ts
function OnAfterBuild(
callback: (params: { stats?: Stats | MultiStats }) => Promise<void> | void,
): void;
```
| 7,055 |
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/shared/onAfterCreateCompiler.md | `onAfterCreateCompiler` 是在创建 Compiler 实例后、执行构建前触发的回调函数，当你执行 `builder.startDevServer`、`builder.build` 或 `builder.createCompiler` 时，都会调用此钩子。
你可以通过 `compiler` 参数获取到 Compiler 实例对象:
- 如果当前打包工具为 webpack，则获取到的是 webpack Compiler 对象。
- 如果当前打包工具为 Rspack，则获取到的是 Rspack Compiler 对象。
- **类型**
```ts
function OnAfterCreateCompiler... | 7,056 |
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/shared/onAfterStartDevServer.md | 在启动开发服务器后调用，你可以通过 `port` 参数获得开发服务器监听的端口号。
- **类型**
```ts
function OnAfterStartDevServer(
callback: (params: { port: number }) => Promise<void> | void,
): void;
```
| 7,057 |
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/shared/onBeforeBuild.md | `onBeforeBuild` 是在执行生产环境构建前触发的回调函数，你可以通过 `bundlerConfigs` 参数获取到底层打包工具的最终配置数组：
- 如果当前打包工具为 webpack，则获取到的是 webpack 配置数组。
- 如果当前打包工具为 Rspack，则获取到的是 Rspack 配置数组。
- 配置数组中可能包含一份或多份配置，这取决于 Builder 当前 target 配置的值。
- **类型**
```ts
function OnBeforeBuild(
callback: (params: {
bundlerConfigs?: WebpackConfig[] | RspackConf... | 7,058 |
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/shared/onBeforeCreateCompiler.md | `onBeforeCreateCompiler` 是在创建底层 Compiler 实例前触发的回调函数，当你执行 `builder.startDevServer`、`builder.build` 或 `builder.createCompiler` 时，都会调用此钩子。
你可以通过 `bundlerConfigs` 参数获取到底层打包工具的最终配置数组：
- 如果当前打包工具为 webpack，则获取到的是 webpack 配置数组。
- 如果当前打包工具为 Rspack，则获取到的是 Rspack 配置数组。
- 配置数组中可能包含一份或多份配置，这取决于你是否开启了 SSR 等功能。
你可以通过 `bundlerConfi... | 7,059 |
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/shared/onBeforeStartDevServer.md | 在启动开发服务器前调用。
- **类型**
```ts
function OnBeforeStartDevServer(callback: () => Promise<void> | void): void;
```
| 7,060 |
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/shared/onDevCompileDone.md | 在每次开发环境构建结束后调用，你可以通过 `isFirstCompile` 来判断是否为首次构建。
- **类型**
```ts
function OnDevCompileDone(
callback: (params: { isFirstCompile: boolean }) => Promise<void> | void,
): void;
```
| 7,061 |
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/shared/onExit.md | 在进程即将退出时调用，这个钩子只能执行同步代码。
- **类型**
```ts
function OnExit(callback: () => void): void;
```
| 7,062 |
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/shared/rspack.md | [Rspack](https://www.rspack.dev/) 是一个基于 Rust 的高性能 Web 构建工具，具备与 webpack 生态系统的互操作性，可以被 webpack 项目低成本集成，并提供更好的构建性能。
相较于 webpack，Rspack 的构建性能有明显提升，除了 Rust 带来的语言优势，这也来自于它的并行架构和增量编译等特性。经过 benchmark 验证，Rspack 可以带来 5 ～ 10 倍编译性能的提升。
| 7,063 |
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/shared/rspackPrecautions.md | ## 注意事项
在使用 Rspack 之前，请留意 Rspack 仍然是一个早期项目，当前还处于快速迭代阶段。因此，你需要预先了解以下事项：
- Rspack 的 API 和配置项还不稳定，同时 Modern.js 对 Rspack 的支持属于实验性的，因此在后续的非 major 版本中，可能会引入不兼容更新。
- Rspack 并未实现完整的 webpack 优化能力（如 tree shaking、bundle splitting、scope hoist 等能力，我们将在 6 ～ 12 月持续补齐相关优化能力），迁移到 Rspack 后，你可能会发现产物的包体积相较 webpack 有一定程度的增加。
- Rspack 目前基... | 7,064 |
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/shared/rspackTip.mdx | :::tip 什么是 Rspack
import Rspack from './rspack.md';
<Rspack />
:::
| 7,065 |
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/shared/swc.md | [SWC](https://swc.rs/) (Speedy Web Compiler) 是基于 `Rust` 语言编写的高性能 JavaScript 和 TypeScript 转译和压缩工具。在 Polyfill 和语法降级方面可以和 Babel 提供一致的能力，并且性能比 Babel 高出一个数量级。
Modern.js Builder 提供了开箱即用的 SWC 插件，可以为你的 Web 应用提供语法降级、Polyfill 以及压缩，并且移植了一些额外常见的 Babel 插件。
| 7,066 |
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/shared/vue2Project.md | ## 示例项目
我们搭建了一个基于 Modern.js Builder 的 Vue 2 示例项目，你可以参考或直接克隆这个项目，并对照下文的指南来了解更多细节。
- [modern-js-examples - builder-vue2](https://github.com/web-infra-dev/modern-js-examples/tree/main/examples/builder-vue2)
- [modern-js-examples - builder-vue2-rspack](https://github.com/web-infra-dev/modern-js-examples/tree/main/example... | 7,067 |
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/shared/vue3Project.md | ## 示例项目
我们搭建了一个基于 Modern.js Builder 的 Vue 3 示例项目，你可以参考或直接克隆这个项目，并对照下文的指南来了解更多细节。
- [modern-js-examples - builder-vue3](https://github.com/web-infra-dev/modern-js-examples/tree/main/examples/builder-vue3)
- [modern-js-examples - builder-vue3-rspack](https://github.com/web-infra-dev/modern-js-examples/tree/main/example... | 7,068 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/src/global.d.ts | declare module '*.module.scss' {
const classes: { readonly [key: string]: string };
export default classes;
}
| 7,069 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/src/utils.ts | import { useLang, withBase } from 'rspress/runtime';
export function useUrl(url: string) {
const lang = useLang();
return withBase(lang === 'zh' ? url : `/en${url}`);
}
| 7,070 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/src | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/src/components/NextSteps.module.scss | .next-steps {
display: flex;
flex-wrap: wrap;
justify-content: space-between;
margin-top: 3rem;
}
| 7,071 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/src | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/src/components/NextSteps.tsx | import styles from './NextSteps.module.scss';
const NextSteps = (props: { children?: React.ReactNode }) => {
return <div className={styles.nextSteps}>{props.children}</div>;
};
export default NextSteps;
| 7,072 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/src | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/src/components/Step.module.scss | .step {
border: 1px solid var(--rp-c-bg-soft);
background-color: var(--rp-c-bg-soft);
transition: color 0.5s, background-color 0.5s;
padding: 28px 36px;
border-radius: 8px;
flex: 0 32%;
font-size: 14px;
font-weight: 500;
&:hover {
border-color: var(--rp-c-brand);
transition: border-color 0.3s... | 7,073 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/src | petrpan-code/web-infra-dev/modern.js/packages/document/builder-doc/src/components/Step.tsx | import { useUrl } from '../utils';
import styles from './Step.module.scss';
const Step = (props: { href: string; title: string; description: string }) => {
return (
<a className={styles.step} href={useUrl(props.href)}>
<p className={styles.title}>{props.title}</p>
<p className={styles.description}>{p... | 7,074 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/.eslintrc.js | module.exports = {
root: true,
extends: ['@modern-js'],
ignorePatterns: ['rspress.config.ts'],
parserOptions: {
tsconfigRootDir: __dirname,
project: ['./tsconfig.json'],
},
rules: {
'babel/no-unused-expressions': 0,
'react/jsx-filename-extension': 0,
},
};
| 7,075 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/.npmignore | .DS_Store
.pnp
.pnp.js
.env.local
.env.*.local
*.log*
node_modules/
*.tsbuildinfo
.eslintcache
coverage/
tests/
.vscode/**/*
!.vscode/settings.json
!.vscode/extensions.json
.idea/
jest.config.js
.eslintrc.js
.eslintrc
tsconfig.json
CHANGELOG.md
.nx-cache/
scripts/
doc_build
| 7,076 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/CHANGELOG.md | # @modern-js/main-doc
## 2.41.0
### Patch Changes
- Updated dependencies [c4d396a]
- Updated dependencies [3164aad]
- @modern-js/sandpack-react@2.41.0
- @modern-js/builder-doc@2.41.0
## 2.40.0
### Minor Changes
- 95f15d2: chore: remove ajv schema verification of configuration
chore: 移除 ajv 对项目配置的校验
### Pat... | 7,077 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/LICENSE | MIT License
Copyright (c) 2021-present Modern.js
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish,... | 7,078 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/README.md | # Modern.js Website
### Installation
```
pnpm i
```
### Local Development
```
$ pnpm run dev
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
```
$ pnpm run build
```
This command generates static co... | 7,079 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/package.json | {
"name": "@modern-js/main-doc",
"description": "Documentation of modern.js framework",
"homepage": "https://modernjs.dev",
"bugs": "https://github.com/web-infra-dev/modern.js/issues",
"repository": {
"type": "git",
"url": "https://github.com/web-infra-dev/modern.js",
"directory": "packages/docume... | 7,080 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/rspress.config.ts | import path from 'path';
import { defineConfig } from 'rspress/config';
import { NavItem } from '@rspress/shared';
import { pluginAutoSidebar } from '@modern-js/doc-plugin-auto-sidebar';
const rootCategories = [
'tutorials',
'guides',
'apis/app',
'configure/app',
'community',
];
const { version } = require(... | 7,081 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/tsconfig.json | {
"extends": "@modern-js/tsconfig/base",
"compilerOptions": {
"jsx": "preserve"
},
"include": [
"./src",
"./navbar.js",
"./sidebar.js",
"./scripts",
"./modern.config.ts"
]
}
| 7,082 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/index.md | ---
pageType: home
---
# Modern.js - A Progressive React Framework for modern web development
| 7,083 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/commands.mdx | ---
sidebar_position: 1
---
# Commands
Modern.js has some built-in commands that can help you quickly start a development server, build production environment code, and more.
Through this chapter, you can learn about the built-in commands of Modern.js and how to use them.
## modern dev
The `modern dev` command is ... | 7,084 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks/_category_.json | {
"label": "Convention",
"position": 2,
"collapsed": false
}
| 7,085 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks/modern-config.mdx | ---
title: modern.config.[tj]s
sidebar_position: 8
---
# modern.config.[tj]s
The Modern.js configuration file. Through this file, you can personalize the configuration of various aspects of the current project.
To learn more about how to use the configuration, please refer to [Configuration Usage](/configure/app/usag... | 7,086 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks/shared.mdx | ---
title: shared/
sidebar_position: 5
---
# shared/
Shared source code directory. When there is common code in `api/`, `server/`, and `src/` in the project, you can put these codes in the `shared` directory instead of directly referencing them.
| 7,087 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks/api/_category_.json | {
"label": "api/",
"position": 2
}
| 7,088 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks/api/api.mdx | ---
title: '**/*.[tj]s'
sidebar_position: 1
---
# **/*.[tj]s
Files that declare API routes in the [BFF Function Mode](/guides/advanced-features/bff/type.html#function-mode). Except for some [convention files](/apis/app/hooks/api/api#allow-list), files in the `api` directory will be registered as the routes.
:::info
U... | 7,089 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks/api/app.mdx | ---
title: _app.[tj]s
sidebar_position: 2
---
# _app.[tj]s
In the [BFF Function Mode](/guides/advanced-features/bff/type.html#function-mode), this file can add pre-middleware for BFF functions.
:::note
For specific examples, please refer to [hook](/apis/app/runtime/bff/hook).
:::
| 7,090 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks/api/lambda.mdx | ---
title: lambda/*.[tj]s
sidebar_position: 3
---
# lambda/*.[tj]s
Files that declare API routes under the [BFF Framework Mode](/guides/advanced-features/bff/type.html#framework-mode). Except for [convention files](/apis/app/hooks/api/api#allow-list), files under the `lambda/` directory will be registered as the route... | 7,091 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks/api/test.mdx | ---
title: test.[tj]s
sidebar_position: 4
---
# test.[tj]s
App's BFF test file, support for writing test cases in the `api/` directory which file with suffix `.test.[tj]s`.
:::info
To use unit test and integration test, you need to execute the `new` command in advance to enable the `unit test/integration test`.
:::... | 7,092 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks/config/_category_.json | {
"label": "config/",
"position": 6
}
| 7,093 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks/config/html.mdx | ---
title: html/
sidebar_position: 1
---
# html/
You can inject custom HTML fragments at different locations of the default internal HTML template through the `config/html` directory.
For specific usage, please refer to: [Custom HTML](/guides/basic-features/html).
| 7,094 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks/config/icon.mdx | ---
title: icon/
sidebar_position: 2
---
# icon/
## Favicon
When there is a `favicon.*` file in the `config` directory at the root of the project, Modern.js will automatically set the file to the [html.favicon](/configure/app/html/favicon) configuration option for generating the favicon icon on the page:
```
./conf... | 7,095 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks/config/mock.mdx | ---
title: mock/
sidebar_position: 5
---
# mock/
When there is a `config/mock/index.js` file in the project directory, Modern.js will automatically enable the Mock service during development.
| 7,096 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks/config/public.mdx | ---
title: public/
sidebar_position: 3
---
# public/
Any static assets can be placed in the `public/` directory, and the files will be deployed to the corresponding application domain by the server.
## Description
The file routing is based on the convention of the directory structure, where `public/` is the root dir... | 7,097 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks/config/storybook.mdx | ---
title: storybook/
sidebar_position: 7
---
# storybook/
Modern.js supports debugging using Storybook. When configuring Storybook, you need to configure it in the `config/storybook` directory of the project.
Please refer to [Storybook Configuration](https://storybook.js.org/docs/react/configure/overview) for Story... | 7,098 |
0 | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks | petrpan-code/web-infra-dev/modern.js/packages/document/main-doc/docs/en/apis/app/hooks/config/upload.mdx | ---
title: upload/
sidebar_position: 4
---
# upload/
Any static assets can be placed in the `upload/` directory.
## Description
In the development environment, the static assets in this directory will be hosted under the `/upload` path. After building the application, the files in this directory will be copied to th... | 7,099 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.