@modern-js/main-doc 0.0.0-next-1679563983140 → 0.0.0-next-1679666804179

package/docs/zh/configure/app/tools/jest.mdx

@@ -1,9 +1,8 @@
 ---
-title: tools.jest
-
 sidebar_label: jest
 ---
-# jest
+
+# tools.jest
 
 - **类型：** `Object | Function`
 - **默认值：** `{}`

package/docs/zh/configure/app/tools/swc.mdx

@@ -1,8 +1,8 @@
 ---
-title: tools.swc
 sidebar_label: swc
 ---
-# swc
+
+# tools.swc
 
 - **类型：** `Object`
 - **默认值：** `undefined`
@@ -13,6 +13,10 @@ sidebar_label: swc
 
 Modern.js 提供了开箱即用的 SWC 插件，可以为你的 Web 应用提供语法降级、Polyfill 以及压缩，并且移植了一些额外常见的 Babel 插件。
 
+:::tip
+在使用 Rspack 作为打包工具时，默认会使用 SWC 进行转译和压缩，因此你不需要再安装和配置 SWC 插件。
+:::
+
 ## 安装
 
 使用前需要安装 `@modern-js/plugin-swc` 插件。

package/docs/zh/guides/concept/entries.mdx

@@ -2,50 +2,52 @@
 sidebar_position: 1
 ---
 
-# 入口
+# 入口（Entry）
 
-入口是 Modern.js 默认的文件约定，项目的每一个入口是一张独立的页面，对应一条**服务端路由**。
+通过本章节，你可以了解到 Modern.js 中的入口约定，以及如何自定义入口。
 
-很多配置，如 HTML 模板、Meta 信息、是否开启 SSR、SSG、服务端路由规则都是以入口为维度划分的。
+## 什么是入口（Entry）
+
+**入口指的是一个页面的起始模块。**
+
+在 Modern.js 项目中，每一个入口对应一个独立的页面，也对应一条服务端路由。默认情况下，Modern.js 会基于目录约定来自动确定页面的入口，同时也支持通过配置项来自定义入口。
+
+Modern.js 提供的很多配置项都是以入口为维度进行划分的，比如页面标题、HTML 模板、页面 Meta 信息、是否开启 SSR/SSG、服务端路由规则等。
 
 ## 单入口与多入口
 
-Modern.js 初始化的项目是单入口的，项目结构如下：
+Modern.js 初始化的项目是单入口的（SPA），项目结构如下：
 
 ```
 .
 ├── src
-│   ├── modern-app-env.d.ts
 │   └── routes
 │       ├── index.css
 │       ├── layout.tsx
 │       └── page.tsx
 ├── package.json
 ├── modern.config.ts
-├── pnpm-lock.yaml
-├── README.md
 └── tsconfig.json
 ```
 
-Modern.js 可以很方便的将单入口切换成多入口。可以在项目下执行 `pnpm run new`，通过生成器创建入口：
+在 Modern.js 项目中，你可以很方便的将单入口切换成多入口，直接在项目下执行 `pnpm run new`，通过生成器创建入口即可：
 
 ```bash
-? 请选择你想要的操作 创建工程元素
-? 创建工程元素 新建「应用入口」
-? 请填写入口名称 new-entry
+? 请选择你想要的操作：创建工程元素
+? 创建工程元素：新建「应用入口」
+? 请填写入口名称：new-entry
 ```
 
-执行后，`src/` 目录将会变成如下结构：
+执行后，Modern.js 会自动生成一个新的入口目录，此时可以看到 `src/` 目录变成如下结构：
 
-```
+```bash
 .
-├── modern-app-env.d.ts
-├── myapp
+├── myapp    # 原入口
 │   └── routes
 │       ├── index.css
 │       ├── layout.tsx
 │       └── page.tsx
-└── new-entry
+└── new-entry # 新入口
     └── routes
         ├── index.css
         ├── layout.tsx
@@ -54,10 +56,12 @@ Modern.js 可以很方便的将单入口切换成多入口。可以在项目下
 
 原本的代码被移动到了和 `package.json` 中 `name` 同名的目录下，并创建了新的目录。
 
-执行 `pnpm run dev` 后，可以看到新增一条 `/new-entry` 的路由，并且被迁移的代码路由并未发生变化。
+执行 `pnpm run dev` 后，可以看到新增了一条名为 `/new-entry` 的路由，并且被迁移的代码路由并未发生变化。
+
+:::tip
+Modern.js 会将与 package.json 文件中 `name` 字段同名的入口作为主入口，主入口的路由为 `/`，其他入口的路由为 `/{entryName}`。
 
-:::note
-Modern.js 会将和 `package.json` 中 `name` 字段同名的入口作为主入口，默认路由为 `/`，其他入口默认路由为 `/{entryName}`。
+比如，package.json 中的 `name` 为 `myapp` 时，`src/myapp` 会作为项目的主入口。
 
 :::
 
@@ -82,7 +86,7 @@ Modern.js 会将和 `package.json` 中 `name` 字段同名的入口作为主入
 当 `src/` 目录满足入口特征时，Modern.js 会认为当前项目为单入口应用。
 
 :::tip
-单入口默认的入口名为 `main`。
+在单入口应用中，默认的入口名为 `main`。
 
 :::
 
@@ -168,35 +172,32 @@ ReactDOM.render(<App />, document.getElementById('root'));
 
 Modern.js **不推荐**使用这种方式，这种方式丧失了框架的一些能力，如 **`modern.config.js` 文件中的 `runtime` 配置将不会再生效**。但是在项目从其他框架迁移到 Modern.js，例如 CRA，或是自己手动搭建的 webpack 时，这种方式会非常有用。
 
-## 使用配置文件定义入口
+## 自定义入口
 
-有些时候，已有的项目并不是按照 Modern.js 的目录结构来搭建的。如果强行要按照这种结构来工作，会有比较大的迁移成本。
+大部分存量项目并不是按照 Modern.js 的目录结构来搭建的。如果要改成 Modern.js 约定的目录结构，会存在一定的迁移成本。
 
-在 Modern.js 中，除了使用文件约定生成入口外，还可以在 `modern.config.[jt]s` 中手动配置入口。
+在这种情况下，除了使用文件约定生成入口外，你可以在 `modern.config.[jt]s` 中手动配置入口。
 
-```ts
+```ts title="modern.config.ts"
 export default defineConfig({
   source: {
     entries: {
       // 指定一个名称为 entry_customize 的新入口
-      entry_customize: './src/home/test/index.js',
+      entry_customize: './src/home/test/index.ts',
     },
+    // 禁用默认入口扫描
+    disableDefaultEntries: true,
   },
 });
 ```
 
-:::tip
-详情可以查看 [source.entries](/configure/app/source/entries)。
-
-:::
-
-## 禁用默认入口扫描
+### 禁用默认入口扫描
 
-另外，项目的部分结构可能恰巧命中了 Modern.js 的约定，但实际上这部分并不是真实的入口。
+当使用自定义入口时，项目的部分结构可能恰巧命中了 Modern.js 的目录约定，但实际上这部分目录并不是真实的入口。
 
-Modern.js 提供了配置，来禁用默认的入口扫描。与配置的入口结合使用，大部分项目可以在不修改目录结构的情况下，快速的进行迁移。
+Modern.js 提供了 `disableDefaultEntries` 配置，来禁用默认的入口扫描规则。当你需要自定义入口时，一般需要将 `disableDefaultEntries` 与 `entries` 结合使用。这样，一些存量项目可以在不修改目录结构的情况下，快速地进行迁移。
 
-```ts
+```ts title="modern.config.ts"
 export default defineConfig({
   source: {
     disableDefaultEntries: true,
@@ -205,6 +206,6 @@ export default defineConfig({
 ```
 
 :::tip
-详情可以查看 [source.disableDefaultEntries](/configure/app/source/disable-default-entries)。
+详细用法请查看 [source.entries](/configure/app/source/entries) 和 [source.disableDefaultEntries](/configure/app/source/disable-default-entries)。
 
 :::

package/docs/zh/guides/topic-detail/framework-plugin/hook-list.mdx

@@ -191,8 +191,8 @@ foo
 
 - 功能：在退出进程前，重置一些文件状态
 - 执行阶段：进程退出之前
-- Hook 模型：AsyncWorkflow
-- 类型：`AsyncWorkflow<void, void>`
+- Hook 模型：Workflow
+- 类型：`Workflow<void, void>`
 - 使用示例：
 
 ```ts
@@ -209,6 +209,10 @@ export default (): CliPlugin => ({
 });
 ```
 
+:::tip
+由于 Node.js 中退出进程时的回调函数是同步的，所以 `beforeExit` Hook 的类型是 `Workflow`，不能执行异步操作。
+:::
+
 ### `beforeDev`
 
 - 功能：运行 dev 主流程的之前的任务

package/package.json

@@ -11,13 +11,13 @@
     "modern",
     "modern.js"
   ],
-  "version": "0.0.0-next-1679563983140",
+  "version": "0.0.0-next-1679666804179",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
   "peerDependencies": {
-    "@modern-js/builder-doc": "0.0.0-next-1679563983140"
+    "@modern-js/builder-doc": "0.0.0-next-1679666804179"
   },
   "devDependencies": {
     "classnames": "^2",
@@ -29,9 +29,9 @@
     "fs-extra": "^10",
     "@types/node": "^16",
     "@types/fs-extra": "^9",
-    "@modern-js/builder-doc": "0.0.0-next-1679563983140",
-    "@modern-js/doc-tools": "0.0.0-next-1679563983140",
-    "@modern-js/doc-plugin-auto-sidebar": "0.0.0-next-1679563983140"
+    "@modern-js/doc-tools": "0.0.0-next-1679666804179",
+    "@modern-js/doc-plugin-auto-sidebar": "0.0.0-next-1679666804179",
+    "@modern-js/builder-doc": "0.0.0-next-1679666804179"
   },
   "scripts": {
     "dev": "modern dev",