docs: 补充注释

Author: cmtlyt

packages/core/src/plugins.ts

@@ -10,7 +10,13 @@ export * from '@zelpis/builder/plugins'
 export * from '@zelpis/render/plugins'
 
 export interface ZelpisPluginOption {
+  /**
+   * 构建插件配置
+   */
   build?: BuilderPluginOption
+  /**
+   * 渲染插件配置
+   */
   render?: RenderPluginOption
 }
 

packages/render/src/boot.ts

@@ -1,21 +1,36 @@
+import type { ReactNode } from 'react'
 import type { Root } from 'react-dom/client'
-import type { App } from 'vue'
+import type { App, Component } from 'vue'
 import { once } from '@zelpis/shared'
 
 interface BaseBootOption {
+  /**
+   * 渲染类型, 当前只支持 csr
+   */
   type?: 'csr' | 'ssr'
+  /**
+   * 框架, 当前只支持 react 和 vue
+   */
   framework: 'react' | 'vue'
-  Component: (props: any) => any
+  /**
+   * 渲染组件
+   */
+  Component: any
+  /**
+   * 挂载函数
+   */
   mount?: (app: any) => void
 }
 
 interface ReactBootOption extends BaseBootOption {
   framework: 'react'
+  Component: (props: any) => ReactNode
   mount?: (app: Root) => void
 }
 
 interface VueBootOption extends BaseBootOption {
   framework: 'vue'
+  Component: Component
   mount?: (app: App) => void
 }
 
@@ -42,7 +57,7 @@ async function createComponent(
 ): Promise<any> {
   if (framework === 'react') {
     const { createElement } = await import('react')
-    return createElement(Component, props)
+    return createElement(Component as ReactBootOption['Component'], props)
   }
   if (framework === 'vue') {
     if (option.type === 'csr') {

packages/render/src/plugins/render-plugin.ts

@@ -16,6 +16,9 @@ const APP_BODY_START_PLACEHOLDER = STANDARD_PLACEHOLDERS.APP_BODY_START
 const APP_INJECT_SCRIPT_PLACEHOLDER = STANDARD_PLACEHOLDERS.APP_INJECT_SCRIPT
 
 export interface RenderPluginOption {
+  /**
+   * 用于索引 entry 的相对路径
+   */
   baseDir?: string
 }
 

packages/shared/src/html-config/types.ts

@@ -32,25 +32,46 @@ export interface HtmlConfig {
  * 入口配置
  */
 export interface Entry {
+  /**
+   * url base path
+   */
   basePath: string
+  /**
+   * 入口文件路径
+   */
   entryPath: string
+  /**
+   * 当前入口文件对应的 DSL 文件夹路径
+   */
   dslPath?: string
+  /**
+   * 当前入口文件对应的 DSL 文件
+   */
   dslEntrys?: any[]
+  /**
+   * HTML 配置
+   */
   html?: HtmlConfig
 }
 
 /**
  * 解析 HTML 选项
  */
 export interface ResolveHtmlOptions {
-  entry: Entry
+  entry: Omit<Entry, 'dslEntrys'>
   defaultHtml?: HtmlConfig
   rootDir?: string
   ensurePlaceholders?: string[]
 }
 
 export interface ZElpisConfig {
+  /**
+   * 入口配置
+   */
   entrys: Entry[]
+  /**
+   * 默认 HTML 配置
+   */
   defaultHtml?: HtmlConfig
 }