@modern-js/main-doc 2.0.0-beta.3 → 2.0.0-beta.5

package/zh/guides/topic-detail/micro-frontend/c03-main-app.md

@@ -0,0 +1,246 @@
+---
+sidebar_position: 3
+title: 开发主应用
+---
+
+在上一章 [体验微前端](./c02-development.md) 通过一个示例演示了如何创建和配置微前端子应用，通过本章你可以进一步了解如何开发主应用，以及它的常见配置。
+
+在通过 `@modern-js/create` 命令创建应用工程后，可以在项目中执行 `pnpm run new`（实际执行了 `modern new` 命令），在选择了「微前端」模式后，会安装微前端依赖依赖，只需手动注册插件即可。
+
+import EnableMicroFrontend from '@site-docs/components/enable-micro-frontend.md';
+
+<EnableMicroFrontend />
+
+## 注册子应用信息
+
+当在 `masterApp` 配置上提供了信息后，将会认为该应用为主应用，目前存在两种子应用信息的配置方式，这两种方式分别应用于不同的场景。
+
+
+### 直接注册子应用信息
+
+可以直接通过配置注册子应用信息：
+
+:::tip 提示
+可以通过 API [defineConfig](/docs/apis/app/runtime/app/define-config) 在运行时进行配置。
+当参数为函数时无法被序列化到产物代码，所以在涉及到函数之类的配置时请通过 defineConfig 来进行配置
+:::
+
+import MicroRuntimeConfig from '@site-docs/components/micro-runtime-config.md';
+
+<MicroRuntimeConfig />
+
+
+### 自定义远程应用列表
+
+通过该函数可以拉取远程的子应用列表，并将其注册至运行时框架：
+
+```ts title="App.tsx"
+defineConfig(App, {
+  masterApp: {
+    manifest: {
+      getAppList: async ()=> {
+        // 可以从其他远程接口获取
+        return [
+            {
+              name: 'DashBoard',
+              entry: 'http://127.0.0.1:8081/'
+            },
+            {
+              name: 'TableList',
+              entry: 'http://localhost:8082'
+            }
+        ];
+      },
+    }
+  }
+})
+```
+
+## 渲染子应用
+
+在微前端中分为两种加载子应用的方式：
+
+1. **子应用组件** 获取到每个子应用的组件，之后就可以像使用普通的 `React` 组件一样渲染微前端的子应用。
+2. **集中式路由** 通过集中式的路由配置，自动根据当前页面 `pathname` 激活渲染对应的子应用。
+
+### 子应用组件
+
+开发者使用 `useModuleApps` 方法可以获取到各个子应用的组件。
+
+再通过 `router` 组件的结合运用，开发者可以自控式的根据不同的路由渲染不同的子应用。
+
+假设我们的子应用列表配置如下：
+
+<EnableMicroFrontend />
+
+编辑主应用 `App.tsx` 文件如下：
+
+```tsx title=主应用：App.tsx
+import { useModuleApps } from '@modern-js/runtime/garfish';
+import { Route, Switch } from '@modern-js/runtime/router';
+
+function App() {
+  const { DashBoard, TableList} = useModuleApps();
+
+  return <div>
+    <Route path="/dashboard">
+      <DashBoard
+        loadable={{
+          loading: ({ pastDelay, error }: any) => {
+            if (error) {
+              return <div>error: {error?.message}</div>;
+            } else if (pastDelay) {
+              return <div>loading</div>;
+            } else {
+              return null;
+            }
+          },
+        }}
+      />
+    </Route>
+    <Route path="/table">
+      <TableList />
+    </Route>
+  </div>
+}
+```
+
+这里通过 `Route` 组件自定义了 **DashBoard** 的激活路由为 **/dashboard**， **TableList** 的激活路由为 **/table**。
+
+### 集中式路由
+
+**集中式路由** 是将子应用的激活路由集中配置的方式。我们给子应用列表信息添加 `activeWhen` 字段来启用 **集中式路由**。
+
+
+<MicroRuntimeConfig />
+
+然后在主应用中使用 `useModuleApp` 方法获取 `MApp` 组件, 并在主应用渲染 `MApp`。
+
+```tsx title=主应用：App.tsx
+import { useModuleApp } from '@modern-js/plugin-runtime';
+
+function App() {
+  const { MApp } = useModuleApps();
+
+  return <div>
+    <MApp />
+  </div>
+}
+```
+
+这样启动应用后，访问 `/dashboard` 路由，会渲染 `Dashboard` 子应用，访问 `/table` 路由，会渲染 `TableList` 子应用。
+
+
+### 两种模式混用
+
+当然 **子应用组件** 和 **集中式路由** 是可以混合使用的。
+
+- 一部分子应用作为 **子应用组件** 激活，另外一部分作为 **集中式路由** 激活。
+- 一部分子应用既可以作为 **集中式路由** 激活，也可以作为 **子应用组件** 激活。
+
+
+### 添加 loading
+
+通过配置 `loadable` 配置，可以为「集中式路由」、「子应用」添加 loading 组件，并可以考虑错误、超时、闪烁等情况的出现，从而为用户提供更好的用户体验。该功能的设计与实现参考至 [react-loadable](https://github.com/jamiebuilds/react-loadable)，基本功能较为相似。
+
+```tsx
+function Loading() {
+  return <div>Loading...</div>;
+}
+
+function App(){
+  return <>
+    <DashBoard
+      loadable={{
+        loading: Loading,
+      }}
+    />
+  <>
+}
+```
+
+#### 增加错误状态
+
+当微前端子应用加载失败或渲染失败时，`loading component` 将会接收 `error` 参数（若没有错误时 error 是 null）
+
+```tsx
+function Loading({ error }) {
+  if (error) {
+    return <div>Error msg {error?.message}</div>;
+  } else {
+    return <div>Loading...</div>;
+  }
+}
+```
+
+#### 避免 loading 闪退
+
+有时 loading 组件的显示时间可能小于 200ms，这个时候会出现 loading 组件闪退的情况。许多用户研究证明，loading 闪退的情况会导致用户感知加载内容的耗时比实际耗时更长，在 loading 小于 200ms 时，不展示内容，用户会认为它更快。
+
+所以 loading 组件还提供了 `pastDelay` 参数，超过设置的延迟展示时才会为 true，可以通过 `delay` 参数设置延迟的时长
+
+
+```tsx
+function Loading({ error, pastDelay }) {
+  if (error) {
+    return <div>Error! {error?.message}</div>;
+  } else if (pastDelay) {
+    return <div>Loading...</div>;
+  } else {
+    return null;
+  }
+}
+```
+
+`delay` 的默认值为 `200ms`，可以通过 `loadable` 中的 `delay` 来设置延迟展示的时间
+
+```tsx
+
+function App(){
+  return <>
+    <DashBoard
+      loadable={{
+        loading: Loading,
+        delay: 300 // 0.3 seconds
+      }}
+    />
+  <>
+}
+```
+
+#### 增加超时状态
+
+有时因为网络的原因，从而导致微前端子应用加载失败，从而导致一直展示 loading 的状态，这对于用户而言非常糟糕，因为他们不知道合适才会获得具体的响应，他们是否需要刷新页面，通过增加超时状态可以很好的解决该问题。
+
+loading 组件在超时时会获得 `timeOut` 参数，当微前端应用加载超时时将会获得 `timeOut` 属性值为 true
+
+```tsx
+function Loading({ error, timeOut, pastDelay }) {
+  if (error) {
+    return <div>Error! {error?.message}</div>;
+  } else if (timeOut) {
+    return <div>Loading timed out, please refresh the page... </div>;
+  } else if (pastDelay) {
+    return <div>Loading...</div>;
+  } else {
+    return null;
+  }
+}
+```
+
+超时状态是关闭的，可以通过在 `loadable` 中设置 `timeout` 参数开启
+
+
+```tsx
+
+function App(){
+  return <>
+    <DashBoard
+      loadable={{
+        loading: Loading,
+        timeOut: 10000 // 10s
+      }}
+    />
+  <>
+}
+```

package/zh/guides/topic-detail/micro-frontend/c04-communicate.md

@@ -0,0 +1,54 @@
+---
+sidebar_position: 4
+title: 主子应用通信
+---
+
+## props 通信
+
+Modern.js 中，会将子应用包裹成一个 React 组件，直接通过给 React 组件传递 `props` 即可实现主应用和子应用通信的目的。
+
+```tsx title=主应用：App.tsx
+function App() {
+  const { MApp } = useModuleApps();
+
+  return <div>
+    <MApp count={100} />
+  </div>;
+}
+```
+
+```tsx title=子应用：App.tsx
+function App(props) {
+  console.log(props);
+  return ...
+}
+```
+
+子应用将会打印 `{count: 0}`，目前尚未支持子应用渲染响应式，及时在主应用上更改 `count` 的数据也不会触发视图更新
+
+## channel 通信
+
+[Garfish.channel](https://www.garfishjs.org/api/channel) 用于应用间的通信。它是 `EventEmitter2` 的实例
+
+```ts
+// 子应用监听登录事件
+const App = () => {
+  const handleLogin = (userInfo) => {
+    console.log(`${userInfo.name} has login`);
+  };
+
+  useEffect(() => {
+    window?.Garfish.channel.on('login', handleLogin);
+    return () => {
+      window?.Garfish.channel.removeListener('login', handleLogin);
+    };
+  });
+};
+
+// 主应用触发监听事件
+api.getLoginInfo.then((res) => {
+  if (res.code === 0) {
+    window.Garfish.channel.emit('login', res.data);
+  }
+});
+```

package/zh/guides/topic-detail/micro-frontend/{mixed-stack.md → c05-mixed-stack.md}

@@ -3,7 +3,7 @@ sidebar_position: 5
 title: 混合技术栈
 ---
 
-Modern.js 微前端方案是基于 [Garfish](https://garfish.top/) 封装的，提供了一些更开箱即用的使用方式。
+Modern.js 微前端方案是基于 [Garfish](https://garfishjs.org/) 封装的，提供了一些更开箱即用的使用方式。
 
 当你的主应用和子应用不全是 Modern.js 应用的时候，可以参考这片文档。
 
@@ -12,7 +12,7 @@ Modern.js 微前端方案是基于 [Garfish](https://garfish.top/) 封装的，
 
 ## 子应用是 Modern.js
 
-**Modern.js** 子应用编译后会生成标准的 [Garfish 子应用导出](https://garfish.top/quick-start#%E5%AD%90%E5%BA%94%E7%94%A8)。
+**Modern.js** 子应用编译后会生成标准的 [Garfish 子应用导出](https://www.garfishjs.org/guide/start#2%E5%AF%BC%E5%87%BA-provider-%E5%87%BD%E6%95%B0)。
 所以可以直接接入标准的微前端主应用。
 
 :::info 注
@@ -21,4 +21,4 @@ Modern.js 微前端方案是基于 [Garfish](https://garfish.top/) 封装的，
 
 ## 主应用是 Modern.js
 
-主应用是 **Modern.js**，子应用用的其它技术栈。子应用按照 [Garfish 子应用标准](https://garfish.top/quick-start#%E5%AD%90%E5%BA%94%E7%94%A8) 开发即可。
+主应用是 **Modern.js**，子应用用的其它技术栈。子应用按照 [Garfish 子应用标准](https://www.garfishjs.org/guide/demo/react) 开发即可。

package/zh/guides/topic-detail/model/quick-start.md

@@ -81,7 +81,7 @@ export default countModel;
 
 接下来，我们演示如何在组件中使用 Model。
 
-新建一个组件 Counter，在组件内通过 `useModel` API 使用 countModel：
+新建一个组件 Counter，在组件内通过 `useModel` API 使用 `countModel`：
 
 ```js
 import { useModel } from '@modern-js/runtime/model';

package/zh/guides/topic-detail/model/test-model.md

@@ -8,8 +8,8 @@ title: 测试 Model
 使用测试功能，需要先开启该功能。在项目根目录下，执行 `pnpm run new`，进行如下选择：
 
 ```bash
-? 请选择你想要的操作： 启用可选功能
-? 启用可选功能： 启用「单元测试 / 集成测试」功能
+? 请选择你想要的操作 启用可选功能
+? 启用可选功能 启用「单元测试 / 集成测试」功能
 ```
 
 即可开启测试功能支持。

package/zh/guides/topic-detail/monorepo/create-sub-project.md

@@ -57,8 +57,8 @@ pnpm run new
 [INFO] 创建成功！
 可在新项目的目录下运行以下命令：
 pnpm run dev          # 按开发环境的要求，运行和调试项目
-pnpm run build        # 按产品环境的要求，构建项目
-pnpm run start        # 按产品环境的要求，运行项目
+pnpm run build        # 按生产环境的要求，构建项目
+pnpm run serve        # 按生产环境的要求，运行项目
 pnpm run lint         # 检查和修复所有代码
 pnpm run new          # 继续创建更多项目要素，比如应用入口
 ```

package/zh/guides/topic-detail/monorepo/intro.md

@@ -2,7 +2,7 @@
 sidebar_position: 1
 ---
 
-# 简介
+# Monorepo 工程介绍
 
 Modern.js 提供了对于 Monorepo 工程方案的支持，其主要通过 `@modern-js/monorepo-tools` 来提供功能。
 

package/zh/guides/troubleshooting/dependencies.md

@@ -4,75 +4,6 @@ sidebar_position: 1
 
 # 依赖安装问题
 
-### 如何升级项目中的 Modern.js 到最新版本？
-
-对于使用 yarn 的项目，可以执行：
-
-```bash
-yarn upgrade --scope @modern-js
-```
-
-对于使用 pnpm 的项目，可以执行：
-
-```bash
-pnpm update "@modern-js/*" -r
-```
-
-如果需要了解不同版本之间的更新内容，可以查看：
-
-- Modern.js 发版日志：[Modern.js/releases](https://github.com/modern-js-dev/modern.js/releases)。
-- 各个 package 下的 `CHANGELOG.md` 文件。
-
----
-
-### 如何锁定项目中的某个依赖版本？
-
-如果需要锁定项目中的某个依赖的版本，可以通过以下方式进行操作：
-
-**yarn**
-
-对于使用 yarn 的项目，请在**项目根目录**的 `package.json` 中添加以下配置，然后重新执行 `yarn`：
-
-```json
-{
-  "resolutions": {
-    "package-name": "^1.0.0"
-  }
-}
-```
-
-**pnpm**
-
-对于使用 pnpm 的项目，请在**项目根目录**的 `package.json` 中添加以下配置，然后重新执行 `pnpm i`：
-
-```json
-{
-  "pnpm": {
-    "overrides": {
-      "package-name": "^1.0.0"
-    }
-  }
-}
-```
-
-**npm**
-
-对于使用 npm 的项目，请在**项目根目录**的 `package.json` 中添加以下配置，然后重新执行 `npm i`：
-
-```json
-{
-  "overrides": {
-    "package-name": "^1.0.0"
-  }
-}
-```
-
-:::info
-对于 monorepo 场景，只能在项目根目录的 `package.json` 中锁定依赖版本，并且会影响 monorepo 中的所有 package。
-:::
-
----
-
 ### 如何查看项目里某个依赖实际安装的版本？
 
 可以使用包管理器自带的 `ls` 命令来查看项目里依赖的版本。

package/zh/tutorials/first-app/_category_.json

@@ -1,5 +1,5 @@
 {
-  "label": "创建第一个应用",
+  "label": "联系人列表应用",
   "position": 2,
   "collapsed": false
 }

package/zh/tutorials/first-app/c01-start.md

@@ -0,0 +1,99 @@
+---
+title: 创建项目
+---
+
+从这一章节开始，我们将进入实战教程部分。在实战教程中，我们将会从环境准备开始，从简单到复杂，一步一步搭建一个真实的项目。
+
+## 环境准备
+
+import Prerequisites from '@site-docs/components/prerequisites.md'
+
+<Prerequisites />
+
+## 初始化项目
+
+我们创建新的目录，通过命令行工具初始化项目：
+
+```bash
+mkdir myapp && cd myapp
+npx @modern-js/create
+```
+
+import InitApp from '@site-docs/components/init-app.md'
+
+<InitApp />
+
+## 调试项目
+
+import DebugApp from '@site-docs/components/debug-app.md'
+
+<DebugApp />
+
+## 修改代码
+
+我们将原本的示例代码删除，替换成一个简单的联系人列表：
+
+```tsx title="src/routes/page.tsx"
+const getAvatar = (users: Array<{ name: string; email: string }>) =>
+  users.map(user => ({
+    ...user,
+    avatar: `https://avatars.dicebear.com/v2/identicon/${user.name}.svg`,
+  }));
+
+const mockData = getAvatar([
+  { name: 'Thomas', email: 'w.kccip@bllmfbgv.dm' },
+  { name: 'Chow', email: 'f.lfqljnlk@ywoefljhc.af' },
+  { name: 'Bradley', email: 'd.wfovsqyo@gpkcjwjgb.fr' },
+  { name: 'Davis', email: '"t.kqkoj@utlkwnpwk.nu' },
+]);
+
+function App() {
+  return (
+    <ul>
+      {mockData.map(({ name, avatar, email }) => (
+        <li key={name}>
+          <img src={avatar} width={60} height={60} /> ---
+          <span>{name}</span> ---
+          <span>{email}</span>
+        </li>
+      ))}
+    </ul>
+  );
+}
+
+export default App;
+```
+
+删除多余的 css 文件，保持目录没有多余的文件：
+
+```bash
+rm src/routes/index.css
+```
+
+因为框架默认支持 [HMR](https://webpack.js.org/concepts/hot-module-replacement/)，可以看到 `http://localhost:8080/` 里的内容会自动更新为：
+
+![result](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvt/ljhwZthlaukjlkulzlp/screenshot-20221214-141909.png)
+
+此刻的页面还没有样式。下一章节将展开这部分的内容。
+
+## 开启 SSR
+
+接下来，我们修改项目中的 `modern.config.ts`，开启 SSR 能力：
+
+```ts
+import AppToolsPlugin, { defineConfig } from '@modern-js/app-tools';
+
+// https://modernjs.dev/docs/apis/app/config
+export default defineConfig({
+  runtime: {
+    router: true,
+    state: true,
+  },
+  server: {
+    ssr: true,
+  },
+  plugins: [AppToolsPlugin()],
+});
+```
+
+重新执行 `pnpm run dev`，可以发现项目已经在服务端完成了页面渲染。

package/zh/tutorials/first-app/{c05-component/5.1-use-ui-library.md → c02-component.md}

@@ -1,29 +1,27 @@
 ---
-title: 使用主流组件库
+title: 编写 UI 组件
 ---
 
-上一章节中，我们学习了如何使用 ES6+ 与 TypeScript 语法编写 Modern.js 应用。
+上一章节中，我们学习了如何初始化项目，并使用配置修改 Modern.js 的默认行为。
 
-这一章节中，我们继续沿用上一章节的项目代码（注意是 TS 代码，不是 ES6+ 代码），继续完善联系人列表。
+这一章节中，我们继续沿用上一章节的项目代码，继续完善联系人列表。
 
-为了做更好的 UI 展示和交互，我们引入主流的组件库 Ant Design 来开发，使用 List 组件来代替原始的列表。
-
-先添加依赖:
+为了做更好的 UI 展示和交互，我们引入组件库 [Antd](https://ant.design/index-cn) 来开发，使用 `<List>` 组件来代替原始的列表。先添加依赖：
 
 ```bash
 pnpm add antd
 ```
 
-修改 `src/routes/page.tsx`，在顶部导入组件:
+修改 `src/routes/page.tsx`，在顶部导入组件：
 
-```js
+```ts
 import { List } from 'antd';
 ```
 
-修改 Index 组件的实现：
+修改 `<App>` 组件的实现：
 
-```ts
-function Index() {
+```tsx
+function App() {
   return (
     <div>
       <List
@@ -45,7 +43,7 @@ function Index() {
 
 执行 `pnpm run dev`，查看运行结果：
 
-![result](https://lf3-static.bytednsdoc.com/obj/eden-cn/aphqeh7uhohpquloj/modern-js/docs/05/result.png)
+![result](https://lf3-static.bytednsdoc.com/obj/eden-cn/nuvjhpqnuvr/modern-website/tutorials/c02-antd-result.png)
 
 可以看到 Ant Design 导出的组件，已经具备了完整的样式。
 
@@ -53,6 +51,6 @@ function Index() {
 Modern.js 会[自动按需导入 Ant Design 组件需要的 CSS](https://github.com/ant-design/babel-plugin-import)。
 :::
 
----
-
-> 本小节的代码可以在[这里查看](https://github.com/modern-js-dev/modern-js-examples/tree/main/tutorials/c05/hello-modern)。
+:::note
+我们也可以使用其他组件库来实现同样的功能，例如 [Arco Design](https://arco.design/)。
+:::