@modern-js/main-doc 0.0.0-next-20221227025710 → 0.0.0-next-20221227040741

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @modern-js/main-doc
 
-## 0.0.0-next-20221227025710
+## 0.0.0-next-20221227040741
 
 ### Patch Changes
 
@@ -8,6 +8,8 @@
 
   refactor: 不再支持 enableModernMode 配置项
 
+- 8f8fc35401: chore: modify plugin-garfish doc
+  chore: 修改 plugin-garfish 文档
 - 5927355ee1: feat: develop documentation directly with main-doc
   feat: 直接使用 main-doc 包开发文档
 - ebf899fb5a: feat(app-tools): support configure builder plugins
@@ -30,4 +32,4 @@
 - Updated dependencies [3fae2d03b3]
 - Updated dependencies [df41d71ade]
 - Updated dependencies [14b712da84]
-  - @modern-js/builder-doc@0.0.0-next-20221227025710
+  - @modern-js/builder-doc@0.0.0-next-20221227040741

package/package.json

@@ -11,20 +11,20 @@
     "modern",
     "modern.js"
   ],
-  "version": "0.0.0-next-20221227025710",
+  "version": "0.0.0-next-20221227040741",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
   "peerDependencies": {
-    "@modern-js/builder-doc": "0.0.0-next-20221227025710"
+    "@modern-js/builder-doc": "0.0.0-next-20221227040741"
   },
   "devDependencies": {
     "ts-node": "^10",
     "fs-extra": "^10",
     "@types/node": "^16",
     "@types/fs-extra": "^9",
-    "@modern-js/builder-doc": "0.0.0-next-20221227025710"
+    "@modern-js/builder-doc": "0.0.0-next-20221227040741"
   },
   "scripts": {
     "build": "npx ts-node ./scripts/sync.ts"

package/zh/components/micro-master-manifest-config.md

@@ -0,0 +1,15 @@
+## `manifest`
+
+```ts
+interface Manifest {
+  getAppList?: ()=> Array<AppInfo>
+}
+```
+
+#### `getAppList?`
+
+通过 `getAppList` 配置，可以自定义如何获取远程列表数据
+
+```ts
+type GetAppList = ()=> Promise<Array<AppInfo>>;
+```

package/zh/configure/app/runtime/master-app.md

@@ -13,24 +13,10 @@ sidebar_label: masterApp
 ## 示例
 
 import EnableMicroFrontend from '@site-docs/components/enable-micro-frontend.md';
+import MasterManifestAppConfig from '@site-docs/components/micro-master-manifest-config.md';
 
 <EnableMicroFrontend />
-
-## `manifest`
-
-```ts
-interface Manifest {
-  getAppList?: ()=> Array<AppInfo>
-}
-```
-
-#### `getAppList?`
-
-通过 `getAppList` 配置，可以自定义如何获取远程列表数据
-
-```ts
-type GetAppList = ()=> Promise<Array<AppInfo>>;
-```
+<MasterManifestAppConfig />
 
 
 ### apps

package/zh/guides/topic-detail/framework-plugin/implement.md

@@ -30,23 +30,11 @@ const MyPlugin = {
 };
 ```
 
-另外，在插件中，允许配置与其他插件的执行顺序。详情可以参考[插件关系](/docs/guides/topic-detail/framework-plugin/relationship)。
+另外，在插件中，允许配置与其他插件的执行顺序，详情可以参考[插件关系](/docs/guides/topic-detail/framework-plugin/relationship)。
 
 ### 插件类型
 
-Modern-js 支持多种工程开发，如应用工程(app-tools), 模块工程(module-tools)等。
-
-为了兼顾不同工程开发的差异和通性，Modern-js 将插件如下图进行组织:
-
-![plugin-relationship](https://lf3-static.bytednsdoc.com/obj/eden-cn/eeeh7uhbepxlpe/modern-website/plugin-relationship.jpg)
-
-从图可以看出，Modern-js 将插件大致分为两类:
-
-1. 通用插件: 插件只会包含一些基础的 Hooks
-
-2. 工程插件: 不同的工程开发会在通用插件的基础上扩展出自己的 Hooks, Config 等类型。
-
-使用 TypeScript 时，可以引入内置的 `CliPlugin` 等类型，为插件提供正确的类型推导。
+使用 TypeScript 时，可以引入内置的 `CliPlugin` 类型，为插件提供正确的类型推导：
 
 ```ts
 import type { CliPlugin } from '@modern-js/core';
@@ -66,56 +54,20 @@ const MyPlugin: CliPlugin = {
 };
 ```
 
-上述代码为通用插件，只包含一些基础的 Hooks。 Modern.js 支持通过泛型对插件的定义进行扩展：
-
-```ts
-import type { CliPlugin, AppTools } from '@modern-js/app-tools';
+Modern.js 导出的 `Plugin` 类型支持泛型扩展。
 
-const MyPlugin: CliPlugin<AppTools> = {
-  name: 'my-plugin',
-
-  setup() {
-    const foo = '1';
-
-    return {
-      afterBuild: () => {
-        // 在构建完成后执行逻辑
-      },
-    };
-  },
-};
-```
-
-如果仔细观察 `AppTools` 这个类型，可以发现 `AppTools` 由 3 种类型构成.
-
-```ts
-type AppTools = {
-  hooks: AppToolsHooks;
-  userConfig: AppToolsUserConfig;
-  normalizedConfig: AppToolsNormalizedConfig;
-};
-```
-
-当编写插件时，插件通过泛型扩展在不同的基础上扩展自己的 Hooks 等类型:
+在 Modern.js 中，任意插件可以注册自己的 Hook，如果想拥有其他插件注册的 Hook 的类型，可以添加泛型：
 
 ```ts
-// 通用插件上扩展
 import type { CliPlugin } from '@modern-js/core';
 import type { MyPluginHook } from 'xxx';
 
-const MyPlugin: CliPlugin<{ hooks: MyPluginHook }> = {};
-```
-
-```ts
-// 在 @modern-js/app-tools 基础上扩展
-import type { CliPlugin, AppTools } from '@modern-js/app-tools';
-import type { MyPluginHook } from 'xxx';
-
-const MyPlugin: CliPlugin<AppTools & { hooks: MyPluginHook }> = {};
+const MyPlugin: CliPlugin<MyPluginHook> = {};
 ```
 
 详细说明，请参考 [扩展 Hook](/docs/guides/topic-detail/framework-plugin/extend)。
 
+
 ### 插件配置项
 
 **建议将插件写成函数的形式**，使插件能通过函数入参来接收配置项：

package/en/docusaurus-plugin-content-docs/current/configure/app/dev/with-master-app.md

@@ -1,31 +0,0 @@
----
-sidebar_label: withMasterApp
----
-
-# dev.withMasterApp
-
-* Type: `Object`
-* Default: `null`
-
-When the project is a micro-front-end sub-application, you can use the `withMasterApp` configuration to enable the sub-application debugging mode.
-
-:::caution Caution
-When using child app debugging mode, you should first ensure that the main app has online debugging mode turned on.
-:::
-
-```js title=modern.config.js
-export default defineConfig({
-  dev: {
-    withMasterApp: {
-      //the path of the main application
-      moduleApp: 'https://www.masterApp.com',
-      //name of the subapplication
-      moduleName: 'Contact'
-    }
-  }
-})
-```
-
-- moduleApp: `string` Online address of the main application.
-- moduleName: `Contact` The name of the child app (needs to match the module name registered in the main app)。
-

package/zh/configure/app/dev/with-master-app.md

@@ -1,32 +0,0 @@
----
-sidebar_label: withMasterApp
----
-
-# dev.withMasterApp
-
-
-
-* 类型： `Object`
-* 默认值： `null`
-
-当项目为微前端子应用的时候，可以使用 `withMasterApp` 配置启用子应用调试模式。
-
-:::caution 注意
-使用子应用调试的模式时，应该先确保主应用开启了线上 debug 模式。
-:::
-
-```js title=modern.config.js
-export default defineConfig({
-  dev: {
-    withMasterApp: {
-      // 主应用的路径
-      moduleApp: 'https://www.masterApp.com',
-      // 子应用的名称
-      moduleName: 'Contact'
-    }
-  }
-})
-```
-
-- moduleApp: `string` 主应用的线上地址。
-- moduleName: `Contact` 子应用的名称（需要和在主应用中注册的模块名匹配）。