@modern-js/main-doc 0.0.0-nightly-20240804170628 → 0.0.0-nightly-20240806170721

package/docs/en/apis/app/commands.mdx

@@ -200,7 +200,7 @@ Usage: modern inspect [options]
 
 Options:
   --env <env>           view the configuration in the target environment (default: "development")
-  --output <output>     Specify the path to output in the dist (default: "/")
+  --output <output>     Specify the path to output in the dist (default: "./")
   --verbose             Show the full function in the result
   -c --config <config>  specify the configuration file, which can be a relative or absolute path
   -h, --help            show command help

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

@@ -674,17 +674,17 @@ export const myPlugin = (): ServerPlugin => ({
 ## Runtime
 
 :::note
-The Runtime plugin is currently not fully opened, and the API is not guaranteed to be stable. Use with caution.
+Currently, the Runtime plugin is not fully open, and the API does not guarantee stability. Use with caution.
 :::
 
-The Runtime plugin is mainly used for developers to modify the component that need to be rendered.
+The Runtime plugin is mainly used by developers to add behaviors before application rendering and to modify components that need to be rendered.
 
-### `init`
+### `beforeRender`
 
-- Function: Executes `App.init`.
+- Function: Add behaviors before application rendering
 - Execution stage: Rendering (SSR/CSR).
-- Hook model: `AsyncPipeline`
-- Type: `AsyncPipeline<{ context: RuntimeContext; }, unknown>`
+- Hook model: `AsyncWorkflow`
+- Type: `AsyncWorkflow<RuntimeContext, void>`
 - Example:
 
 ```ts
@@ -693,27 +693,22 @@ import type { Plugin } from '@modern-js/runtime';
 export const myPlugin = (): Plugin => ({
   setup(api) {
     return {
-      init({ context }, next) {
+      beforeRender(context) {
         // do something
-        return next({ context });
       },
     };
   },
 });
 ```
 
-### `hoc`
+### `wrapRoot`
 
-- Function: Modifies the components that need to be rendered.
+- Function: Modify components that need to be rendered
 - Execution stage: Rendering (SSR/CSR).
-- Hook model: `Pipeline`
-- Type: `Pipeline<{ App: React.ComponentType<any>;config: Record<string, any>; },React.ComponentType<any>>`
+- Hook model: `Waterfall`
+- Type: `Waterfall<React.ComponentType<any>>`
 - Example:
 
-:::note
-When using the hoc hook, you need to copy the static properties of the original App component to the new component and pass through the props.
-:::
-
 ```ts
 import { createContext } from 'react';
 import type { Plugin } from '@modern-js/runtime';
@@ -722,18 +717,15 @@ export const myPlugin = (): Plugin => ({
   setup(api) {
     const FooContext = createContext('');
     return {
-      hoc({ App, config }, next) {
+      wrapRoot(App) {
         const AppWrapper = (props: any) => {
           return (
-            <FooContext.Provider store={'test'}>
+            <FooContext.Provider value={'test'}>
               <App {...props} />
             </FooContext.Provider>
           );
         };
-        return next({
-          App: AppWrapper,
-          config
-        });
+        return AppWrapper;
       },
     };
   },

package/docs/zh/apis/app/commands.mdx

@@ -200,7 +200,7 @@ Usage: modern inspect [options]
 
 Options:
   --env <env>           查看指定环境下的配置 (default: "development")
-  --output <output>     指定在 dist 目录下输出的路径 (default: "/")
+  --output <output>     指定在 dist 目录下输出的路径 (default: "./")
   --verbose             在结果中展示函数的完整内容
   -c --config <config>  指定配置文件路径，可以为相对路径或绝对路径
   -h, --help            显示命令帮助

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

@@ -680,14 +680,14 @@ export const myPlugin = (): ServerPlugin => ({
 
 :::
 
-Runtime 插件主要用于开发者修改需要渲染的组件。
+Runtime 插件主要用于开发者自定义应用渲染前行为和修改需要渲染的组件。
 
-### `init`
+### `beforeRender`
 
-- 功能：执行 `App.init`
+- 功能：在应用渲染之前增加行为
 - 执行阶段：渲染（SSR/CSR）
-- Hook 模型：`AsyncPipeline`
-- 类型：`AsyncPipeline<{ context: RuntimeContext; }, unknown>`
+- Hook 模型：`AsyncWorkflow`
+- 类型：`AsyncWorkflow<RuntimeContext， void>`
 - 使用示例：
 
 ```ts
@@ -696,27 +696,22 @@ import type { Plugin } from '@modern-js/runtime';
 export const myPlugin = (): Plugin => ({
   setup(api) {
     return {
-      init({ context }, next) {
+      beforeRender(context) {
         // do something
-        return next({ context });
       },
     };
   },
 });
 ```
 
-### `hoc`
+### `wrapRoot`
 
 - 功能：修改需要渲染的组件
 - 执行阶段：渲染（SSR/CSR）
-- Hook 模型：`Pipeline`
-- 类型：`Pipeline<{ App: React.ComponentType<any>;config: Record<string, any>; },React.ComponentType<any>>`
+- Hook 模型：`Waterfall`
+- 类型：`Waterfall<React.ComponentType<any>>`
 - 使用示例：
 
-:::note
-使用 hoc 钩子时，需要把原来的 App 组件的静态属性拷贝到新的组件上，并透传 props.
-:::
-
 ```ts
 import { createContext } from 'react';
 import type { Plugin } from '@modern-js/runtime';
@@ -725,7 +720,7 @@ export const myPlugin = (): Plugin => ({
   setup(api) {
     const FooContext = createContext('');
     return {
-      hoc({ App, config }, next) {
+      wrapRoot(App) {
         const AppWrapper = (props: any) => {
           return (
             <FooContext.Provider store={'test'}>
@@ -733,10 +728,7 @@ export const myPlugin = (): Plugin => ({
             </FooContext.Provider>
           );
         };
-        return next({
-          App: AppWrapper,
-          config
-        });
+        return AppWrapper
       },
     };
   },

package/package.json

@@ -15,17 +15,17 @@
     "modern",
     "modern.js"
   ],
-  "version": "0.0.0-nightly-20240804170628",
+  "version": "0.0.0-nightly-20240806170721",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public",
     "provenance": true
   },
   "dependencies": {
-    "@modern-js/sandpack-react": "0.0.0-nightly-20240804170628"
+    "@modern-js/sandpack-react": "0.0.0-nightly-20240806170721"
   },
   "peerDependencies": {
-    "@modern-js/builder-doc": "0.0.0-nightly-20240804170628"
+    "@modern-js/builder-doc": "0.0.0-nightly-20240806170721"
   },
   "devDependencies": {
     "classnames": "^2",
@@ -39,8 +39,8 @@
     "@rspress/shared": "1.26.1",
     "@types/node": "^16",
     "@types/fs-extra": "9.0.13",
-    "@modern-js/doc-plugin-auto-sidebar": "0.0.0-nightly-20240804170628",
-    "@modern-js/builder-doc": "0.0.0-nightly-20240804170628"
+    "@modern-js/doc-plugin-auto-sidebar": "0.0.0-nightly-20240806170721",
+    "@modern-js/builder-doc": "0.0.0-nightly-20240806170721"
   },
   "scripts": {
     "dev": "rspress dev",