@modern-js/main-doc 2.58.3 → 2.60.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (203) hide show
  1. package/docs/en/_meta.json +10 -5
  2. package/docs/en/apis/app/hooks/api/lambda.mdx +4 -48
  3. package/docs/en/apis/app/hooks/api/middleware.mdx +11 -0
  4. package/docs/en/apis/app/runtime/core/use-loader.mdx +1 -1
  5. package/docs/en/community/blog/v2-release-note.mdx +1 -1
  6. package/docs/en/components/enable-bff.mdx +19 -2
  7. package/docs/en/components/extend-bff-function.mdx +5 -0
  8. package/docs/en/components/init-app.mdx +0 -1
  9. package/docs/en/components/init-rspack-app.mdx +0 -1
  10. package/docs/en/components/other-plugins.mdx +0 -0
  11. package/docs/en/components/ssr-monitor.mdx +3 -0
  12. package/docs/en/configure/app/auto-load-plugin.mdx +4 -0
  13. package/docs/en/configure/app/output/ssg.mdx +52 -141
  14. package/docs/en/configure/app/plugins.mdx +2 -2
  15. package/docs/en/configure/app/tools/esbuild.mdx +1 -1
  16. package/docs/en/configure/app/tools/swc.mdx +1 -1
  17. package/docs/en/configure/app/tools/tailwindcss.mdx +1 -1
  18. package/docs/en/guides/_meta.json +0 -5
  19. package/docs/en/guides/advanced-features/_meta.json +3 -8
  20. package/docs/en/guides/advanced-features/bff/_meta.json +1 -1
  21. package/docs/en/guides/advanced-features/bff/extend-server.mdx +154 -0
  22. package/docs/en/guides/advanced-features/bff/frameworks.mdx +52 -123
  23. package/docs/en/guides/advanced-features/bff/function.mdx +108 -80
  24. package/docs/en/guides/advanced-features/bff/sdk.mdx +40 -51
  25. package/docs/en/guides/advanced-features/build-performance.mdx +6 -21
  26. package/docs/en/guides/advanced-features/page-performance/_meta.json +1 -0
  27. package/docs/en/guides/advanced-features/rspack-start.mdx +6 -14
  28. package/docs/en/guides/basic-features/_meta.json +31 -9
  29. package/docs/en/guides/basic-features/css/_meta.json +1 -0
  30. package/docs/en/guides/basic-features/css/css-in-js.mdx +34 -0
  31. package/docs/en/guides/basic-features/{css-modules.mdx → css/css-modules.mdx} +0 -4
  32. package/docs/en/guides/basic-features/css/css.mdx +25 -0
  33. package/docs/en/guides/basic-features/{css.mdx → css/tailwindcss.mdx} +5 -66
  34. package/docs/en/guides/basic-features/data/data-fetch.mdx +134 -235
  35. package/docs/en/guides/basic-features/data/data-write.mdx +66 -77
  36. package/docs/en/guides/basic-features/debug/_meta.json +1 -0
  37. package/docs/en/guides/basic-features/debug/rsdoctor.mdx +57 -0
  38. package/docs/en/guides/{advanced-features → basic-features/debug}/using-storybook.mdx +2 -0
  39. package/docs/en/guides/basic-features/render/_meta.json +1 -0
  40. package/docs/en/guides/basic-features/render/ssg.mdx +208 -0
  41. package/docs/en/guides/{advanced-features/ssr/cache.mdx → basic-features/render/ssr-cache.mdx} +38 -50
  42. package/docs/en/guides/basic-features/render/ssr.mdx +301 -0
  43. package/docs/en/guides/basic-features/render/streaming-ssr.mdx +230 -0
  44. package/docs/en/guides/basic-features/routes.mdx +274 -263
  45. package/docs/en/guides/basic-features/static-assets/_meta.json +1 -0
  46. package/docs/en/guides/basic-features/static-assets.mdx +2 -2
  47. package/docs/en/guides/basic-features/testing/_meta.json +1 -0
  48. package/docs/en/guides/basic-features/testing/cypress.mdx +95 -0
  49. package/docs/en/guides/basic-features/testing/jest.mdx +148 -0
  50. package/docs/en/guides/basic-features/testing/playwright.mdx +111 -0
  51. package/docs/en/guides/basic-features/testing/vitest.mdx +100 -0
  52. package/docs/en/guides/concept/entries.mdx +9 -2
  53. package/docs/en/guides/deprecated.md +2 -0
  54. package/docs/en/guides/get-started/quick-start.mdx +1 -1
  55. package/docs/en/guides/get-started/tech-stack.mdx +4 -4
  56. package/docs/en/guides/topic-detail/_meta.json +0 -6
  57. package/docs/en/guides/topic-detail/generator/create/config.mdx +0 -10
  58. package/docs/en/guides/topic-detail/generator/create/use.mdx +0 -1
  59. package/docs/en/plugin/_meta.json +19 -0
  60. package/docs/en/plugin/cli-plugins/_meta.json +1 -0
  61. package/docs/en/plugin/cli-plugins/plugin-bff.mdx +5 -0
  62. package/docs/en/plugin/cli-plugins/plugin-ssg.mdx +5 -0
  63. package/docs/en/{guides/rsbuild-plugins → plugin/cli-plugins}/plugin-swc.mdx +7 -0
  64. package/docs/en/plugin/cli-plugins/plugin-tailwind.mdx +5 -0
  65. package/docs/en/plugin/cli-plugins.mdx +6 -0
  66. package/docs/en/{guides/advanced-features/rsbuild-plugin.mdx → plugin/introduction.mdx} +36 -11
  67. package/docs/en/{guides/topic-detail/framework-plugin → plugin/plugin-system}/extend.mdx +1 -1
  68. package/docs/en/{guides/topic-detail/framework-plugin → plugin/plugin-system}/implement.mdx +3 -3
  69. package/docs/en/{guides/topic-detail/framework-plugin → plugin/plugin-system}/plugin-api.mdx +2 -2
  70. package/docs/en/plugin/rsbuild-plugins/_meta.json +1 -0
  71. package/docs/en/plugin/rsbuild-plugins.mdx +3 -0
  72. package/docs/en/tutorials/first-app/c03-css.mdx +1 -1
  73. package/docs/zh/_meta.json +10 -5
  74. package/docs/zh/apis/app/hooks/api/lambda.mdx +5 -48
  75. package/docs/zh/apis/app/hooks/api/middleware.mdx +11 -0
  76. package/docs/zh/apis/app/runtime/core/use-loader.mdx +1 -1
  77. package/docs/zh/community/blog/v2-release-note.mdx +1 -1
  78. package/docs/zh/components/enable-bff.mdx +19 -2
  79. package/docs/zh/components/extend-bff-function.mdx +5 -0
  80. package/docs/zh/components/init-app.mdx +0 -1
  81. package/docs/zh/components/init-rspack-app.mdx +0 -1
  82. package/docs/zh/components/other-plugins.mdx +0 -0
  83. package/docs/zh/components/ssr-monitor.mdx +3 -0
  84. package/docs/zh/configure/app/auto-load-plugin.mdx +4 -0
  85. package/docs/zh/configure/app/output/ssg.mdx +49 -139
  86. package/docs/zh/configure/app/plugins.mdx +2 -2
  87. package/docs/zh/configure/app/tools/esbuild.mdx +1 -1
  88. package/docs/zh/configure/app/tools/swc.mdx +1 -1
  89. package/docs/zh/configure/app/tools/tailwindcss.mdx +1 -1
  90. package/docs/zh/guides/_meta.json +0 -5
  91. package/docs/zh/guides/advanced-features/_meta.json +3 -8
  92. package/docs/zh/guides/advanced-features/bff/_meta.json +1 -1
  93. package/docs/zh/guides/advanced-features/bff/extend-server.mdx +156 -0
  94. package/docs/zh/guides/advanced-features/bff/frameworks.mdx +51 -117
  95. package/docs/zh/guides/advanced-features/bff/function.mdx +69 -59
  96. package/docs/zh/guides/advanced-features/bff/sdk.mdx +27 -36
  97. package/docs/zh/guides/advanced-features/build-performance.mdx +6 -21
  98. package/docs/zh/guides/advanced-features/page-performance/_meta.json +1 -0
  99. package/docs/zh/guides/advanced-features/rspack-start.mdx +8 -17
  100. package/docs/zh/guides/basic-features/_meta.json +31 -9
  101. package/docs/zh/guides/basic-features/alias.mdx +5 -11
  102. package/docs/zh/guides/basic-features/css/_meta.json +1 -0
  103. package/docs/zh/guides/basic-features/css/css-in-js.mdx +34 -0
  104. package/docs/zh/guides/basic-features/css/css.mdx +25 -0
  105. package/docs/zh/guides/basic-features/{css.mdx → css/tailwindcss.mdx} +3 -64
  106. package/docs/zh/guides/basic-features/data/data-fetch.mdx +96 -211
  107. package/docs/zh/guides/basic-features/data/data-write.mdx +54 -55
  108. package/docs/zh/guides/basic-features/debug/_meta.json +1 -0
  109. package/docs/zh/guides/basic-features/debug/rsdoctor.mdx +57 -0
  110. package/docs/zh/guides/{advanced-features → basic-features/debug}/using-storybook.mdx +1 -1
  111. package/docs/zh/guides/basic-features/env-vars.mdx +1 -1
  112. package/docs/zh/guides/basic-features/render/_meta.json +1 -0
  113. package/docs/zh/guides/basic-features/render/ssg.mdx +210 -0
  114. package/docs/zh/guides/{advanced-features/ssr/cache.mdx → basic-features/render/ssr-cache.mdx} +16 -26
  115. package/docs/zh/guides/basic-features/render/ssr.mdx +309 -0
  116. package/docs/zh/guides/{advanced-features/ssr/stream.mdx → basic-features/render/streaming-ssr.mdx} +22 -37
  117. package/docs/zh/guides/basic-features/routes.mdx +251 -237
  118. package/docs/zh/guides/basic-features/static-assets/_meta.json +1 -0
  119. package/docs/zh/guides/basic-features/static-assets.mdx +3 -7
  120. package/docs/zh/guides/basic-features/testing/_meta.json +1 -0
  121. package/docs/zh/guides/basic-features/testing/cypress.mdx +95 -0
  122. package/docs/zh/guides/basic-features/testing/jest.mdx +148 -0
  123. package/docs/zh/guides/basic-features/testing/playwright.mdx +112 -0
  124. package/docs/zh/guides/basic-features/testing/vitest.mdx +100 -0
  125. package/docs/zh/guides/concept/entries.mdx +6 -3
  126. package/docs/zh/guides/deprecated.md +4 -0
  127. package/docs/zh/guides/get-started/quick-start.mdx +1 -1
  128. package/docs/zh/guides/get-started/tech-stack.mdx +8 -8
  129. package/docs/zh/guides/topic-detail/_meta.json +0 -6
  130. package/docs/zh/guides/topic-detail/generator/create/config.mdx +0 -10
  131. package/docs/zh/guides/topic-detail/generator/create/use.mdx +0 -1
  132. package/docs/zh/plugin/_meta.json +19 -0
  133. package/docs/zh/plugin/cli-plugins/_meta.json +1 -0
  134. package/docs/zh/plugin/cli-plugins/plugin-bff.mdx +5 -0
  135. package/docs/zh/plugin/cli-plugins/plugin-ssg.mdx +5 -0
  136. package/docs/zh/{guides/rsbuild-plugins → plugin/cli-plugins}/plugin-swc.mdx +7 -0
  137. package/docs/zh/plugin/cli-plugins/plugin-tailwind.mdx +5 -0
  138. package/docs/zh/plugin/cli-plugins.mdx +6 -0
  139. package/docs/zh/{guides/advanced-features/rsbuild-plugin.mdx → plugin/introduction.mdx} +38 -13
  140. package/docs/zh/{guides/topic-detail/framework-plugin → plugin/plugin-system}/extend.mdx +1 -1
  141. package/docs/zh/{guides/topic-detail/framework-plugin → plugin/plugin-system}/implement.mdx +3 -3
  142. package/docs/zh/{guides/topic-detail/framework-plugin → plugin/plugin-system}/plugin-api.mdx +2 -2
  143. package/docs/zh/plugin/rsbuild-plugins/_meta.json +1 -0
  144. package/docs/zh/plugin/rsbuild-plugins.mdx +4 -0
  145. package/docs/zh/tutorials/first-app/c03-css.mdx +1 -1
  146. package/i18n.json +42 -6
  147. package/package.json +7 -6
  148. package/rspress.config.ts +1 -58
  149. package/src/components/Footer/index.tsx +1 -1
  150. package/src/pages/index.tsx +0 -1
  151. package/docs/en/apis/app/hooks/api/api.mdx +0 -80
  152. package/docs/en/apis/app/hooks/api/app.mdx +0 -12
  153. package/docs/en/apis/app/hooks/config/storybook.mdx +0 -37
  154. package/docs/en/guides/advanced-features/bff/type.mdx +0 -46
  155. package/docs/en/guides/advanced-features/eslint.mdx +0 -148
  156. package/docs/en/guides/advanced-features/ssg.mdx +0 -116
  157. package/docs/en/guides/advanced-features/ssr/_meta.json +0 -1
  158. package/docs/en/guides/advanced-features/ssr/index.mdx +0 -23
  159. package/docs/en/guides/advanced-features/ssr/stream.mdx +0 -248
  160. package/docs/en/guides/advanced-features/ssr/usage.mdx +0 -341
  161. package/docs/en/guides/advanced-features/ssr.mdx +0 -555
  162. package/docs/zh/apis/app/hooks/api/api.mdx +0 -81
  163. package/docs/zh/apis/app/hooks/api/app.mdx +0 -12
  164. package/docs/zh/apis/app/hooks/config/storybook.mdx +0 -38
  165. package/docs/zh/guides/advanced-features/bff/type.mdx +0 -46
  166. package/docs/zh/guides/advanced-features/eslint.mdx +0 -152
  167. package/docs/zh/guides/advanced-features/ssg.mdx +0 -116
  168. package/docs/zh/guides/advanced-features/ssr/_meta.json +0 -1
  169. package/docs/zh/guides/advanced-features/ssr/index.mdx +0 -23
  170. package/docs/zh/guides/advanced-features/ssr/usage.mdx +0 -329
  171. /package/docs/en/guides/advanced-features/{bff/index.mdx → bff.mdx} +0 -0
  172. /package/docs/en/guides/advanced-features/{code-split.mdx → page-performance/code-split.mdx} +0 -0
  173. /package/docs/en/guides/advanced-features/{inline-assets.mdx → page-performance/inline-assets.mdx} +0 -0
  174. /package/docs/en/guides/advanced-features/{optimize-bundle.mdx → page-performance/optimize-bundle.mdx} +0 -0
  175. /package/docs/en/guides/basic-features/{mock.mdx → debug/mock.mdx} +0 -0
  176. /package/docs/en/guides/basic-features/{proxy.mdx → debug/proxy.mdx} +0 -0
  177. /package/docs/en/guides/basic-features/{json-files.mdx → static-assets/json-files.mdx} +0 -0
  178. /package/docs/en/guides/basic-features/{svg-assets.mdx → static-assets/svg-assets.mdx} +0 -0
  179. /package/docs/en/guides/basic-features/{wasm-assets.mdx → static-assets/wasm-assets.mdx} +0 -0
  180. /package/docs/en/{guides/topic-detail/framework-plugin → plugin/plugin-system}/_meta.json +0 -0
  181. /package/docs/en/{guides/topic-detail/framework-plugin → plugin/plugin-system}/hook-list.mdx +0 -0
  182. /package/docs/en/{guides/topic-detail/framework-plugin → plugin/plugin-system}/hook.mdx +0 -0
  183. /package/docs/en/{guides/topic-detail/framework-plugin → plugin/plugin-system}/introduction.mdx +0 -0
  184. /package/docs/en/{guides/topic-detail/framework-plugin → plugin/plugin-system}/lifecycle.mdx +0 -0
  185. /package/docs/en/{guides/topic-detail/framework-plugin → plugin/plugin-system}/relationship.mdx +0 -0
  186. /package/docs/en/{guides → plugin}/rsbuild-plugins/plugin-esbuild.mdx +0 -0
  187. /package/docs/zh/guides/advanced-features/{bff/index.mdx → bff.mdx} +0 -0
  188. /package/docs/zh/guides/advanced-features/{code-split.mdx → page-performance/code-split.mdx} +0 -0
  189. /package/docs/zh/guides/advanced-features/{inline-assets.mdx → page-performance/inline-assets.mdx} +0 -0
  190. /package/docs/zh/guides/advanced-features/{optimize-bundle.mdx → page-performance/optimize-bundle.mdx} +0 -0
  191. /package/docs/zh/guides/basic-features/{css-modules.mdx → css/css-modules.mdx} +0 -0
  192. /package/docs/zh/guides/basic-features/{mock.mdx → debug/mock.mdx} +0 -0
  193. /package/docs/zh/guides/basic-features/{proxy.mdx → debug/proxy.mdx} +0 -0
  194. /package/docs/zh/guides/basic-features/{json-files.mdx → static-assets/json-files.mdx} +0 -0
  195. /package/docs/zh/guides/basic-features/{svg-assets.mdx → static-assets/svg-assets.mdx} +0 -0
  196. /package/docs/zh/guides/basic-features/{wasm-assets.mdx → static-assets/wasm-assets.mdx} +0 -0
  197. /package/docs/zh/{guides/topic-detail/framework-plugin → plugin/plugin-system}/_meta.json +0 -0
  198. /package/docs/zh/{guides/topic-detail/framework-plugin → plugin/plugin-system}/hook-list.mdx +0 -0
  199. /package/docs/zh/{guides/topic-detail/framework-plugin → plugin/plugin-system}/hook.mdx +0 -0
  200. /package/docs/zh/{guides/topic-detail/framework-plugin → plugin/plugin-system}/introduction.mdx +0 -0
  201. /package/docs/zh/{guides/topic-detail/framework-plugin → plugin/plugin-system}/lifecycle.mdx +0 -0
  202. /package/docs/zh/{guides/topic-detail/framework-plugin → plugin/plugin-system}/relationship.mdx +0 -0
  203. /package/docs/zh/{guides → plugin}/rsbuild-plugins/plugin-esbuild.mdx +0 -0
@@ -0,0 +1 @@
1
+ ["json-files", "svg-assets", "wasm-assets"]
@@ -1,7 +1,3 @@
1
- ---
2
- sidebar_position: 10
3
- ---
4
-
5
1
  # 引用静态资源
6
2
 
7
3
  Modern.js 支持在代码中引用图片、字体、媒体类型的静态资源。
@@ -21,7 +17,7 @@ Modern.js 支持在代码中引用图片、字体、媒体类型的静态资源
21
17
  如果你需要引用其他格式的静态资源,请参考 [扩展静态资源类型](#扩展静态资源类型)。
22
18
 
23
19
  :::tip SVG 图片
24
- SVG 图片是一种特殊情况,Modern.js 提供了 SVG 转 React 组件的能力,对 SVG 进行单独处理,详见 [引用 SVG 资源](/guides/basic-features/svg-assets.html)。
20
+ SVG 图片是一种特殊情况,Modern.js 提供了 SVG 转 React 组件的能力,对 SVG 进行单独处理,详见 [引用 SVG 资源](/guides/basic-features/static-assets/svg-assets.html)。
25
21
  :::
26
22
 
27
23
  ## 在 JS 文件中引用
@@ -76,7 +72,7 @@ console.log(largeImage); // "/static/largeImage.6c12aba3.png"
76
72
  console.log(smallImage); // "data:image/png;base64,iVBORw0KGgo..."
77
73
  ```
78
74
 
79
- 关于资源内联的更详细介绍,请参考 [静态资源内联](/guides/advanced-features/inline-assets) 章节。
75
+ 关于资源内联的更详细介绍,请参考 [静态资源内联](/guides/advanced-features/page-performance/inline-assets) 章节。
80
76
 
81
77
  ## 构建产物
82
78
 
@@ -162,4 +158,4 @@ console.log(myFile); // "/static/myFile.6c12aba3.pdf"
162
158
  | PNG | 无损压缩,不会丢失图片细节,不失真,支持半透明 | 不适合色表复杂的图片 | 适合颜色数量少,边界层次分明的图片,适合用在 logo、icon、透明图等场景 |
163
159
  | JPG | 颜色丰富 | 有损压缩,会导致图片失真,不支持透明度 | 适合颜色数量多,颜色带有渐变、过度复杂的图片,适合用在人像照片、风景图等场景 |
164
160
  | WebP | 同时支持有损压缩与无损压缩,支持透明度,体积比 PNG 和 JPG 小很多 | iOS 兼容性不好 | 几乎任何场景的像素图片,支持 WebP 的宿主环境,都应该首选 WebP 图片格式 |
165
- | SVG | 无损格式,不失真,支持透明度 | 不适合复杂图形 | 适合矢量图,适合用于 icon |
161
+ | SVG | 无损格式,不失真,支持透明度 | 不适合复杂图形 | 适合矢量图,适合用于 icon |
@@ -0,0 +1 @@
1
+ ["playwright", "vitest", "jest", "cypress"]
@@ -0,0 +1,95 @@
1
+ # Cypress
2
+
3
+ Cypress 是一个用于 E2E 测试和组件测试的框架。
4
+
5
+ 在 Modern.js 中使用 Cypress 需要先安装依赖,可以执行以下命令:
6
+
7
+ import { PackageManagerTabs } from '@theme';
8
+
9
+ <PackageManagerTabs command={{ npm: "npm install -D cypress", yarn: "yarn add -D cypress", pnpm: "pnpm install -D cypress" }} />
10
+
11
+ 接下来,创建 `cypress.config.ts` 文件,并添加以下内容:
12
+
13
+ ```ts
14
+ import { defineConfig } from 'cypress'
15
+
16
+ export default defineConfig({
17
+ e2e: {
18
+ setupNodeEvents(on, config) {},
19
+ },
20
+ })
21
+ ```
22
+
23
+ ## 编写测试用例
24
+
25
+ 现在,使用 Cypress 来编写一个 E2E 用例,首先创建两张 Modern.js 的页面。
26
+
27
+ ```tsx title="routes/page.tsx"
28
+ import { Link } from '@modern-js/runtime/router';
29
+
30
+ const Index = () => (
31
+ <div>
32
+ <h1>Home</h1>
33
+ <Link to="/about">About</Link>
34
+ </div>
35
+ );
36
+
37
+ export default Index;
38
+ ```
39
+
40
+ ```tsx title="routes/about/page.tsx"
41
+ import { Link } from '@modern-js/runtime/router';
42
+
43
+ const Index = () => (
44
+ <div>
45
+ <h1>About</h1>
46
+ <Link to="/">Home</Link>
47
+ </div>
48
+ );
49
+
50
+ export default Index;
51
+ ```
52
+
53
+ 接下来,创建测试用例文件:
54
+
55
+ ```ts title="cypress/e2e/app.cy.ts"
56
+ describe('Navigation', () => {
57
+ it('should navigate to the about page', () => {
58
+ // Start from the index page
59
+ cy.visit('http://localhost:8080/')
60
+
61
+ // Find a link with an href attribute containing "about" and click it
62
+ cy.get('a[href*="about"]').click()
63
+
64
+ // The new url should include "/about"
65
+ cy.url().should('include', '/about')
66
+
67
+ // The new page should contain an h1 with "About"
68
+ cy.get('h1').contains('About')
69
+ })
70
+ })
71
+ ```
72
+
73
+ 测试文件可能会缺少 API 的类型,你可以参考 [Cypress - Typescript](https://docs.cypress.io/guides/tooling/typescript-support#Configure-tsconfigjson) 文档解决。
74
+
75
+ 你可以将命令添加到 `package.json` 中:
76
+
77
+ ```json title="package.json"
78
+ {
79
+ "scripts": {
80
+ "test": "cypress open"
81
+ }
82
+ }
83
+ ```
84
+
85
+ ## 运行测试用例
86
+
87
+ 执行上述 `test` 命令,运行测试用例:
88
+
89
+ ```bash
90
+ DevTools listening on ws://127.0.0.1:55203/devtools/browser/xxxxx
91
+ ```
92
+
93
+ Cypress 会打开一个无头浏览器,按照提示你可以找到对应的测试文件,并自动运行 E2E 测试:
94
+
95
+ ![cypress](https://lf3-static.bytednsdoc.com/obj/eden-cn/nuvjhpqnuvr/cypress.jpg)
@@ -0,0 +1,148 @@
1
+ # Jest
2
+
3
+ Jest 是一个 JavaScript 测试框架,它主要和 React Testing Library 一起用于单元测试和 Snapshot 测试。
4
+
5
+ 在 Modern.js 中使用 Jest 需要先安装依赖,可以执行以下命令:
6
+
7
+ import { PackageManagerTabs } from '@theme';
8
+
9
+ <PackageManagerTabs command={{
10
+ npm: "npm install -D jest jest-environment-jsdom @testing-library/react @testing-library/dom @testing-library/jest-dom",
11
+ yarn: "yarn add -D jest jest-environment-jsdom @testing-library/react @testing-library/dom @testing-library/jest-dom",
12
+ pnpm: "pnpm install -D jest jest-environment-jsdom @testing-library/react @testing-library/dom @testing-library/jest-dom"
13
+ }} />
14
+
15
+ 随后,你可以运行以下命令,这将自动在项目中初始化 Jets,并生成一个基础的 `jest.config.[jt]s` 配置:
16
+
17
+ <PackageManagerTabs command={{
18
+ npm: "npm init jest@latest",
19
+ yarn: "yarn create jest@latest",
20
+ pnpm: "pnpm create jest@latest"
21
+ }} />
22
+
23
+ ## 配置文件
24
+
25
+ :::note
26
+ 本章节会使用 `.ts` 文件来完成 Jest 测试。
27
+ :::
28
+
29
+ 相比于其他的测试框架,Jest 在构建层面需要更多的配置,例如处理 JSX 和 ESM 语法,因此首先需要安装一些额外的依赖:
30
+
31
+ <PackageManagerTabs command={{
32
+ npm: "npm install -D babel-jest @babel/core @babel/preset-env @babel/preset-react @babel/preset-typescript",
33
+ yarn: "yarn add -D babel-jest @babel/core @babel/preset-env @babel/preset-react @babel/preset-typescript",
34
+ pnpm: "pnpm install -D babel-jest @babel/core @babel/preset-env @babel/preset-react @babel/preset-typescript"
35
+ }} />
36
+
37
+ ### 配置 Jest
38
+
39
+ 你需要进一步配置 `jest.config.ts` 文件,以便让 Jest 能够正确地编译和运行测试用例。下面是一个最基本的配置:
40
+
41
+ ```ts title="jest.config.ts"
42
+ import type { Config } from 'jest';
43
+
44
+ const config: Config = {
45
+ coverageProvider: 'babel',
46
+ setupFilesAfterEnv: ['<rootDir>/jest.setup.ts'],
47
+ testEnvironment: 'jsdom',
48
+ transform: {
49
+ '^.+\\.(js|jsx|ts|tsx)$': 'babel-jest',
50
+ },
51
+ transformIgnorePatterns: [],
52
+ };
53
+
54
+ export default config;
55
+ ```
56
+
57
+ 配置中,将 `transformIgnorePatterns` 设置为了空数组,意味着所有的文件都会经过编译,如果你希望提升测试运行的速度,可以按需配置。
58
+
59
+ `setupFilesAfterEnv` 会在启动时执行,在 `jest.setup.ts` 中,可以引入 `@testing-library/jest-dom`。它包含了一组便捷的自定义匹配器,例如 `.toBeInTheDocument()`,使编写测试变得更容易:
60
+
61
+ ```ts title="jest.setup.ts"
62
+ import '@testing-library/jest-dom';
63
+ ```
64
+
65
+ ### 配置 Babel
66
+
67
+ 你需要配置 Babel 让 Jest 能够自动编译 JSX 等语法,下面是一个基本的配置:
68
+
69
+ ```js title="babel.config.js"
70
+ module.exports = {
71
+ presets: [
72
+ ['@babel/preset-env', { targets: { node: 'current' } }],
73
+ ['@babel/preset-react', { runtime: 'automatic' }],
74
+ '@babel/preset-typescript',
75
+ ],
76
+ };
77
+ ```
78
+
79
+ ## 编写测试用例
80
+
81
+ 现在,你可以开始编写测试用了,首先在 `package.json` 中添加一个 `test` 命令:
82
+
83
+ ```json title="package.json"
84
+ {
85
+ "scripts": {
86
+ "test": "jest"
87
+ }
88
+ }
89
+ ```
90
+
91
+ 创建一个简单的页面用于测试:
92
+
93
+ ```tsx title="routes/page.tsx"
94
+ import { Link } from '@modern-js/runtime/router';
95
+
96
+ const Index = () => (
97
+ <div>
98
+ <h1>Home</h1>
99
+ <Link to="/about">About</Link>
100
+ </div>
101
+ );
102
+
103
+ export default Index;
104
+ ```
105
+
106
+ 添加测试用例,检测页面中是否有预期的文本:
107
+
108
+ ```tsx title="__tests__/page.test.tsx"
109
+ import '@testing-library/jest-dom';
110
+ import { render, screen } from '@testing-library/react';
111
+ import { BrowserRouter as Router } from '@modern-js/runtime/router';
112
+ import Page from '../routes/page';
113
+
114
+ describe('Page', () => {
115
+ it('renders a heading', () => {
116
+ render(
117
+ <Router>
118
+ <Page />
119
+ </Router>,
120
+ );
121
+
122
+ const heading = screen.getByRole('heading', { level: 1 });
123
+
124
+ expect(heading).toBeInTheDocument();
125
+ });
126
+ });
127
+ ```
128
+
129
+ 上述用例中,我们从 `@modern-js/runtime/router` 引入了 `<Router>` 组件,这是因为 React Router 在渲染部分路由相关组件时,必须要有对应的上下文。
130
+
131
+ :::note
132
+ 直接在 Modern.js 应用中运行时,`<Router>` 组件会自动注入。
133
+ :::
134
+
135
+ ## 运行测试用例
136
+
137
+ 执行上述 `test` 命令,运行测试用例:
138
+
139
+ ```bash
140
+ PASS src/__tests__/page.test.tsx
141
+ Page
142
+ ✓ renders a heading (31 ms)
143
+
144
+ Test Suites: 1 passed, 1 total
145
+ Tests: 1 passed, 1 total
146
+ Snapshots: 0 total
147
+ Time: 0.959 s, estimated 1 s
148
+ ```
@@ -0,0 +1,112 @@
1
+ # Playwright
2
+
3
+ Playwright 是一个测试框架,它允许你使用单一的 API,自动的在 Chromium、Firefox 和 WebKit 环境中运行测试用例,你可以使用它来**编写 E2E 测试**。
4
+
5
+ 在 Modern.js 中使用 Playwright 需要先安装依赖,可以执行以下命令:
6
+
7
+ import { PackageManagerTabs } from '@theme';
8
+
9
+ <PackageManagerTabs command={{ npm: "npm init playwright", yarn: "yarn create playwright", pnpm: "pnpm create playwright" }} />
10
+
11
+
12
+ 上述命令会自动安装 Playwright 依赖,并通过一系列提示帮助你在项目中安装和配置,包括添加一个 `playwright.config.ts` 文件。
13
+
14
+ :::info
15
+ 参考 Playwright 官方文档,[安装 Playwright](https://playwright.dev/docs/intro#installation) 查阅更详细的指南。
16
+ :::
17
+
18
+ 按照默认配置创建后,可以在项目中看到以下文件:
19
+
20
+ ```ts title="tests/example.spec.ts"
21
+ import { test, expect } from '@playwright/test';
22
+
23
+ test('has title', async ({ page }) => {
24
+ await page.goto('https://playwright.dev/');
25
+
26
+ // Expect a title "to contain" a substring.
27
+ await expect(page).toHaveTitle(/Playwright/);
28
+ });
29
+
30
+ test('get started link', async ({ page }) => {
31
+ await page.goto('https://playwright.dev/');
32
+
33
+ // Click the get started link.
34
+ await page.getByRole('link', { name: 'Get started' }).click();
35
+
36
+ // Expects page to have a heading with the name of Installation.
37
+ await expect(
38
+ page.getByRole('heading', { name: 'Installation' }),
39
+ ).toBeVisible();
40
+ });
41
+ ```
42
+
43
+ 这是默认的测试文件,现在创建一些新的页面,并测试它们。
44
+
45
+ ## 创建 E2E 测试
46
+
47
+ 首先创建两张 Modern.js 的页面。
48
+
49
+ ```tsx title="routes/page.tsx"
50
+ import { Link } from '@modern-js/runtime/router';
51
+
52
+ const Index = () => (
53
+ <div>
54
+ <h1>Home</h1>
55
+ <Link to="/about">About</Link>
56
+ </div>
57
+ );
58
+
59
+ export default Index;
60
+ ```
61
+
62
+ ```tsx title="routes/about/page.tsx"
63
+ import { Link } from '@modern-js/runtime/router';
64
+
65
+ const Index = () => (
66
+ <div>
67
+ <h1>About</h1>
68
+ <Link to="/">Home</Link>
69
+ </div>
70
+ );
71
+
72
+ export default Index;
73
+ ```
74
+
75
+ 接下来,添加测试用例,来保证你页面的链接能够正常工作。
76
+
77
+ ```ts title="tests/example.spec.ts"
78
+ import { test, expect } from '@playwright/test'
79
+
80
+ test('should navigate to the about page', async ({ page }) => {
81
+ // Start from the index page (the baseURL is set via the webServer in the playwright.config.ts)
82
+ await page.goto('http://localhost:8080/')
83
+ // Find an element with the text 'About' and click on it
84
+ await page.click('text=About')
85
+ // The new URL should be "/about" (baseURL is used there)
86
+ await expect(page).toHaveURL('http://localhost:8080/about')
87
+ // The new page should contain an h1 with "About"
88
+ await expect(page.locator('h1')).toContainText('About')
89
+ })
90
+ ```
91
+
92
+ ## 运行测试用例
93
+
94
+ Playwright 需要你的 Modern.js 服务器保持运行。我们推荐在生产环境产物下运行你的测试用例,你可以执行 `pnpm run build` 和 `pnpm run serve` 在本地模拟生产环境。
95
+
96
+ ```bash
97
+ info Starting production server...
98
+
99
+ > Local: http://localhost:8080/
100
+ > Network: http://10.94.59.30:8080/
101
+ ```
102
+
103
+ 当项目正常构建运行后,可以在另一个终端内执行 `npx playwright test`,运行 Playwright 用例:
104
+
105
+ ```bash
106
+ Running 3 tests using 3 workers
107
+ 3 passed (2.0s)
108
+
109
+ To open last HTML report run:
110
+
111
+ npx playwright show-report
112
+ ```
@@ -0,0 +1,100 @@
1
+ # Vitest
2
+
3
+ Vitest 是由 Vite 驱动的测试框架,和 React Testing Library 配合可以用于单元测试。
4
+
5
+ 在 Modern.js 中使用 Vitest 需要先安装依赖,可以执行以下命令:
6
+
7
+ import { PackageManagerTabs } from '@theme';
8
+
9
+ <PackageManagerTabs command={{
10
+ npm: "npm install -D vitest @vitejs/plugin-react jsdom @testing-library/react @testing-library/dom",
11
+ yarn: "yarn add -D vitest @vitejs/plugin-react jsdom @testing-library/react @testing-library/dom",
12
+ pnpm: "pnpm install -D vitest @vitejs/plugin-react jsdom @testing-library/react @testing-library/dom",
13
+ bun: "bun add -D vitest @vitejs/plugin-react jsdom @testing-library/react @testing-library/dom"
14
+ }} />
15
+
16
+ 接下来,你需要创建一个 Vitest 配置文件 `vitest.config.ts`,内容如下:
17
+
18
+ ```ts title="vitest.config.ts"
19
+ import { defineConfig } from 'vitest/config'
20
+ import react from '@vitejs/plugin-react'
21
+
22
+ export default defineConfig({
23
+ plugins: [react()],
24
+ test: {
25
+ environment: 'jsdom',
26
+ },
27
+ })
28
+ ```
29
+
30
+ 更多关于 Vitest 配置的信息,可以参考 [Vitest 配置文档](https://vitest.dev/config/#configuration)。
31
+
32
+ 你可以选择性的将 `vitest` 命令添加到 `package.json` 中:
33
+
34
+ ```json title="package.json"
35
+ {
36
+ "scripts": {
37
+ "test": "vitest"
38
+ }
39
+ }
40
+ ```
41
+
42
+ 运行该命令后,Vitest 会自动监听你的文件变化,并重新运行用例。
43
+
44
+ ## 创建单元测试
45
+
46
+ 首先,创建一个简单的页面用于测试:
47
+
48
+ ```tsx title="routes/page.tsx"
49
+ import { Link } from '@modern-js/runtime/router';
50
+
51
+ const Index = () => (
52
+ <div>
53
+ <h1>Home</h1>
54
+ <Link to="/about">About</Link>
55
+ </div>
56
+ );
57
+
58
+ export default Index;
59
+ ```
60
+
61
+ 添加测试用例,检测页面中是否有预期的文本:
62
+
63
+ ```tsx title="__tests__/page.test.tsx"
64
+ import { expect, test } from 'vitest';
65
+ import { render, screen } from '@testing-library/react';
66
+ import { BrowserRouter as Router } from '@modern-js/runtime/router';
67
+ import Page from '../routes/page';
68
+
69
+ test('Page', () => {
70
+ render(
71
+ <Router>
72
+ <Page />
73
+ </Router>,
74
+ );
75
+ expect(screen.getByRole('heading', { level: 1, name: 'Home' })).toBeDefined();
76
+ });
77
+ ```
78
+
79
+ 上述用例中,我们从 `@modern-js/runtime/router` 引入了 `<Router>` 组件,这是因为 React Router 在渲染部分路由相关组件时,必须要有对应的上下文。
80
+
81
+ :::note
82
+ 直接在 Modern.js 应用中运行时,`<Router>` 组件会自动注入。
83
+ :::
84
+
85
+ ## 运行测试用例
86
+
87
+ 执行上述 `test` 命令,运行测试用例:
88
+
89
+ ```bash
90
+ ✓ src/__tests__/page.test.tsx (1)
91
+ ✓ Page
92
+
93
+ Test Files 1 passed (1)
94
+ Tests 1 passed (1)
95
+ Start at 15:37:12
96
+ Duration 999ms (transform 119ms, setup 0ms, collect 365ms, tests 33ms, environment 421ms, prepare 44ms)
97
+
98
+
99
+ PASS Waiting for file changes...
100
+ ```
@@ -82,7 +82,7 @@ import EntryMode from '@site-docs/components/entry-mode.mdx';
82
82
 
83
83
  1. 具有 `routes/` 目录。
84
84
  2. 具有 `App.[jt]sx?` 文件。
85
- 3. 具有 `entry.[jt]sx?` 文件 (需要开启 [source.enableCustomEntry](/configure/app/source/enable-custom-entry) 使用)。
85
+ 3. 具有 `entry.[jt]sx?` 文件(需要开启 [source.enableCustomEntry](/configure/app/source/enable-custom-entry) 使用)。
86
86
 
87
87
 
88
88
  当 `src/` 目录满足入口特征时,Modern.js 会认为当前应用为单入口应用。否则,Modern.js 会扫描 `src/` 下的一级目录,并进一步判断是否为入口,此时应用通常为多入口应用。
@@ -121,7 +121,8 @@ import EntryMode from '@site-docs/components/entry-mode.mdx';
121
121
  │ └── App.tsx
122
122
  ```
123
123
 
124
- 你可以在这个文件中通过代码的方式,设置客户端路由,或者不设置客户端路由。
124
+
125
+ 以 `src/App.tsx` 为约定的入口,Modern.js 不会对路由做额外的操作,开发者可以使用 [React Router 6](https://reactrouter.com/en/main) 的 API 设置客户端路由,或不设置客户端路由。例如以下代码,在应用中自行设置了客户端路由:
125
126
 
126
127
  ```tsx title="src/App.tsx"
127
128
  import { BrowserRouter, Route, Routes } from '@modern-js/runtime/router';
@@ -138,7 +139,9 @@ export default () => {
138
139
  };
139
140
  ```
140
141
 
141
- 详细内容可以参考[路由方案](/guides/basic-features/routes#自控式路由)。
142
+ :::note
143
+ 我们推荐开发者使用约定式路由,Modern.js 默认对约定式路由做了一系列资源加载及渲染上的优化,并且提供了开箱即用的 SSR 能力。而在使用自控路由时,这些能力都需要开发者自行封装。
144
+ :::
142
145
 
143
146
  #### 自定义入口
144
147
 
@@ -13,3 +13,7 @@ Modern.js 之前提供的 Monorepo 方案是基于 [pnpm Workspace](https://pnpm
13
13
  ## new 命令开启 test 能力
14
14
 
15
15
  Modern.js 之前提供的测试能力是基于 Jest 的简单封装。该封装导致 Jest 配置不直观、用户配置更加复杂等问题。在 [v2.53.0](https://github.com/web-infra-dev/modern.js/releases/tag/v2.53.0) 版本中,移除了在应用项目和模块项目中开启 test 功能的选项。推荐直接使用社区提供的测试方案。
16
+
17
+ ## Eslint 规则集
18
+
19
+ Modern.js 之前提供了 ESLint 的完整规则集,涵盖了 @modern-js(针对 Node.js 项目的 Lint 规则)和 @modern-js-app(针对前端项目的 Lint 规则)。在 [v2.60.0](https://github.com/web-infra-dev/modern.js/releases/tag/v2.60.0) 版本中,我们正式移除了这些规则集。我们鼓励开发者根据自身需求选择合适的代码规范工具,直接使用 ESLint 并结合社区推荐的规则,或使用 Biome 以提升代码格式化的性能。
@@ -58,7 +58,7 @@ export default defineConfig({
58
58
  },
59
59
  plugins: [
60
60
  appTools({
61
- bundler: 'webpack', // Set to 'experimental-rspack' to enable rspack ⚡️🦀
61
+ bundler: 'rspack', // Set to 'webpack' to enable webpack
62
62
  }),
63
63
  ],
64
64
  });
@@ -12,13 +12,13 @@ Modern.js 框架默认集成了一些社区中流行的库和开发工具。
12
12
 
13
13
  Modern.js 使用 [React 18](https://react.dev/) 来构建用户界面,同时也兼容 React 17。
14
14
 
15
- Modern.js 底层的 Rsbuild 支持构建 Vue 应用,如果你需要使用 Vue,可以参考[Rsbuild - Vue](https://rsbuild.dev/zh/guide/framework/vue3)。
15
+ Modern.js 底层的 Rsbuild 支持构建 Vue 应用,如果你需要使用 Vue,可以参考 [Rsbuild - Vue](https://rsbuild.dev/zh/guide/framework/vue3)。
16
16
 
17
17
  ## 路由
18
18
 
19
19
  Modern.js 的路由基于 [React Router 6](https://reactrouter.com/en/main),同时也兼容 React Router 5。
20
20
 
21
- Modern.js 支持约定式路由、自控式路由或其他路由方案,请参考[「路由方案」](/guides/basic-features/routes) 进行选择。
21
+ Modern.js 支持约定式路由、自控式路由或其他路由方案,请参考 [路由方案](/guides/basic-features/routes) 进行选择。
22
22
 
23
23
  ## 微前端
24
24
 
@@ -40,7 +40,7 @@ Modern.js 可以与社区中任意的包管理器搭配使用,比如 [npm](htt
40
40
 
41
41
  Modern.js 使用 [Webpack 5](https://webpack.js.org/) 或 [Rspack](https://www.rspack.dev/) 来打包你的 Web 应用。
42
42
 
43
- 默认使用的打包工具为 Webpack 5,你可以参考[「使用 Rspack](/guides/advanced-features/rspack-start) 来切换到更快的 Rspack。
43
+ 默认使用的打包工具为 Webpack 5,你可以参考 [使用 Rspack](/guides/advanced-features/rspack-start) 来切换到更快的 Rspack。
44
44
 
45
45
  ## 转译工具
46
46
 
@@ -60,24 +60,24 @@ Modern.js 使用 [Babel](https://babeljs.io/)、[SWC](https://swc.rs/) 或 [esbu
60
60
 
61
61
  Modern.js 使用 [PostCSS](https://postcss.org/) 来转换 CSS 代码,并默认开启 [autoprefixer](https://github.com/postcss/autoprefixer) 来补全 CSS 前缀。
62
62
 
63
- Modern.js 支持[「启用 Tailwind CSS](/guides/basic-features/css.html#使用-tailwind-css),并同时兼容 Tailwind CSS v2 和 v3 版本。
63
+ Modern.js 支持 [启用 Tailwind CSS](/guides/basic-features/css/tailwindcss),并同时兼容 Tailwind CSS v2 和 v3 版本。
64
64
 
65
65
  ## CSS 预处理器
66
66
 
67
67
  Modern.js 支持 [Sass](https://sass-lang.com/)、[Less](https://lesscss.org/) 和 [Stylus](https://stylus-lang.com/) 三种 CSS 预处理器:
68
68
 
69
69
  - 默认支持 Sass 和 Less,开箱即用。
70
- - 可选支持 Stylus,请参考[Stylus 插件」](https://rsbuild.dev/zh/plugins/list/plugin-stylus) 来使用。
70
+ - 可选支持 Stylus,请参考 [Stylus 插件](https://rsbuild.dev/zh/plugins/list/plugin-stylus) 来使用。
71
71
 
72
72
  ## CSS Modules
73
73
 
74
74
  Modern.js 对 [CSS Modules](https://github.com/css-modules/css-modules) 提供了开箱即用的支持,内部基于 [css-loader](https://www.npmjs.com/package/css-loader) 实现。
75
75
 
76
- 请参考[「使用 CSS Modules](/guides/basic-features/css-modules) 来使用。
76
+ 请参考 [使用 CSS Modules](/guides/basic-features/css/css-modules) 来使用。
77
77
 
78
78
  ## CSS-in-JS
79
79
 
80
- Modern.js 支持使用 [styled-components](https://styled-components.com/),请参考[「使用 CSS-in-JS](/guides/basic-features/css.html#使用-css-in-js) 来使用。
80
+ Modern.js 支持使用 [styled-components](https://styled-components.com/),请参考 [使用 CSS-in-JS](/guides/basic-features/css/css-in-js) 来使用。
81
81
 
82
82
  如果你需要使用其他 CSS-in-JS 方案,可以自行集成到你的项目中。
83
83
 
@@ -89,7 +89,7 @@ Modern.js 可以与社区中任意的 React 组件库搭配使用,比如 [MUI]
89
89
 
90
90
  ## 组件开发
91
91
 
92
- Modern.js 支持使用 [Storybook](https://storybook.js.org/) 来开发 UI 组件。该功能为可选功能,请参考[「使用 Storybook](/guides/advanced-features/using-storybook) 启用。
92
+ Modern.js 支持使用 [Storybook](https://storybook.js.org/) 来开发 UI 组件。该功能为可选功能,请参考 [使用 Storybook](/guides/basic-features/debug/using-storybook) 启用。
93
93
 
94
94
  ## Node.js 框架
95
95
 
@@ -5,12 +5,6 @@
5
5
  "label": "micro-frontend",
6
6
  "collapsed": true
7
7
  },
8
- {
9
- "type": "dir",
10
- "name": "framework-plugin",
11
- "label": "framework-plugin",
12
- "collapsed": true
13
- },
14
8
  {
15
9
  "type": "dir",
16
10
  "name": "model",
@@ -41,16 +41,6 @@ import PackageManager from '@site-docs/components/package-manager';
41
41
 
42
42
  <PackageManager />
43
43
 
44
- ### buildTools
45
-
46
- 问题:请选择构建工具
47
-
48
- 选项:
49
-
50
- - webpack -- webpack
51
-
52
- - Rspack -- rspack
53
-
54
44
  ## Npm 模块
55
45
 
56
46
  ### packageName
@@ -35,7 +35,6 @@ npx @modern-js/create@latest web-app
35
35
  ? 请选择你想创建的工程类型 Web 应用
36
36
  ? 请选择开发语言 TS
37
37
  ? 请选择包管理工具 pnpm
38
- ? 请选择构建工具 webpack
39
38
  ```
40
39
 
41
40
  ### 创建 Npm 模块项目
@@ -0,0 +1,19 @@
1
+ [
2
+ "introduction",
3
+ {
4
+ "type": "dir",
5
+ "name": "plugin-system",
6
+ "label": "plugin-system",
7
+ "collapsed": true
8
+ },
9
+ {
10
+ "type": "dir",
11
+ "name": "cli-plugins",
12
+ "label": "cli-plugins"
13
+ },
14
+ {
15
+ "type": "dir",
16
+ "name": "rsbuild-plugins",
17
+ "label": "rsbuild-plugins"
18
+ }
19
+ ]
@@ -0,0 +1 @@
1
+ ["plugin-tailwind", "plugin-bff", "plugin-ssg", "plugin-swc"]