@modern-js/main-doc 2.0.2 → 2.1.0

package/en/docusaurus-plugin-content-docs/current/guides/topic-detail/generator/codesmith/run-in-js.md

@@ -2,7 +2,6 @@
 sidebar_position: 4
 ---
 
-
 # Execute microgenerator with JS code
 
 In addition to using the cli method to execute the micro generator, we inevitably need to execute the micro generator in the code. The following describes how to execute the micro generator in the js code.
@@ -15,17 +14,17 @@ pnpm add @modern-js/codesmith
 
 ## Create codesmith instance
 
-```typescript
+```ts
 import { CodeSmith, Logger } from '@modern-js/codesmith';
 
 const smith = new CodeSmith({
-   debug: false, //Whether to enable debug mode, if true, the debug information in the generator will be displayed
+  debug: false, //Whether to enable debug mode, if true, the debug information in the generator will be displayed
 });
 ```
 
 ## Call the forge method to execute the generator
 
-```typescript
+```ts
 type RunnerTask = Array<{
   name: string;
   config: Record<string, any>;
@@ -33,7 +32,7 @@ type RunnerTask = Array<{
 
 const task: RunnerTask = [
   {
-    name: "generator", // generator npm package name
+    name: 'generator', // generator npm package name
     config: {}, //The default configuration performed by the generator
   },
 ];

package/en/docusaurus-plugin-content-docs/current/guides/topic-detail/generator/codesmith/structure.md

@@ -14,10 +14,11 @@ NPM package description information, including name, version, main and other fie
 
 The js file corresponding to the above main field. The file exports a generator function by default, and the function format is as follows:
 
-```typescript
-export default async (context: GeneratorContext, generator: GeneratorCore) => {
-
-};
+```ts
+export default async (
+  context: GeneratorContext,
+  generator: GeneratorCore,
+) => {};
 ```
 
 The function parameters are context and generator:
@@ -26,12 +27,12 @@ The function parameters are context and generator:
 
 Context provides context information maintained by the codesmith runtime. Its type is defined as:
 
-```typescript
+```ts
 interface GeneratorContext {
   materials: Record<string, FsMaterial>;
   config: Record<string, any>;
   data?: Record<string, any>;
-  current: { material: FsMaterial; } | null;
+  current: { material: FsMaterial } | null;
   [key: string]: any;
 }
 ```
@@ -42,8 +43,10 @@ Materials also maintains this default mapping relationship, which is used to mai
 
 For example, when you need to modify a field in the `package.json` of the current project:
 
-```typescript
-const resource = context.materials.default.get(path.join(appDir, 'package.json'))
+```ts
+const resource = context.materials.default.get(
+  path.join(appDir, 'package.json'),
+);
 ```
 
 Pass the acquired resources to the JSON API provided by codesmith to implement json operations.
@@ -54,7 +57,7 @@ The get method is provided in `FsMaterial` to get the resource file and pass the
 
 For example:
 
-```typescript
+```ts
 const resourceMap = await material.find('templates/**/*');
 ```
 
@@ -64,7 +67,7 @@ All template files in the generator that match to the `templates /**/*` rules ca
 
 Generator provides the function method of the codesmith runtime. Its type is defined as:
 
-```typescript
+```ts
 interface GeneratorCore {
     logger: Logger;
     outputPath: string;
@@ -77,7 +80,6 @@ interface GeneratorCore {
 
 The outputPath and the `materials.default` in the context point to the same directory, the outputPath is used to directly calculate the target path and operate, and the `materials.default` is used to obtain resource files.
 
-
 `runSubGenerator` provides a way to run other microgenerators in one microgenerator, which will automatically update and maintain new context information.
 
 ## Template File

package/en/docusaurus-plugin-content-docs/current/guides/topic-detail/generator/config/common.md

@@ -42,7 +42,6 @@ Package management tool (packageManager), the options are as follows:
 
 - Yarn(yarn)
 
-
 :::info
 In the custom type of the generator plugin to create a project scenario, only the `packageManager` configuration is provided by default.
 :::
@@ -51,56 +50,48 @@ In the custom type of the generator plugin to create a project scenario, only th
 
 ### noNeedInstall
 
-* Type: Boolean
-
-* Default: false
+- Type: `boolean`
+- Default: `false`
 
 Whether to skip the dependency installation.
 
 ### noNeedGit
 
-* Type: Boolean
-
-* Default: false
+- Type: `boolean`
+- Default: `false`
 
 Whether to skip git initialization and commit initial commit.
 
 ### successInfo
 
-* Type: String
-
-* Default: Command operation prompts for different project schemes.
+- Type: `string`
+- Default: Command operation prompts for different project schemes.
 
 Customize prompt information to create project success.
 
 ### isMonorepoSubProject
 
-* Type: Boolean
-
-* Default: false
+- Type: `boolean`
+- Default: `false`
 
 Whether it is a Monorepo subproject.
 
 ### isTest
 
-* Type: Boolean
-
-   - true: create project to `examples/`
+- Type: `boolean`
+- Default: `false`
 
-   - false: create project to `apps/`
+Works on an Application project to identify whether it is a test project.
 
-* Default: false
-
-Works on an Application (MWA) project to identify whether it is a test project.
+- `true`: create project to `examples/`
+- `false`: create project to `apps/`
 
 ### isPublic
 
-* Type: Boolean
-
-   - true: create project to `packages/`
-
-   - false: create project to `features/`
-
-* Default: false
+- Type: `boolean`
+- Default: `false`
 
 Used in the Module project to identify whether it needs to be published to npm.
+
+- `true`: create project to `packages/`
+- `false`: create project to `features/`

package/en/docusaurus-plugin-content-docs/current/guides/topic-detail/generator/plugin/abstract.md

@@ -4,13 +4,12 @@ sidebar_position: 1
 
 # Why do you need a generator plugin
 
-Modern.js provides application (MWA), modules and Monorepo three engineering solutions, and by using the `@modern-js/create` tool can create the initial project template of the three engineering solutions, the initial project template will provide basic code development environment, simple sample code and configuration, etc.
+Modern.js provides application, modules and Monorepo three engineering solutions, and by using the `@modern-js/create` tool can create the initial project template of the three engineering solutions, the initial project template will provide basic code development environment, simple sample code and configuration, etc.
 
 Modern.js provides an initialization template that is versatile and can meet some general project development needs.
 
 When you use Modern.js in depth, you will inevitably find that every time you create a project, you will make some similar changes specific to your own project, such as modifying the sample code, adding some configuration, enabling some functions, etc.
 
-
 The generator plugin can help you precipitate these individual or team-specific changes. Simply bring the `--plugin` parameter when executing `npx @modern-js/create` to avoid the need to repeatedly modify the project every time the project is created..
 
 The generator plugin is based on the initialization template project provided by the Modern.js, providing methods to add, delete and modify templates, and modifying `package.json`, `modernConfig` configuration and opening functions in a fast way.
@@ -19,8 +18,6 @@ The generator plugin provides two ways of customization:
 
 1. Extended engineering: directly customize the three major engineering provided by default.
 
-
 2. Create engineering scenes: Create corresponding engineering scenes based on the default three major engineering.
 
-
 The next step will introduce how to use and develop the generator plugin step by step.

package/en/docusaurus-plugin-content-docs/current/guides/topic-detail/generator/plugin/api/file/introduce.md

@@ -22,7 +22,7 @@ The jsx or tsx file using the variable is a binary file, and its syntax conflict
 
 - JSON files: Files in JSON format, such as `package.json`, `tsconfig.json`.
 
-- 文Text List File: A file consisting of lines of text, such as `.gitignore`, `.editorconfig`, `.npmrc`.
+- Text List File: A file consisting of lines of text, such as `.gitignore`, `.editorconfig`, `.npmrc`.
 
 The file manipulation API for the generator plugin will operate on these four file types.
 

package/en/docusaurus-plugin-content-docs/current/guides/topic-detail/generator/plugin/api/file/updateJSONFile.md

@@ -34,19 +34,18 @@ This information is represented in Record form.
 
 For example, the name field needs to be updated:
 
-
 ```ts
 api.updateJSONFile(file, {
-    name: "new name"
-})
+  name: 'new name',
+});
 ```
 
 Nested fields need to be updated:
 
 ```ts
 api.updateJSONFile(file, {
-  "dependencies.name": "new name"
-})
+  'dependencies.name': 'new name',
+});
 ```
 
 :::warning

package/en/docusaurus-plugin-content-docs/current/guides/topic-detail/generator/plugin/api/hook/onForged.md

@@ -30,7 +30,6 @@ The onForged parameter is a callback function, and the function parameters are `
 
 A list of supported functions in `onForged` time to live, specifically viewable [File API] (/docs/guides/topic-detail/generator/plugin/api/file/introduce) and [Enable function API] (/docs/guides/topic-detail/generator/plugin/api/new/introduce).
 
-
 ### inputData
 
 Current user input, the user can be used to obtain the current input information and configuration information.

package/en/docusaurus-plugin-content-docs/current/guides/topic-detail/generator/plugin/api/input/addInputAfter.md

@@ -25,7 +25,6 @@ Modern.js the problem keyword of the configuration of the engineering solution,
 
 Questions that need to be added, specific type definition viewable [Customize input related type definition](/docs/guides/topic-detail/generator/plugin/api/input/type).
 
-
 ## Example
 
 Add input after package management tool:
@@ -43,15 +42,13 @@ context.addInputAfter('packageManager', {
       ],
     },
   },
-})
+});
 ```
 
 :::info Notes
 1. The key of the added question cannot be duplicated with the key of the question of the item type itself provided by the Modern.js.
 
-
 2. The priority of adding the problem `addInputAfter` is higher than `addInputBefore`. When adding After problem to one `key` and Before problem to the next key at the same time, After problem will be before Before.
 
-
 3. When multiple questions need to be added before or after the same `key`, the method can be called multiple times, and the order of questions will be permutated in the order in which they are called.
 :::

package/en/docusaurus-plugin-content-docs/current/guides/topic-detail/generator/plugin/api/input/addInputBefore.md

@@ -42,15 +42,13 @@ context.addInputBefore('packageManager', {
       ],
     },
   },
-})
+});
 ```
 
 :::info Notes
 1. The key of the added question cannot be duplicated with the key of the question of the item type itself provided by the Modern.js.
 
-
 2. The priority of adding the problem `addInputAfter` is higher than `addInputBefore`. When adding After problem to one `key` and Before problem to the next key at the same time, After problem will be before Before.
 
-
 3. When multiple questions need to be added before or after the same `key`, the method can be called multiple times, and the order of questions will be permutated in the order in which they are called.
 :::

package/en/docusaurus-plugin-content-docs/current/guides/topic-detail/generator/plugin/api/input/setInput.md

@@ -38,5 +38,5 @@ For the input options provided by the Modern.js project type, only delete is tem
 Modify the display name of `packageName`:
 
 ```ts
-context.setInput('packageName', 'title', "Show title");
+context.setInput('packageName', 'title', 'Show title');
 ```

package/en/docusaurus-plugin-content-docs/current/guides/topic-detail/generator/plugin/api/input/type.md

@@ -48,7 +48,7 @@ When schema type is `object`, define its subforms.
 
 ## Example
 
-```typescript
+```ts
 const schema = {
   type: 'object',
   properties: {

package/en/docusaurus-plugin-content-docs/current/guides/topic-detail/generator/plugin/api/introduce.md

@@ -10,7 +10,6 @@ Modern.js supports the customization of the provided engineering solutions by me
 
 The generator plugin is a module that can be developed directly using Modern.js module engineering solutions. Of course, Modern.js also provides the corresponding generator plugin (`@modern-js/generator-plugin-plugin`) to directly create a new generator plugin project.
 
-
 A generator plugin project directory is as follows:
 
 ```bash
@@ -44,9 +43,9 @@ The classification of the generator plugin is provided by the meta information i
 
 ```json
 {
-    "meta": {
-        "extend": "mwa" // The three engineering is mwa, module, monorepo
-    }
+  "meta": {
+    "extend": "mwa" // The three engineering is mwa, module, monorepo
+  }
 }
 ```
 
@@ -54,11 +53,11 @@ The classification of the generator plugin is provided by the meta information i
 
 ```json
 {
-    "meta": {
-        "key": "new_solution",
-        "name": "New Solution",
-        "type": "mwa" // In addition to the three major engineering solutions, the type here also supports the customize (custom) type
-    }
+  "meta": {
+    "key": "new_solution",
+    "name": "New Solution",
+    "type": "mwa" // In addition to the three major engineering solutions, the type here also supports the customize (custom) type
+  }
 }
 ```
 

package/en/docusaurus-plugin-content-docs/current/guides/topic-detail/generator/plugin/develop.md

@@ -41,7 +41,7 @@ Different plugin types will ask different questions. You can choose the plugin t
 After the execution of the create project command is completed, a project for developing the generator plugin will be generated accordingly, and the `meta` information will also be generated according to your selection in the `package.json`.
 
 :::info
-For generator plugin development, please refer to  `@modern-js/generator-plugin-plugin`. [Source Code](https://github.com/modern-js-dev/modern.js/tree/main/packages/generator/plugins/generator-plugin)
+For generator plugin development, please refer to `@modern-js/generator-plugin-plugin`. [Source Code](https://github.com/modern-js-dev/modern.js/tree/main/packages/generator/plugins/generator-plugin)
 :::
 
 ## Develop plugin logic
@@ -50,7 +50,6 @@ Complete plugin logic development in `src/index.ts`.
 
 The plugin exports a function by default, the function parameter is `context`, and some methods are provided on `context` to directly operate on the current project.
 
-
 A brief introduction to the provided methods, the complete API list viewable [Generator Plugin API](/docs/guides/topic-detail/generator/plugin/api/introduce).
 
 ### Customize input
@@ -78,8 +77,8 @@ context.addInputBefore('input2', {
 Set attributes of existing problems.
 
 ```ts
-context.setInput('test', 'type', 'number')
-context.setInput('test', 'enum', [{ value: 'option1', label: '选项一' }])
+context.setInput('test', 'type', 'number');
+context.setInput('test', 'enum', [{ value: 'option1', label: '选项一' }]);
 ```
 
 ### onForged
@@ -98,14 +97,14 @@ API functions supported in `onForged` can also be found in [Generator Plugin API
 
 ```ts
 context.onForged(async (api: ForgedAPI, input: Record<string, unknown>) => {
-    const { language } = input;
-    api.addFile({
-        type: FileType.Text,
-        file: `src/index.${language as string}`,
-        templateFile: `index.${language as string}.handlebars`,
-        force: true,
-    });
-})
+  const { language } = input;
+  api.addFile({
+    type: FileType.Text,
+    file: `src/index.${language as string}`,
+    templateFile: `index.${language as string}.handlebars`,
+    force: true,
+  });
+});
 ```
 
 ### afterForged

package/en/docusaurus-plugin-content-docs/current/guides/topic-detail/generator/plugin/use.md

@@ -30,9 +30,9 @@ The classification of the generator plugin is provided by the meta information i
 
 ```json
 {
-    "meta": {
-        "extend": "mwa" // The three engineering is mwa, module, monorepo
-    }
+  "meta": {
+    "extend": "mwa" // The three engineering is mwa, module, monorepo
+  }
 }
 ```
 
@@ -40,11 +40,11 @@ The classification of the generator plugin is provided by the meta information i
 
 ```json
 {
-    "meta": {
-        "key": "new_solution",
-        "name": "New Solution",
-        "type": "mwa" // In addition to the three major engineering solutions, the type here also supports the customize (custom) type
-    }
+  "meta": {
+    "key": "new_solution",
+    "name": "New Solution",
+    "type": "mwa" // In addition to the three major engineering solutions, the type here also supports the customize (custom) type
+  }
 }
 ```
 

package/en/docusaurus-plugin-content-docs/current/guides/topic-detail/generator/project.md

@@ -56,7 +56,7 @@ npx @modern-js/create --config '{"packageManager": "pnpm"}'
 
 Specific configuration information viewable [Project Configuration](/docs/guides/topic-detail/generator/config/common).
 
-###  --no-need-install
+### --no-need-install
 
 By default, `@modern-js/create` automatically installs dependency after the project is created, use this parameter to ignore the install dependency step.
 
@@ -114,5 +114,4 @@ A project is created by specifying a specific package version dependency.
 
 If you need to specify a specific package version when creating a project, you can use this parameter. This parameter will lock the package version number in the `package.json` of the project root directory by configuration `pnpm.overrides` (package management tool selects pnpm) or `resolutions`.
 
-
 The parameter value is a JSON character string.

package/en/docusaurus-plugin-content-docs/current/guides/topic-detail/micro-frontend/c01-introduction.md

@@ -7,8 +7,8 @@ title: 微前端介绍
 
 它主要解决了两个问题：
 
-* 随着项目迭代应用越来越庞大，难以维护。
-* 跨团队或跨部门协作开发项目导致效率低下的问题。
+- 随着项目迭代应用越来越庞大，难以维护。
+- 跨团队或跨部门协作开发项目导致效率低下的问题。
 
 ## 微前端关键词
 
@@ -19,11 +19,10 @@ title: 微前端介绍
 
 ## 功能简介
 
-* 基于 [Garfish](https://www.garfishjs.org/guide)
-* 生成器支持微前端应用
-* 支持 React 组件式引用微前端子应用
-* 支持 loading
-* 支持主应用线上、子应用线下调试模式
+- 基于 [Garfish](https://www.garfishjs.org/guide)
+- 生成器支持微前端应用
+- 支持 React 组件式引用微前端子应用
+- 支持 loading
+- 支持主应用线上、子应用线下调试模式
 
 可以在 [体验微前端](/docs/guides/topic-detail/micro-frontend/c02-development) 一节学习如何开发微前端主子应用。
-

package/en/docusaurus-plugin-content-docs/current/guides/topic-detail/micro-frontend/c02-development.md

@@ -10,7 +10,7 @@ title: 体验微前端
 
 ## 创建应用
 
-在这次的实践中，我们需要创建三个应用，分别为1个主应用，2个子应用：
+在这次的实践中，我们需要创建三个应用，分别为 1 个主应用，2 个子应用：
 
 - main 主应用
 - dashboard 子应用
@@ -46,7 +46,6 @@ import MicroRuntimeConfig from '@site-docs/components/micro-runtime-config.md';
 
 <MicroRuntimeConfig />
 
-
 ### 创建 dashboard 子应用
 
 通过命令行工具初始化项目：
@@ -66,21 +65,22 @@ npx @modern-js/create
 ? 请选择你想要的操作 启用可选功能
 ? 启用可选功能 启用「微前端」模式
 ```
+
 接下来，让我们注册微前端插件并修改 `modern.config.ts`，添加微前端子应用的配置 `deploy.microFrontend`：
 
-```javascript title="modern.config.ts"
-import AppToolPlugin, { defineConfig } from '@modern-js/app-tools';
-import GarfishPlugin from '@modern-js/plugin-garfish';
+```js title="modern.config.ts"
+import appTools, { defineConfig } from '@modern-js/app-tools';
+import garfishPlugin from '@modern-js/plugin-garfish';
 
 export default defineConfig({
   runtime: {
     router: true,
-    state: true
+    state: true,
   },
   deploy: {
-    microFrontend: true
+    microFrontend: true,
   },
-  plugins: [AppToolPlugin(), GarfishPlugin()],
+  plugins: [appTools(), garfishPlugin()],
 });
 ```
 
@@ -106,19 +106,19 @@ npx @modern-js/create
 
 接下来，让我们注册微前端插件并修改 `modern.config.ts`，添加微前端子应用的配置 `deploy.microFrontend`：
 
-```javascript title="modern.config.ts"
-import AppToolPlugin, { defineConfig } from '@modern-js/app-tools';
-import GarfishPlugin from '@modern-js/plugin-garfish';
+```js title="modern.config.ts"
+import appTools, { defineConfig } from '@modern-js/app-tools';
+import garfishPlugin from '@modern-js/plugin-garfish';
 
 export default defineConfig({
   runtime: {
     router: true,
-    state: true
+    state: true,
   },
   deploy: {
-    microFrontend: true
+    microFrontend: true,
   },
-  plugins: [AppToolPlugin(), GarfishPlugin()],
+  plugins: [appTools(), garfishPlugin()],
 });
 ```
 
@@ -137,13 +137,13 @@ const App = () => {
   return (
     <div>
       <div>
-        <Link to='/dashboard'>Dashboard</Link> &nbsp;
-        <Link to='/table'>Table</Link>
+        <Link to="/dashboard">Dashboard</Link> &nbsp;
+        <Link to="/table">Table</Link>
       </div>
-      <Route path='/dashboard'>
+      <Route path="/dashboard">
         <DashBoard />
       </Route>
-      <Route path='/table'>
+      <Route path="/table">
         <TableList />
       </Route>
     </div>
@@ -183,9 +183,6 @@ export default () => <div>Table Page</div>;
 
 在完成了微前端整体开发流程的体验后，你可以进一步了解如何 [开发主应用](./c03-main-app.md)
 
-
 ## 常见问题
 
 自查手册: https://www.garfishjs.org/issues/
-
-