@modern-js/main-doc 2.0.2 → 2.1.0

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

@@ -12,56 +12,55 @@ sidebar_position: 2
 先以 Pipeline 为例，简单介绍一下 Hook 模型的工作方式。先看一个简单的例子：
 
 ```ts
-import { createPipeline } from '@modern-js/plugin'
+import { createPipeline } from '@modern-js/plugin';
 
 // 1. 创建
-const pipeline = createPipeline<number, number>()
+const pipeline = createPipeline<number, number>();
 
 // 2. 添加函数
 pipeline.use((count, next) => {
-  return next(count + 1)
-})
+  return next(count + 1);
+});
 pipeline.use((count, next) => {
-  return count * 2
-})
+  return count * 2;
+});
 
 // 3. 执行
-pipeline.run(1) // 4
-pipeline.run(5) // 12
+pipeline.run(1); // 4
+pipeline.run(5); // 12
 ```
 
 在这个例子中，创建了一个 `Pipeline<number, number>` 类型的 Pipeline（L3），这意味着运行它的时候，你需要传入一个 `number`，然后你会得到一个 `number`，而这个模型管理的函数的类型是：
 
 ```ts
-(count: number, next: (nextCount: number) => number) => number
+(count: number, next: (nextCount: number) => number) => number;
 ```
 
 这里全是 `number`，是因为我们创建的是 `Pipeline<number, number>` ，如果创建的是 `Pipeline<number, string>` 则运行它入参是 `number`，返回值是 `string`，对应管理的函数的类型会是：
 
 ```ts
-(count: number, next: (nextCount: number) => string) => string
+(count: number, next: (nextCount: number) => string) => string;
 ```
 
-
 创建好 Pipeline 之后，可以通过 `use` 添加函数（L5、L8），需要注意的是，添加的顺序就是他们默认的运行顺序，在这些函数中，你可以对 `count` 进行处理、返回一个值，如果你调用了 `next` 函数，则会运行后面的函数，即如果你添加了三个函数： `A`、`B`、`C`，如果你在 `A` 中调用 `next` 那么就会运行 `B`，同样的，如果你在 `B` 中调用 `next` 那么就会运行 `C`，而在上面的例子中，添加的第一个函数（L5）就运行了 `next`，所以这里就会运行第二个函数（L8），并且运行的返回值就是 第二个函数的返回值，如果在第一个函数中没有调用 `next`，直接返回，例如：
 
 ```ts
-import { createPipeline } from '@modern-js/plugin'
+import { createPipeline } from '@modern-js/plugin';
 
 // 1. 创建
-const pipeline = createPipeline<number, number>()
+const pipeline = createPipeline<number, number>();
 
 // 2. 添加函数
 pipeline.use((count, next) => {
-  return count + 1
-})
+  return count + 1;
+});
 pipeline.use((count, next) => {
-  return count * 2
-})
+  return count * 2;
+});
 
 // 3. 执行
-pipeline.run(1) // 2
-pipeline.run(5) // 6
+pipeline.run(1); // 2
+pipeline.run(5); // 6
 ```
 
 则在运行 Pipeline 的时候就不会运行第二个函数，那么 Pipeline 的运行结果则就是第一个函数的返回值。
@@ -80,12 +79,16 @@ pipeline.run(5) // 6
 当 Pipeline 中没有函数或者所有函数都调用了 `next` 函数，则就需要在运行的时候提供：
 
 ```ts
-pipeline({}, {
+pipeline(
+  {},
+  {
     onLast: () => {
-        // do something
-    }
-})
+      // do something
+    },
+  },
+);
 ```
+
 :::
 
 ### Waterfall
@@ -93,31 +96,31 @@ pipeline({}, {
 这种模型顾名思义，他的特点就是参数的顺序递交，即前面一个函数的返回值，将会成为下一个函数的入参，我们也用一个例子来看一下：
 
 ```ts
-import { createWaterfall } from '@modern-js/plugin'
+import { createWaterfall } from '@modern-js/plugin';
 
 // 1. 创建
-const waterfall = createWaterfall<number>()
+const waterfall = createWaterfall<number>();
 
 // 2. 添加函数
-waterfall.use((count) => {
-  return count + 1
-})
-waterfall.use((count) => {
-  return count * 2
-})
+waterfall.use(count => {
+  return count + 1;
+});
+waterfall.use(count => {
+  return count * 2;
+});
 
 // 3. 执行
-waterfall.run(1) // 4
-waterfall.run(5) // 12
+waterfall.run(1); // 4
+waterfall.run(5); // 12
 ```
 
 这个例子中，创建了一个类型为 `Waterfall<number> `，即这个模型执行的入参和返回值是一样的，这个例子中都是 `number`，而它管理的函数的类型是：
 
 ```ts
-(count: number) => number
+(count: number) => number;
 ```
 
-可能简单看这个例子感觉和上面的 Pipeline 功能一样，那需要注意的是，首先这里 Waterfall 管理的函数没有next 函数作为第二个参数，所以它无法在函数内部通过调用 next 来先运行之后添加的函数，从而修改运行的顺序，其次这里的运行的入参的类型和返回值的类型必须是一样的（而 Pipeline 可以不一样）。
+可能简单看这个例子感觉和上面的 Pipeline 功能一样，那需要注意的是，首先这里 Waterfall 管理的函数没有 next 函数作为第二个参数，所以它无法在函数内部通过调用 next 来先运行之后添加的函数，从而修改运行的顺序，其次这里的运行的入参的类型和返回值的类型必须是一样的（而 Pipeline 可以不一样）。
 
 同样的，在 Waterfall 这个大类中，也提供了 Sync 和 Async 的小类，分别对应 Sync 和 Async 的函数。
 
@@ -126,22 +129,22 @@ waterfall.run(5) // 12
 这种 Hook 模型与上面两种 Hook 模型的区别是，没有那么强的前后参数返回值递交的概念，在这个模型中，每个函数都是基于同样的入参，相对独立运行的，通过一个例子简单看一下：
 
 ```ts
-import { createWorkflow } from '@modern-js/plugin'
+import { createWorkflow } from '@modern-js/plugin';
 
 // 1. 创建
-const workflow = createWorkflow <number, number>()
+const workflow = createWorkflow<number, number>();
 
 // 2. 添加函数
-workflow.use((count) => {
-  return count + 1
-})
-workflow.use((count) => {
-  return count * 2
-})
+workflow.use(count => {
+  return count + 1;
+});
+workflow.use(count => {
+  return count * 2;
+});
 
 // 3. 执行
-workflow.run(1) // [2, 2]
-workflow.run(5) // [6, 10]
+workflow.run(1); // [2, 2]
+workflow.run(5); // [6, 10]
 ```
 
 在这个例子中，添加了两个函数，所以运行的结果就是这两个函数运行的结果形成的一个数组。
@@ -153,15 +156,15 @@ workflow.run(5) // [6, 10]
 <div style={{ width: "100%", overflowX: "scroll" }}>
 <div style={{ width: "150%" }}>
 
-||函数类型|执行顺序|函数参数来源|执行返回值来源|倾向处理的任务类型|函数 TS 类型|
-|-----|-----|-----|-----|----|----|----|
-|Pipeline|Sync|默认执行第一个添加的函数，可以通过 next 调用之后添加的函数|第一个函数的参数来源是运行的参数，之后的函数的参数来源是，前一个函数向 next 函数传递的参数|第一个函数的返回值|<ul><li>需要修改初始参数</li><li>需要修改函数执行顺序</li></ul>|`(input: I, next: Next<I, O>) => O`|
-|AsyncPipeline|Sync/Async|默认执行第一个添加的函数，可以通过 next 调用之后添加的函数|第一个函数的参数来源是运行的参数，之后的函数的参数来源是，前一个函数向 next 函数传递的参数|第一个函数的返回值|<ul><li>需要修改初始参数</li><li>需要修改函数执行顺序</li></ul>|`(input: I, next: AsyncNext<I, O>) => O ｜ Promise<O>`|
-|WaterFall|Sync|一直顺序执行|第一个函数的参数来源是运行的参数，之后的函数的参数来源是，前一个函数的返回值|最后一个函数的返回值|<ul><li>需要修改初始参数</li><li>不需要修改函数执行顺序</li></ul>|`(I: I) => I`|
-|AsyncWaterFall|Sync/Async|一直顺序执行|第一个函数的参数来源是运行的参数，之后的函数的参数来源是，前一个函数的返回值|最后一个函数的返回值|<ul><li>需要修改初始参数</li><li>不需要修改函数执行顺序</li></ul>|`(I: I) => I ｜ Promise<I>`|
-|Workflow|Sync|一直顺序执行|所有函数的入参都是运行的参数|所有函数返回值形成的数组|<ul><li>不需要修改初始参数</li><li>不需要修改函数执行顺序</li></ul>|`(I: I) => O`|
-|AsyncWorkflow|Sync/Async|一直顺序执行|所有函数的入参都是运行的参数|所有函数返回值形成的数组|<ul><li>不需要修改初始参数</li><li>不需要修改函数执行顺序</li></ul>|`(I: I) => O ｜ Promise<O>`|
-|ParallelWorkFlow|Sync/Async|异步执行|所有函数的入参都是运行的参数|所有函数返回值形成的数组|<ul><li>不需要修改初始参数</li><li>不关心执行顺序</li></ul>|`(I: I) => O ｜ Promise<O>`|
+|                  | 函数类型   | 执行顺序                                                   | 函数参数来源                                                                               | 执行返回值来源           | 倾向处理的任务类型                                                  | 函数 TS 类型                                           |
+| ---------------- | ---------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------ | ------------------------------------------------------------------- | ------------------------------------------------------ |
+| Pipeline         | Sync       | 默认执行第一个添加的函数，可以通过 next 调用之后添加的函数 | 第一个函数的参数来源是运行的参数，之后的函数的参数来源是，前一个函数向 next 函数传递的参数 | 第一个函数的返回值       | <ul><li>需要修改初始参数</li><li>需要修改函数执行顺序</li></ul>     | `(input: I, next: Next<I, O>) => O`                    |
+| AsyncPipeline    | Sync/Async | 默认执行第一个添加的函数，可以通过 next 调用之后添加的函数 | 第一个函数的参数来源是运行的参数，之后的函数的参数来源是，前一个函数向 next 函数传递的参数 | 第一个函数的返回值       | <ul><li>需要修改初始参数</li><li>需要修改函数执行顺序</li></ul>     | `(input: I, next: AsyncNext<I, O>) => O ｜ Promise<O>` |
+| WaterFall        | Sync       | 一直顺序执行                                               | 第一个函数的参数来源是运行的参数，之后的函数的参数来源是，前一个函数的返回值               | 最后一个函数的返回值     | <ul><li>需要修改初始参数</li><li>不需要修改函数执行顺序</li></ul>   | `(I: I) => I`                                          |
+| AsyncWaterFall   | Sync/Async | 一直顺序执行                                               | 第一个函数的参数来源是运行的参数，之后的函数的参数来源是，前一个函数的返回值               | 最后一个函数的返回值     | <ul><li>需要修改初始参数</li><li>不需要修改函数执行顺序</li></ul>   | `(I: I) => I ｜ Promise<I>`                            |
+| Workflow         | Sync       | 一直顺序执行                                               | 所有函数的入参都是运行的参数                                                               | 所有函数返回值形成的数组 | <ul><li>不需要修改初始参数</li><li>不需要修改函数执行顺序</li></ul> | `(I: I) => O`                                          |
+| AsyncWorkflow    | Sync/Async | 一直顺序执行                                               | 所有函数的入参都是运行的参数                                                               | 所有函数返回值形成的数组 | <ul><li>不需要修改初始参数</li><li>不需要修改函数执行顺序</li></ul> | `(I: I) => O ｜ Promise<O>`                            |
+| ParallelWorkFlow | Sync/Async | 异步执行                                                   | 所有函数的入参都是运行的参数                                                               | 所有函数返回值形成的数组 | <ul><li>不需要修改初始参数</li><li>不关心执行顺序</li></ul>         | `(I: I) => O ｜ Promise<O>`                            |
 
 </div>
 </div>

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

@@ -13,7 +13,7 @@ Modern.js 插件是一个对象，对象包含以下属性：
 - `setup`: 插件初始化函数，只会执行一次。setup 函数可以返回一个 Hooks 对象，Modern.js 会在特定的时机执行这些 Hooks。
 
 ```ts
-const MyPlugin = {
+const myPlugin = {
   name: 'my-plugin',
 
   setup() {
@@ -51,7 +51,7 @@ Modern-js 支持多种工程开发，如应用工程(app-tools), 模块工程(mo
 ```ts
 import type { CliPlugin } from '@modern-js/core';
 
-const MyPlugin: CliPlugin = {
+const myPlugin: CliPlugin = {
   name: 'my-plugin',
 
   setup() {
@@ -71,7 +71,7 @@ const MyPlugin: CliPlugin = {
 ```ts
 import type { CliPlugin, AppTools } from '@modern-js/app-tools';
 
-const MyPlugin: CliPlugin<AppTools> = {
+const myPlugin: CliPlugin<AppTools> = {
   name: 'my-plugin',
 
   setup() {
@@ -103,7 +103,7 @@ type AppTools = {
 import type { CliPlugin } from '@modern-js/core';
 import type { MyPluginHook } from 'xxx';
 
-const MyPlugin: CliPlugin<{ hooks: MyPluginHook }> = {};
+const myPlugin: CliPlugin<{ hooks: MyPluginHook }> = {};
 ```
 
 ```ts
@@ -111,7 +111,7 @@ const MyPlugin: CliPlugin<{ hooks: MyPluginHook }> = {};
 import type { CliPlugin, AppTools } from '@modern-js/app-tools';
 import type { MyPluginHook } from 'xxx';
 
-const MyPlugin: CliPlugin<AppTools & { hooks: MyPluginHook }> = {};
+const myPlugin: CliPlugin<AppTools & { hooks: MyPluginHook }> = {};
 ```
 
 详细说明，请参考 [扩展 Hook](/docs/guides/topic-detail/framework-plugin/extend)。
@@ -127,7 +127,7 @@ type MyPluginOptions = {
   foo: string;
 };
 
-const MyPlugin = (options: MyPluginOptions): CliPlugin => ({
+const myPlugin = (options: MyPluginOptions): CliPlugin => ({
   name: 'my-plugin',
 
   setup() {
@@ -183,7 +183,7 @@ export default (): CliPlugin => ({
 
 本地插件推荐写在 `config/plugin` 目录下，并通过 `export default` 导出：
 
-```ts title=config/plugin/MyPlugin.ts
+```ts title=config/plugin/myPlugin.ts
 import type { CliPlugin } from '@modern-js/core';
 
 export default (): CliPlugin => ({
@@ -199,10 +199,10 @@ export default (): CliPlugin => ({
 
 ```ts title="modern.config.ts"
 import { defineConfig } from '@modern-js/app-tools';
-import MyPlugin from './config/plugin/MyPlugin';
+import myPlugin from './config/plugin/myPlugin';
 
 export default defineConfig({
-  plugins: [MyPlugin()],
+  plugins: [myPlugin()],
 });
 ```
 
@@ -237,10 +237,10 @@ export default (): CliPlugin => ({
 
 ```ts title="modern.config.ts"
 import { defineConfig } from '@modern-js/app-tools';
-import MyPlugin from 'my-plugin';
+import myPlugin from 'my-plugin';
 
 export default defineConfig({
-  plugins: [MyPlugin()],
+  plugins: [myPlugin()],
 });
 ```
 

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

@@ -29,7 +29,7 @@ export default (): CliPlugin => ({
 用于获取应用原始配置。
 
 ```ts
-const useConfigContext: () => UserConfig
+const useConfigContext: () => UserConfig;
 
 interface UserConfig {
   source?: SourceConfig;
@@ -51,7 +51,7 @@ interface UserConfig {
 用于获取应用运行上下文。
 
 ```ts
-const useAppContext: () => IAppContext
+const useAppContext: () => IAppContext;
 
 interface IAppContext {
   appDirectory: string;
@@ -79,7 +79,7 @@ interface IAppContext {
 用于获取解析之后的最终配置。
 
 ```ts
-const useResolvedConfigContext: () => NormalizedConfig
+const useResolvedConfigContext: () => NormalizedConfig;
 
 interface NormalizedConfig {
   source: NormalizedSourceConfig;
@@ -91,7 +91,7 @@ interface NormalizedConfig {
   plugins: PluginConfig;
   runtime: RuntimeConfig;
   runtimeByEntries?: RuntimeByEntriesConfig;
-  _raw: UserConfig
+  _raw: UserConfig;
 }
 ```
 

package/zh/guides/topic-detail/generator/codesmith/api/app.md

@@ -8,13 +8,13 @@ sidebar_position: 1
 
 ## 使用姿势
 
-```typescript
+```ts
 import { AppAPI } from '@modern-js/codesmith-api-app';
 
 export default async (context: GeneratorContext, generator: GeneratorCore) => {
   const appApi = new AppAPI(context, generator);
   await appApi.runInstall();
-}
+};
 ```
 
 - 创建 AppAPI 实例，参数和微生成器函数参数一致，为 context 和 generator，具体介绍请看[微生成器项目组成](/docs/guides/topic-detail/generator/codesmith/structure)。
@@ -51,6 +51,7 @@ export default async (context: GeneratorContext, generator: GeneratorCore) => {
 4. 在非 monorepo 项目(判断条件，config 中 `isMonorepoSubProject` 不存在或者为 false)中提交初始 commit，commit 信息为 feat: init，支持自定义。
 
 参数：
+
 - commitMessage?: `string` 初始化 commit message 信息。
 - installFunc?: `() => Promise<void>` 安装依赖函数。
 
@@ -64,35 +65,35 @@ export default async (context: GeneratorContext, generator: GeneratorCore) => {
 - filter?: `(resourceKey: string) => boolean` 过滤函数，参数为 templatePattern 匹配的文件路径，返回 true 表示渲染该文件，返回 false 表示不渲染该文件。
 - rename?: `(resourceKey: string) => string` 重命名函数，参数为 templatePattern 匹配的文件路径，返回新文件名。默认会替换 resourceKey 开头的 templates 目录和结尾的 .handlebars 后缀。
 - parameters?: `Record<string, any>` 渲染参数，当模板中存在 handlebars 或者 ejs 变量时，使用其传递对应变量值。
-- type?: `'handlebars' | 'ejs'`  模板文件类型，默认为 handlebars。
+- type?: `'handlebars' | 'ejs'` 模板文件类型，默认为 handlebars。
 
 例如:
 
-```typescript
+```ts
+await appApi.forgeTemplate(
+  'templates/base-templates/**/*',
+  undefined,
+  resourceKey =>
+    resourceKey
+      .replace('templates/base-templates/', '')
+      .replace('.handlebars', ''),
+);
+
 await appApi.forgeTemplate(
-    'templates/base-templates/**/*',
-    undefined,
-    resourceKey =>
-      resourceKey
-        .replace('templates/base-templates/', '')
-        .replace('.handlebars', ''),
-  );
-
- await appApi.forgeTemplate(
-    'templates/base-template/**/*',
-    resourceKey => !resourceKey.include('eslintrc.json'),
-    resourceKey =>
-      resourceKey
-        .replace('templates/base-template/', projectPath)
-        .replace('language', language as string)
-        .replace('.handlebars', ''),
-    {
-      name: packageName as string,
-      language,
-      isTs: language === Language.TS,
-      packageManager: getPackageManagerText(packageManager as any),
-    },
-  );
+  'templates/base-template/**/*',
+  resourceKey => !resourceKey.include('eslintrc.json'),
+  resourceKey =>
+    resourceKey
+      .replace('templates/base-template/', projectPath)
+      .replace('language', language as string)
+      .replace('.handlebars', ''),
+  {
+    name: packageName as string,
+    language,
+    isTs: language === Language.TS,
+    packageManager: getPackageManagerText(packageManager as any),
+  },
+);
 ```
 
 ### showSuccessInfo
@@ -115,12 +116,12 @@ await appApi.forgeTemplate(
 
 例如：
 
-```typescript
-  await appApi.runSubGenerator(
-    getGeneratorPath('@modern-js/repo-generator', context.config.distTag),
-    undefined,
-    { ...context.config, hasPlugin: false },
-  );
+```ts
+await appApi.runSubGenerator(
+  getGeneratorPath('@modern-js/repo-generator', context.config.distTag),
+  undefined,
+  { ...context.config, hasPlugin: false },
+);
 ```
 
 ### getInputBySchema
@@ -131,7 +132,7 @@ await appApi.forgeTemplate(
 
 - schema: `FormilySchema | Question[]` 问题列表，支持 Formily schema 和 inquirer 类型。
 - type: `'formily' | 'inquirer'` 类型，默认值为 formily。
-- configValue: `Record<string, unknown> = {}`  schema 默认值，传入该值的 schema 字段对应的问题将不再和用户交互。
+- configValue: `Record<string, unknown> = {}` schema 默认值，传入该值的 schema 字段对应的问题将不再和用户交互。
 - validateMap?: `Record<string, (input: unknown, data?: Record<string, unknown>) => { success: boolean; error?: string }>` schema 中特殊字段的验证函数。
 - initValue?: `Record<string, any>` schema 中字段的初始化值。
 
@@ -141,11 +142,10 @@ Formily Schema 类型支持方式可参考[自定义输入相关类型定义](/d
 
 通过 schema 完成用户交互输入，schema 参数值为函数，用户处理国际化问题，仅支持 Formily schema。
 
-
 参数：
 
 - schema: `config?: Record<string, any>) => FormilySchema` 获取问题列表函数，config 参数为当前生成器中的 config 配置信息。
-- configValue: `Record<string, unknown> = {}`  schema 默认值，传入该值的 schema 字段对应的问题将不再和用户交互。
+- configValue: `Record<string, unknown> = {}` schema 默认值，传入该值的 schema 字段对应的问题将不再和用户交互。
 - validateMap?: `Record<string, (input: unknown, data?: Record<string, unknown>) => { success: boolean; error?: string }>` schema 中特殊字段的验证函数。
 - initValue?: `Record<string, any>` schema 中字段的初始化值。
 

package/zh/guides/topic-detail/generator/codesmith/api/ejs.md

@@ -8,7 +8,7 @@ sidebar_position: 6
 
 ## 使用姿势
 
-```typescript
+```ts
 import { EjsAPI } from '@modern-js/codesmith-api-ejs';
 
 export default async (context: GeneratorContext, generator: GeneratorCore) => {
@@ -47,7 +47,7 @@ export default async (context: GeneratorContext, generator: GeneratorCore) => {
 - target: `(globMatch: string) => string` 目标文件路径生成函数，参数为 `resourceKey。`
 - options?: `RenderTemplateDirOptions` glob 查找文件配置，具体函数可查看这里 [glob](https://www.npmjs.com/package/glob)。
 
-```typescript
+```ts
 type RenderTemplateDirOptions = {
   nodir?: boolean;
   dot?: boolean;

package/zh/guides/topic-detail/generator/codesmith/api/fs.md

@@ -8,7 +8,7 @@ sidebar_position: 3
 
 ## 使用姿势
 
-```typescript
+```ts
 import { FsAPI } from '@modern-js/codesmith-api-fs';
 
 export default async (context: GeneratorContext, generator: GeneratorCore) => {
@@ -45,7 +45,7 @@ export default async (context: GeneratorContext, generator: GeneratorCore) => {
 - target: `(globMatch: string) => string` 目标文件路径生成函数，参数为 `resourceKey。`
 - options?: `RenderTemplateDirOptions` glob 查找文件配置，具体函数可查看这里 [glob](https://www.npmjs.com/package/glob)。
 
-```typescript
+```ts
 type RenderTemplateDirOptions = {
   nodir?: boolean;
   dot?: boolean;

package/zh/guides/topic-detail/generator/codesmith/api/git.md

@@ -8,13 +8,13 @@ sidebar_position: 4
 
 ## 使用姿势
 
-```typescript
+```ts
 import { GitAPI } from '@modern-js/codesmith-api-git';
 
 export default async (context: GeneratorContext, generator: GeneratorCore) => {
   const gitApi = new GitAPI(generatorCore, generatorContext);
   await gitApi.initGitRepo();
-}
+};
 ```
 
 - 创建 GitAPI 实例，参数和微生成器函数参数一致，为 context 和 generator，具体介绍请看微生成器项目组成
@@ -44,5 +44,6 @@ export default async (context: GeneratorContext, generator: GeneratorCore) => {
 执行 `git add .` 和 `git commit` 提交当前变更。
 
 参数：
+
 - commitMessage: `string` commit 信息。
 - cwd?: `string` git 命令的执行目录，默认为微生成器 `outputPath`。

package/zh/guides/topic-detail/generator/codesmith/api/handlebars.md

@@ -8,7 +8,7 @@ sidebar_position: 5
 
 ## 使用姿势
 
-```typescript
+```ts
 import { HandlebarsAPI } from '@modern-js/codesmith-api-handlebars';
 
 export default async (context: GeneratorContext, generator: GeneratorCore) => {
@@ -47,7 +47,7 @@ export default async (context: GeneratorContext, generator: GeneratorCore) => {
 - target: `(globMatch: string) => string` 目标文件路径生成函数，参数为 `resourceKey。`
 - options?: `RenderTemplateDirOptions` glob 查找文件配置，具体函数可查看这里 [glob](https://www.npmjs.com/package/glob)。
 
-```typescript
+```ts
 type RenderTemplateDirOptions = {
   nodir?: boolean;
   dot?: boolean;

package/zh/guides/topic-detail/generator/codesmith/api/json.md

@@ -8,23 +8,20 @@ sidebar_position: 2
 
 ## 使用姿势
 
-```typescript
+```ts
 import { JsonAPI } from '@modern-js/codesmith-api-json';
 
 export default async (context: GeneratorContext, generator: GeneratorCore) => {
   const jsonAPI = new JsonAPI(generator);
-  await jsonAPI.update(
-    context.materials.default.get('package.json'),
-    {
-      query: {},
-      update: {
-        $set: {
-          'dependencies.@modern-js/plugin-bff': `^2.0.0`,
-        },
+  await jsonAPI.update(context.materials.default.get('package.json'), {
+    query: {},
+    update: {
+      $set: {
+        'dependencies.@modern-js/plugin-bff': `^2.0.0`,
       },
     },
-  );
- }
+  });
+};
 ```
 
 - 创建 JsonAPI 实例，参数为微生成器函数参数的 generator，具体介绍请看[微生成器项目组成](/docs/guides/topic-detail/generator/codesmith/structure)。
@@ -37,6 +34,7 @@ export default async (context: GeneratorContext, generator: GeneratorCore) => {
 获取 JSON 文件内容。
 
 参数：
+
 - resource: `FsResource`，文件资源，通过 `context.materials.default.get(<filename>)` 获取。
 
 ### extend

package/zh/guides/topic-detail/generator/codesmith/api/npm.md

@@ -8,13 +8,13 @@ sidebar_position: 7
 
 ## 使用姿势
 
-```typescript
+```ts
 import { NpmAPI } from '@modern-js/codesmith-api-npm';
 
 export default async (context: GeneratorContext, generator: GeneratorCore) => {
   const npmApi = new NpmAPI(generator);
   await npmApi.pnpmInstall();
-}
+};
 ```
 
 - 创建 NpmAPI 实例，参数为微生成器函数参数的 generator，具体介绍请看微生成器项目组成 。
@@ -35,6 +35,7 @@ export default async (context: GeneratorContext, generator: GeneratorCore) => {
 使用 yarn 安装依赖。
 
 参数：
+
 - cwd?: `string` install 命令的执行目录，默认为微生成器 `outputPath`。
 
 ### pnpmInstall
@@ -42,4 +43,5 @@ export default async (context: GeneratorContext, generator: GeneratorCore) => {
 使用 pnpm 安装依赖。
 
 参数：
+
 - cwd?: `string` install 命令的执行目录，默认为微生成器 `outputPath`。

package/zh/guides/topic-detail/generator/codesmith/introduce.md

@@ -16,18 +16,30 @@ codesmith 还将常用的方法进行了封装，可以直接使用其提供的
 
 GeneratorCore 是 codesmith 运行生成器的核心，维护这生成器执行过程中的上下文及运行方法。
 
-```typescript
+```ts
 class GeneratorCore {
   logger: ILogger; // 日志
   materialsManager: MaterialsManager; // 资源
   outputPath: string; // 输出路径
-  output: { // 输出方法
-    fs: (file: string | number, data: any, options?: fs.WriteFileOptions | string) => Promise<void>;
+  output: {
+    // 输出方法
+    fs: (
+      file: string | number,
+      data: any,
+      options?: fs.WriteFileOptions | string,
+    ) => Promise<void>;
   };
   _context: GeneratorContext; // 上下文信息
   addMaterial(key: string, material: FsMaterial): void; // 添加资源
-  runGenerator(generator: string, config?: Record<string, unknown>): Promise<void>; // 运行生成器
-  runSubGenerator(subGenerator: string, relativePwdPath?: string, config?: Record<string, any>): Promise<void>; // 运行子生成器
+  runGenerator(
+    generator: string,
+    config?: Record<string, unknown>,
+  ): Promise<void>; // 运行生成器
+  runSubGenerator(
+    subGenerator: string,
+    relativePwdPath?: string,
+    config?: Record<string, any>,
+  ): Promise<void>; // 运行子生成器
 }
 ```
 
@@ -35,9 +47,10 @@ class GeneratorCore {
 
 微生成器资源信息，目前只包含文件资源(fsMaterials)，通过该字段可以获取到生成器执行过程中的 template 资源，并通过 API 对其进行操作。
 
-```typescript
+```ts
 class MaterialsManager {
-  materialMap: { // 资源映射关系
+  materialMap: {
+    // 资源映射关系
     [materialUri: string]: FsMaterial;
   };
   loadLocalGenerator(generator: string): Promise<FsMaterial>; // 加载本地生成器资源(绝对路径)