@modern-js/main-doc 2.58.1 → 2.58.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (72) hide show
  1. package/docs/en/apis/app/hooks/config/icon.mdx +1 -1
  2. package/docs/en/apis/app/runtime/web-server/unstable_middleware.mdx +2 -2
  3. package/docs/en/community/blog/_meta.json +1 -6
  4. package/docs/en/components/deploy.mdx +1 -1
  5. package/docs/en/configure/_meta.json +1 -1
  6. package/docs/en/configure/app/tools/esbuild.mdx +1 -1
  7. package/docs/en/configure/app/tools/swc.mdx +2 -2
  8. package/docs/en/guides/_meta.json +5 -0
  9. package/docs/en/guides/advanced-features/bff/_meta.json +1 -6
  10. package/docs/en/guides/advanced-features/rspack-start.mdx +1 -8
  11. package/docs/en/guides/advanced-features/ssr/_meta.json +1 -5
  12. package/docs/en/guides/basic-features/data/_meta.json +1 -4
  13. package/docs/en/guides/basic-features/data/data-fetch.mdx +1 -1
  14. package/docs/en/guides/basic-features/routes.mdx +1 -1
  15. package/docs/en/guides/concept/_meta.json +1 -4
  16. package/docs/en/guides/concept/entries.mdx +70 -46
  17. package/docs/en/guides/get-started/_meta.json +1 -7
  18. package/docs/en/guides/get-started/introduction.mdx +1 -1
  19. package/docs/en/guides/get-started/quick-start.mdx +0 -1
  20. package/docs/en/guides/get-started/tech-stack.mdx +0 -2
  21. package/docs/en/guides/get-started/upgrade.mdx +16 -2
  22. package/docs/en/guides/rsbuild-plugins/plugin-esbuild.mdx +205 -0
  23. package/docs/en/guides/rsbuild-plugins/plugin-swc.mdx +356 -0
  24. package/docs/en/guides/topic-detail/framework-plugin/_meta.json +1 -1
  25. package/docs/en/guides/topic-detail/generator/_meta.json +1 -1
  26. package/docs/en/guides/topic-detail/generator/create/_meta.json +1 -5
  27. package/docs/en/guides/topic-detail/generator/new/_meta.json +1 -5
  28. package/docs/en/guides/topic-detail/generator/plugin/_meta.json +1 -1
  29. package/docs/en/guides/troubleshooting/_meta.json +1 -6
  30. package/docs/zh/apis/app/hooks/config/icon.mdx +1 -1
  31. package/docs/zh/apis/app/runtime/web-server/unstable_middleware.mdx +2 -2
  32. package/docs/zh/community/blog/_meta.json +1 -6
  33. package/docs/zh/components/deploy.mdx +1 -1
  34. package/docs/zh/configure/_meta.json +1 -1
  35. package/docs/zh/configure/app/tools/esbuild.mdx +1 -1
  36. package/docs/zh/configure/app/tools/swc.mdx +2 -2
  37. package/docs/zh/guides/_meta.json +5 -0
  38. package/docs/zh/guides/advanced-features/bff/_meta.json +1 -6
  39. package/docs/zh/guides/advanced-features/rspack-start.mdx +1 -8
  40. package/docs/zh/guides/advanced-features/ssr/_meta.json +1 -5
  41. package/docs/zh/guides/basic-features/data/_meta.json +1 -4
  42. package/docs/zh/guides/basic-features/data/data-fetch.mdx +3 -4
  43. package/docs/zh/guides/basic-features/routes.mdx +1 -1
  44. package/docs/zh/guides/concept/_meta.json +1 -4
  45. package/docs/zh/guides/concept/entries.mdx +76 -57
  46. package/docs/zh/guides/get-started/_meta.json +1 -7
  47. package/docs/zh/guides/get-started/introduction.mdx +2 -2
  48. package/docs/zh/guides/get-started/quick-start.mdx +0 -1
  49. package/docs/zh/guides/get-started/tech-stack.mdx +0 -2
  50. package/docs/zh/guides/get-started/upgrade.mdx +15 -1
  51. package/docs/zh/guides/rsbuild-plugins/plugin-esbuild.mdx +201 -0
  52. package/docs/zh/guides/rsbuild-plugins/plugin-swc.mdx +344 -0
  53. package/docs/zh/guides/topic-detail/framework-plugin/_meta.json +1 -1
  54. package/docs/zh/guides/topic-detail/generator/_meta.json +1 -1
  55. package/docs/zh/guides/topic-detail/generator/create/_meta.json +1 -5
  56. package/docs/zh/guides/topic-detail/generator/new/_meta.json +1 -5
  57. package/docs/zh/guides/topic-detail/generator/plugin/_meta.json +1 -1
  58. package/docs/zh/guides/troubleshooting/_meta.json +1 -6
  59. package/package.json +4 -4
  60. package/rspress.config.ts +2 -2
  61. package/src/components/ContentCard/index.tsx +1 -1
  62. package/src/components/FeatureLayout/index.tsx +1 -1
  63. package/src/components/Footer/index.tsx +2 -2
  64. package/src/components/ListCard/index.tsx +1 -1
  65. package/src/components/Sandpack/index.tsx +5 -3
  66. package/src/components/SecondaryTitle/index.tsx +1 -1
  67. package/src/components/ShowcaseList/index.tsx +1 -1
  68. package/src/i18n/index.ts +1 -1
  69. package/src/i18n/zhCN.ts +1 -1
  70. package/src/index.ts +0 -1
  71. package/src/pages/index.tsx +15 -7
  72. package/src/.eslintrc.json +0 -3
@@ -10,13 +10,13 @@ sidebar_position: 1
10
10
 
11
11
  **入口(Entry)指的是一个页面的起始模块。**
12
12
 
13
- 在 Modern.js 项目中,每一个入口对应一个独立的页面,也对应一条服务端路由。默认情况下,Modern.js 会基于目录约定来自动确定页面的入口,同时也支持通过配置项来自定义入口。
13
+ 在 Modern.js 应用中,每一个入口对应一个独立的页面,也对应一条服务端路由。默认情况下,Modern.js 会基于目录约定来自动确定页面的入口,同时也支持通过配置项来自定义入口。
14
14
 
15
15
  Modern.js 提供的很多配置项都是以入口为维度进行划分的,比如页面标题、HTML 模板、页面 Meta 信息、是否开启 SSR/SSG、服务端路由规则等。
16
16
 
17
17
  ## 单入口与多入口
18
18
 
19
- Modern.js 初始化的项目是单入口的(SPA),项目结构如下:
19
+ Modern.js 初始化的应用是单入口的,应用结构如下:
20
20
 
21
21
  ```
22
22
  .
@@ -30,7 +30,7 @@ Modern.js 初始化的项目是单入口的(SPA),项目结构如下:
30
30
  └── tsconfig.json
31
31
  ```
32
32
 
33
- 在 Modern.js 项目中,你可以很方便的将单入口切换成多入口,直接在项目下执行 `pnpm run new`,根据提示创建入口即可:
33
+ 在 Modern.js 应用中,你可以很方便的将单入口切换成多入口。在应用目录下执行 `pnpm run new`,根据提示即可创建入口:
34
34
 
35
35
  ```bash
36
36
  ? 请选择你想要的操作 创建工程元素
@@ -56,13 +56,12 @@ Modern.js 初始化的项目是单入口的(SPA),项目结构如下:
56
56
 
57
57
  原本的入口代码被移动到了和 `package.json` 中 `name` 同名的目录下,并创建了 `new-entry` 入口目录。
58
58
 
59
- 你可以执行 `pnpm run dev` 启动开发服务,此时可以看到新增了一条名为 `/new-entry` 的路由,并且原有页面的路由并未发生变化。
60
-
61
- :::tip
62
- Modern.js 会将与 `package.json` 文件中 `name` 字段同名的入口作为主入口,主入口的路由为 `/`,其他入口的路由为 `/{entryName}`。
59
+ Modern.js 会将与 `package.json` 文件中 `name` 字段同名的入口作为主入口,主入口的路由为 `/`,其他入口的路由为 `/{entryName}`。比如,`package.json` 中的 `name` 为 `myapp` 时,`src/myapp` 会作为应用的主入口。
63
60
 
64
- 比如,`package.json` 中的 `name` `myapp` 时,`src/myapp` 会作为项目的主入口。
61
+ 你可以执行 `pnpm run dev` 启动开发服务,此时可以看到新增了一条名为 `/new-entry` 的路由,并且原有页面的路由并未发生变化。
65
62
 
63
+ :::note
64
+ **单入口/多入口** 和 **SPA/MPA** 的概念并不等价。前者是关于如何配置和打包应用,而后者是组织前端应用的模式,每个入口都可以是 SPA 或非 SPA 的。
66
65
  :::
67
66
 
68
67
  ## 入口类型
@@ -73,39 +72,32 @@ import EntryMode from '@site-docs/components/entry-mode.mdx';
73
72
 
74
73
  <EntryMode />
75
74
 
76
- 默认情况下,Modern.js 启动项目前会对 `src/` 下的文件进行扫描,识别入口,并生成对应的服务端路由。
75
+ 默认情况下,Modern.js 启动应用前会对 `src/` 下的文件进行扫描,识别入口,并生成对应的服务端路由。
77
76
 
78
77
  :::tip
79
- - 你可以通过 [source.entriesDir](/configure/app/source/entries-dir) 修改页面入口的识别目录。
80
- - 如果你需要自定义入口,请参考 [自定义入口](#自定义入口)。
81
-
78
+ 你可以通过 [source.entriesDir](/configure/app/source/entries-dir) 修改识别入口的目录。
82
79
  :::
83
80
 
84
- 并非 `src/` 下所有的一级目录都会成为项目入口, 入口所在目录必须满足以下五个条件之一:
81
+ 入口所在目录必须满足以下三个条件之一:
85
82
 
86
83
  1. 具有 `routes/` 目录。
87
84
  2. 具有 `App.[jt]sx?` 文件。
88
- 3. 具有 `entry.[jt]sx?` 文件 (需要开启 `source.enableCustomEntry` 使用)。
89
- 4. 具有 `index.[jt]sx?` 文件(即将废弃)。
90
- 5. 具有 `pages/` 目录(兼容 Modern.js 1.0)(即将废弃)。
85
+ 3. 具有 `entry.[jt]sx?` 文件 (需要开启 [source.enableCustomEntry](/configure/app/source/enable-custom-entry) 使用)。
91
86
 
92
87
 
93
- 当 `src/` 目录满足入口特征时,Modern.js 会认为当前项目为单入口应用。
88
+ 当 `src/` 目录满足入口特征时,Modern.js 会认为当前应用为单入口应用。否则,Modern.js 会扫描 `src/` 下的一级目录,并进一步判断是否为入口,此时应用通常为多入口应用。
94
89
 
95
90
  :::tip
96
91
  在单入口应用中,默认的入口名为 `main`。
97
-
98
92
  :::
99
93
 
100
- 当项目不是单入口应用时,Modern.js 会进一步查看 `src/` 下的一级目录。
101
-
102
94
  ### 框架模式入口
103
95
 
104
- 框架模式指的是需要使用 Modern.js 的框架能力,例如嵌套路由、SSR、一体化调用等。这类入口约定下,开发者定义的入口并不是真正的编译入口。Modern.js 在启动时会生成一个封装过的入口,可以在 `node_modules/.modern/[entryName]/index.js` 找到真正的入口。
96
+ 框架模式指的是需要使用 Modern.js 的框架能力,例如约定式路由、SSR、一体化调用等。这类入口约定下,应用中的入口并不是真正的编译入口。Modern.js 在启动时会生成一个封装过的入口,可以在 `node_modules/.modern/[entryName]/index.js` 找到真正的入口。
105
97
 
106
98
  #### 约定式路由
107
99
 
108
- 如果入口中存在 `routes/` 目录,Modern.js 会在启动时扫描 `routes/` 下的文件,基于文件约定,自动生成客户端路由(react-router)。例如:
100
+ 如果入口中存在 `routes/` 目录,我们称该入口为约定式路由。Modern.js 会在启动时扫描 `routes/` 下的文件,基于文件约定,自动生成客户端路由(react-router)。例如:
109
101
 
110
102
  ```bash
111
103
  .
@@ -121,9 +113,17 @@ import EntryMode from '@site-docs/components/entry-mode.mdx';
121
113
 
122
114
  #### 自控式路由
123
115
 
124
- 如果入口中存在 `App.[jt]sx?` 文件,开发者可以在这个文件中通过代码的方式,设置客户端路由,或者不设置客户端路由。
116
+ 如果入口中存在 `App.[jt]sx?` 文件,我们称为该入口为自控式路由。例如:
125
117
 
126
- ```tsx
118
+ ```bash
119
+ .
120
+ ├── src
121
+ │ └── App.tsx
122
+ ```
123
+
124
+ 你可以在这个文件中通过代码的方式,设置客户端路由,或者不设置客户端路由。
125
+
126
+ ```tsx title="src/App.tsx"
127
127
  import { BrowserRouter, Route, Routes } from '@modern-js/runtime/router';
128
128
 
129
129
  export default () => {
@@ -142,12 +142,14 @@ export default () => {
142
142
 
143
143
  #### 自定义入口
144
144
 
145
- 如果入口中存在 `entry.[jt]sx` 文件,需要开发者在 `entry.[jt]sx` 文件中调用 `createRoot` 和 `render` 函数,完成项目入口逻辑。
146
-
147
145
  :::info
148
- 使用该文件需要开启 [source.enableCustomEntry](/configure/app/source/enable-custom-entry)。
146
+ 使用该功能需要开启 [source.enableCustomEntry](/configure/app/source/enable-custom-entry)。
149
147
  :::
150
148
 
149
+ 默认情况下,使用约定式路由或自控式路由时,Modern.js 会自动完成渲染。如果你希望自定义这个行为,可以通过自定义入口文件的方式来实现。
150
+
151
+ 如果入口中存在 `entry.[jt]sx` 文件,则 Modern.js 不再控制应用的渲染流程,你可以在 `entry.[jt]sx` 文件中调用 `createRoot` 和 `render` 函数,完成应用入口逻辑。
152
+
151
153
  ```tsx
152
154
  import { createRoot } from '@modern-js/runtime/react';
153
155
  import { render } from '@modern-js/runtime/browser';
@@ -158,7 +160,7 @@ render(<ModernRoot />);
158
160
 
159
161
  ```
160
162
 
161
- 比如在 render 执行前,需要做一些其他操作,可以这样实现:
163
+ 上述代码中,`createRoot` 函数返回的组件为 `routes/` 目录生成或 `App.tsx` 导出的组件,`render` 函数用于处理渲染与挂载组件。例如,你希望在渲染前执行某些异步任务,可以这样实现:
162
164
 
163
165
  ```tsx
164
166
  import { createRoot } from '@modern-js/runtime/react';
@@ -167,7 +169,7 @@ import { render } from '@modern-js/runtime/browser';
167
169
  const ModernRoot = createRoot();
168
170
 
169
171
  async function beforeRender() {
170
- // todo
172
+ // some async request
171
173
  }
172
174
 
173
175
  beforeRender().then(() => {
@@ -175,34 +177,15 @@ beforeRender().then(() => {
175
177
  });
176
178
  ```
177
179
 
178
- #### 自定义 Bootstrap
179
-
180
- :::warning
181
- 即将废弃,推荐使用自定义入口
182
- :::
183
-
184
- 如果入口中存在 `index.[jt]sx` 文件,并且当文件默认导出函数时,Modern.js 会将默认的 `bootstrap` 函数作为入参传入,并用导出的函数替代默认的 `bootstrap`,这样开发者可以自定义将组件挂载到 DOM 节点上,或在挂载前添加自定义行为。例如:
185
-
186
- ```tsx
187
- export default (App: React.ComponentType, bootstrap: () => void) => {
188
- // do something before bootstrap...
189
- initSomething().then(() => {
190
- bootstrap();
191
- });
192
- };
193
- ```
194
-
195
180
  ### 构建模式入口
196
181
 
197
- 构建模式指的是不使用 Modern.js 提供的 Runtime 能力,而是完全由开发者自行定义页面的入口。
198
-
199
- 当入口目录中存在 `index.[jt]sx`(即将废弃) 并且没有通过 `export default` 导出函数或者入口目录存在 `entry.[jt]sx` 并且未安装 `@modern-js/runtime` 依赖时,对应文件就会被识别为 webpack 或 Rspack 的 entry 模块。
200
-
201
182
  :::info
202
- 使用 `entry.[jt]sx` 文件需要开启 [source.enableCustomEntry](/configure/app/source/enable-custom-entry)。
183
+ 使用该功能需要开启需要开启 [source.enableCustomEntry](/configure/app/source/enable-custom-entry)。
203
184
  :::
204
185
 
205
- 此时 Modern.js 不会自动生成入口代码,因此需要你自行将组件挂载到 DOM 节点上,例如:
186
+ 构建模式指的是不使用 Modern.js 提供的 Runtime 能力,只使用 Modern.js 构建能力的开发模式。当应用中未安装 `@modern-js/runtime` 依赖时,Modern.js 会认为当前应用所有的入口都是构建模式入口。
187
+
188
+ 此时,如果入口中存在 `entry.[jt]sx`,则该文件会被识别为 webpack 或 Rspack 的构建入口。此时,Modern.js 不会自动生成入口代码,你需要自行将组件挂载到 DOM 节点上,例如:
206
189
 
207
190
  ```js title=src/entry.tsx
208
191
  import React from 'react';
@@ -212,18 +195,21 @@ import App from './App';
212
195
  ReactDOM.render(<App />, document.getElementById('root'));
213
196
  ```
214
197
 
215
- 这种方式等价于开启 Modern.js 的 [source.entries.disableMount](/configure/app/source/entries) 选项。当你使用这种方式时,**将无法使用 Modern.js 框架的运行时能力**,比如 `modern.config.js` 文件中的 `runtime` 配置将不会再生效。
198
+ 在构建模式入口中,**将无法使用 Modern.js 框架的运行时能力**,比如:
199
+ - 约定式路由,即基于 `src/routes` 下文件的路由
200
+ - 服务端渲染(SSR)
201
+ - `modern.config.js` 文件中的 `runtime` 配置将不会再生效
216
202
 
217
- ## 自定义入口配置
203
+ ## 在配置文件中指定入口
218
204
 
219
205
  在某些情况下,你可能需要自定义入口配置,而不是使用 Modern.js 提供的入口约定。
220
206
 
221
- 比如你需要将一个非 Modern.js 项目迁移到 Modern.js,它并不是按照 Modern.js 的目录结构来搭建的。如果你要将它改成 Modern.js 约定的目录结构,可能会存在一定的迁移成本。这种情况下,你就可以使用自定义入口。
207
+ 比如你需要将一个非 Modern.js 应用迁移到 Modern.js,它并不是按照 Modern.js 的目录结构来搭建的。如果你要将它改成 Modern.js 约定的目录结构,会存在一定的迁移成本。这种情况下,你就可以使用自定义入口。
222
208
 
223
209
  Modern.js 提供了以下配置项,你可以在 [modern.config.ts](/configure/app/usage) 中配置它们:
224
210
 
225
211
  - [source.entries](/configure/app/source/entries):用于设置自定义的入口对象。
226
- - [source.disableDefaultEntries](/configure/app/source/disable-default-entries):用于关闭 Modern.js 默认的入口扫描行为。当你使用自定义入口时,项目的部分结构可能会恰巧命中 Modern.js 约定的目录结构,但你可能不希望 Modern.js 为你自动生成入口配置,开启该选项可以避免这个问题。
212
+ - [source.disableDefaultEntries](/configure/app/source/disable-default-entries):用于关闭 Modern.js 默认的入口扫描行为。当你使用自定义入口时,应用的部分结构可能会恰巧命中 Modern.js 约定的目录结构,但你可能不希望 Modern.js 为你自动生成入口配置,开启该选项可以避免这个问题。
227
213
 
228
214
  ### 示例
229
215
 
@@ -247,4 +233,37 @@ export default defineConfig({
247
233
  });
248
234
  ```
249
235
 
250
- 注意,当你开启 `disableMount` 时,**将无法使用 Modern.js 框架的运行时能力**,比如 `modern.config.ts` 文件中的 `runtime` 配置将不会再生效。
236
+ 值得注意的是,默认情况下,Modern.js 认为通过配置指定的入口是**框架模式入口**,将自动生成真正的编译入口。如果你的应用是从 Webpack 或 Vite 等构建工具迁移到 Modern.js 框架时,你通常需要在入口配置中开启 `disableMount` 选项,此时 Modern.js 认为该入口是**构建模式入口**。
237
+
238
+
239
+ ## 弃用功能
240
+
241
+ 目前,如果入口所在的目录满足以下条件,也会成为应用入口。
242
+
243
+ 1. 具有 `index.[jt]sx?` 文件。
244
+ 2. 具有 `pages/` 目录。
245
+
246
+
247
+ `pages/` 目录为 Modern.js 旧版本中的约定式路由,新版本中推荐使用 `routes/` 目录。
248
+
249
+ `index.[jt]sx?` 在旧版本中支持应用自定义 Bootstrap 逻辑和构建模式入口,新版本中推荐使用 `entry.[jt]sx?` 代替。
250
+
251
+ ### 自定义 Bootstrap
252
+
253
+ 当入口中存在 `index.[jt]sx` 文件,并且当文件默认导出函数时,Modern.js 会将默认的 `bootstrap` 函数作为入参传入,并用导出的函数替代默认的 `bootstrap`,这样开发者可以自定义将组件挂载到 DOM 节点上,或在挂载前添加自定义行为。例如:
254
+
255
+ ```tsx
256
+ export default (App: React.ComponentType, bootstrap: () => void) => {
257
+ // do something before bootstrap...
258
+ initSomething().then(() => {
259
+ bootstrap();
260
+ });
261
+ };
262
+ ```
263
+
264
+ ### 构建模式入口
265
+
266
+ 当入口目录中存在 `index.[jt]sx`(即将废弃) 并且没有通过 `export default` 导出函数时,该入口也将被认为是构建模式入口。
267
+
268
+
269
+
@@ -1,7 +1 @@
1
- [
2
- "introduction",
3
- "quick-start",
4
- "upgrade",
5
- "glossary",
6
- "tech-stack"
7
- ]
1
+ ["introduction", "quick-start", "upgrade", "glossary", "tech-stack"]
@@ -50,10 +50,10 @@ Modern.js 能为开发者提供极致的**开发体验(Development Experience
50
50
 
51
51
  - 🚀 **Rust 构建**:提供双构建工具支持,轻松切换到 Rspack 构建工具,编译飞快。
52
52
  - 🪜 **渐进式**:使用最精简的模板创建项目,通过生成器逐步开启插件功能,定制解决方案。
53
- - 🏠 **一体化**:开发与生产环境 Web Server 唯一,CSR 和 SSR 同构开发,函数即接口的 API 服务调用。
53
+ - 🏠 **一体化**:开发与生产环境 Web Server 逻辑一致,CSR 和 SSR 同构开发,函数即接口的 API 服务调用。
54
54
  - 📦 **开箱即用**:默认 TS 支持,内置构建、ESLint、调试工具,全功能可测试。
55
55
  - 🌏 **周边生态**:自研状态管理、微前端、模块打包等周边需求。
56
- - 🕸 **多种路由模式**:包含自控路由、基于文件约定的路由(嵌套路由)等。
56
+ - 🕸 **约定式路由**:使用基于文件约定的路由,帮助开发者快速搭建应用。
57
57
 
58
58
  ## 和其他框架的对比
59
59
 
@@ -74,7 +74,6 @@ export default defineConfig({
74
74
  - 集成 Modern.js Core,提供配置解析、插件加载等能力。
75
75
  - 集成 Modern.js Builder,提供构建能力。
76
76
  - 集成 Modern.js Server,提供开发和生产服务器相关能力。
77
- - 集成一些最为常用的插件,比如 `plugin-lint`、`plugin-data-loader` 等。
78
77
 
79
78
  `@modern-js/app-tools` 是基于 Modern.js 的插件体系实现的,本质上是一个插件,因此你需要在配置文件的 `plugins` 字段中注册 `appTools`:
80
79
 
@@ -30,8 +30,6 @@ Modern.js 提供对 [Garfish](https://www.garfishjs.org/) 微前端框架开箱
30
30
 
31
31
  Modern.js 可以与社区中任意的状态管理库搭配使用,比如 [Redux](https://redux.js.org/)、[Jotai](https://jotai.org/)、[Zustand](https://docs.pmnd.rs/zustand)、[Valtio](https://valtio.pmnd.rs/) 等。
32
32
 
33
- Modern.js 也基于 Redux 封装了 Reduck 状态管理库,你可以参考 [「Reduck 状态管理」](/guides/topic-detail/model/quick-start)来使用。
34
-
35
33
  ## 包管理器
36
34
 
37
35
  Modern.js 可以与社区中任意的包管理器搭配使用,比如 [npm](https://www.npmjs.com/package/npm)、[yarn](https://classic.yarnpkg.com/lang/en/)、[pnpm](https://pnpm.io/) 或 [Bun](https://bun.sh/)。
@@ -38,9 +38,23 @@ import ReleaseNote from '@site-docs/components/release-note';
38
38
 
39
39
  :::tip
40
40
  当升级时,需要对 Modern.js 官方提供的所有包做统一升级,而不是升级单个依赖。
41
-
42
41
  :::
43
42
 
43
+ ## 版本管理策略
44
+
45
+ 在 Modern.js 项目中,我们推荐所有官方提供的依赖都使用固定版本号,不使用 `^` 或 `~` 进行范围声明。例如:
46
+
47
+ ```json
48
+ {
49
+ "dependencies": {
50
+ "@modern-js/app-tools": "x.y.z"
51
+ }
52
+ }
53
+ ```
54
+
55
+ 这样可以确保依赖的版本是完全确定的,从而保证构建的一致性和可预测性。
56
+
57
+
44
58
  ## 锁定子依赖
45
59
 
46
60
  当项目某个子依赖出现问题,而 Modern.js 无法立即更新时,可以使用包管理器锁定子依赖版本。
@@ -0,0 +1,201 @@
1
+ ---
2
+ sidebar_position: 3
3
+ ---
4
+
5
+ # Esbuild 插件
6
+
7
+ :::warning
8
+ **当前文档中的 esbuild 功能已停止迭代**,我们更推荐使用 Rspack + SWC 的方案,因为 Rspack + SWC 具备更好的构建性能、功能丰富度和产物兼容性。
9
+
10
+ 请参考[「使用 Rspack」](guides/advanced-features/rspack-start)了解更多。
11
+
12
+ :::
13
+
14
+ import Esbuild from '@modern-js/builder-doc/docs/zh/shared/esbuild.md';
15
+
16
+ <Esbuild />
17
+
18
+ ## 快速开始
19
+
20
+ ### 在 Modern.js 框架中使用
21
+
22
+ Modern.js 框架默认集成了 Builder 的 esbuild 插件,因此,你不需要手动安装和注册插件,只需要使用 [tools.esbuild](/configure/app/tools/esbuild.html) 配置项即可:
23
+
24
+ ```js
25
+ export default defineConfig({
26
+ tools: {
27
+ esbuild: {
28
+ loader: {
29
+ target: 'chrome61',
30
+ },
31
+ minimize: {
32
+ target: 'chrome61',
33
+ },
34
+ },
35
+ },
36
+ });
37
+ ```
38
+
39
+ ## 配置
40
+
41
+ 插件默认会开启代码转译和代码压缩的功能,你也可以通过配置来自定义插件的行为。
42
+
43
+ ### loader
44
+
45
+ - **类型:**
46
+
47
+ ```ts
48
+ type LoaderOptions = EsbuildLoaderOptions | false | undefined;
49
+ ```
50
+
51
+ - **默认值:**
52
+
53
+ ```ts
54
+ const defaultOptions = {
55
+ target: 'es2015',
56
+ charset: builderConfig.output.charset,
57
+ };
58
+ ```
59
+
60
+ 这个选项用于启用 JavaScript 和 TypeScript 的转译,启用时将会使用 esbuild-loader 替换 babel-loader 和 ts-loader。
61
+
62
+ 如果你需要修改转译参数,可以查看 [esbuild-loader 文档](https://github.com/privatenumber/esbuild-loader#loader)。
63
+
64
+ #### 设置 JSX 格式
65
+
66
+ 在使用 esbuild 进行代码转译时,esbuild 默认会读取 `tsconfig.json` 中的 `compilerOptions.jsx` 字段,来决定使用哪种 JSX 语法。
67
+
68
+ 因此,你需要在 `tsconfig.json` 中设置正确的 JSX 语法。
69
+
70
+ 比如 React 项目,需要将 `compilerOptions.jsx` 设置为 `react-jsx`:
71
+
72
+ ```json
73
+ {
74
+ "compilerOptions": {
75
+ "jsx": "react-jsx"
76
+ }
77
+ }
78
+ ```
79
+
80
+ #### 修改目标环境
81
+
82
+ 通过 `target` 选项来修改代码转译的目标环境。`target` 可以直接设置为 JavaScript 语言版本,比如 `es6`,`es2020`;也可以设置为若干个目标环境,每个目标环境都是一个环境名称后跟一个版本号,比如 `['chrome58', 'edge16' ,'firefox57']`。`target` 字段的详细介绍可以参考 [esbuild - target](https://esbuild.github.io/api/#target)。
83
+
84
+ target 支持设置为以下环境:
85
+
86
+ - chrome
87
+ - edge
88
+ - firefox
89
+ - ie
90
+ - ios
91
+ - node
92
+ - opera
93
+ - safari
94
+
95
+ ```ts
96
+ builderPluginEsbuild({
97
+ loader: {
98
+ target: 'chrome61',
99
+ },
100
+ });
101
+ ```
102
+
103
+ #### 关闭代码转译
104
+
105
+ 将 `loader` 设置为 `false` 来关闭 esbuild 代码转译,此时 Builder 会继续使用 Babel 来进行代码转译。
106
+
107
+ ```ts
108
+ builderPluginEsbuild({
109
+ loader: false,
110
+ });
111
+ ```
112
+
113
+ ### minimize
114
+
115
+ - **类型:**
116
+
117
+ ```ts
118
+ type MinimizeOptions = EsbuildMinifyOptions | false | undefined;
119
+ ```
120
+
121
+ - **默认值:**
122
+
123
+ ```ts
124
+ const defaultOptions = {
125
+ css: true,
126
+ target: 'es2015',
127
+ format: builderTarget === 'web' ? 'iife' : undefined,
128
+ };
129
+ ```
130
+
131
+ 这个选项用于启用 JavaScript 和 CSS 的代码压缩。
132
+
133
+ 如果你需要修改压缩参数,可以查看 [esbuild-loader 文档](https://github.com/privatenumber/esbuild-loader#minifyplugin)。
134
+
135
+ #### 修改目标环境
136
+
137
+ 通过 `target` 选项来修改代码压缩的目标环境。
138
+
139
+ ```ts
140
+ builderPluginEsbuild({
141
+ minimize: {
142
+ target: 'chrome61',
143
+ },
144
+ });
145
+ ```
146
+
147
+ #### 关闭代码压缩
148
+
149
+ 将 `minimize` 设置为 `false` 来关闭 esbuild 代码压缩,此时 Builder 会继续使用 Terser 进行代码压缩。
150
+
151
+ ```ts
152
+ builderPluginEsbuild({
153
+ minimize: false,
154
+ });
155
+ ```
156
+
157
+ ## esbuild 局限性
158
+
159
+ 虽然 esbuild 能给现有的 webpack 项目带来明显的构建性能提升,但这个工具在接入 Builder 时还存在一定的局限性,需要大家在接入的时候格外注意。
160
+
161
+ ### 兼容性
162
+
163
+ 使用 esbuild 进行代码转译时(即 `loader` 能力),esbuild 通常最低支持到 ES2015(即 ES6)语法,并且不具备自动注入 Polyfill 的能力。如果生产环境需要降级到 ES5 及以下的语法,建议使用 SWC 编译。
164
+
165
+ 你可以通过如下的配置指定目标语法版本:
166
+
167
+ ```ts
168
+ builderPluginEsbuild({
169
+ loader: {
170
+ target: 'es2015',
171
+ },
172
+ });
173
+ ```
174
+
175
+ 使用 esbuild 进行代码压缩时(即 `minimize` 能力),esbuild 可以在生产环境中进行压缩和混淆,通常最低支持到 ES2015 语法。
176
+
177
+ 如果设置压缩的 `target` 为 `es5`,需要保证所有代码已经被转义为 ES5 代码,否则会导致 esbuild 编译报错:`Transforming 'xxx' to the configured target environment ("es5") is not supported yet`。
178
+
179
+ 因此,对于生产环境需要兼容 ES5 及以下语法的项目,请谨慎开启 minimize 能力,建议使用 SWC 压缩。
180
+
181
+ 你可以通过如下的配置指定目标语法版本:
182
+
183
+ ```ts
184
+ builderPluginEsbuild({
185
+ minimize: {
186
+ target: 'es2015',
187
+ },
188
+ });
189
+ ```
190
+
191
+ ### 不支持 Babel 插件
192
+
193
+ 使用 esbuild 进行代码转译时,诸如 `babel-plugin-import` 等原有 Babel 插件的语法编译功能在开启 esbuild 后无法使用。并且由于 Builder 底层使用的是 esbuild 的 `Transform API`,因此不支持使用额外 esbuild 插件来进行自定义编译过程。
194
+
195
+ 如果你有 `babel-plugin-import` 等 Babel 插件相关诉求,可以使用 SWC 插件。
196
+
197
+ ### 产物体积
198
+
199
+ 使用 esbuild 压缩虽然带来了构建效率上的提升,但 esbuild 的压缩比例是低于 terser 的,因此**构建产物的体积会增大**,请根据业务情况酌情使用。通常来说,esbuild 比较适合中后台等对体积不敏感的场景。
200
+
201
+ 对于压缩工具之间的详细对比,可以参考 [minification-benchmarks](https://github.com/privatenumber/minification-benchmarks)。