@modern-js/main-doc 2.0.3-alpha.0 → 2.2.0

package/en/guides/topic-detail/generator/plugin/api/file/updateModernConfig.mdx

@@ -0,0 +1,27 @@
+---
+sidebar_position: 8
+---
+
+# updateModernConfig
+
+Update the `modernConfig` field in `package.json`.
+
+This method is available on the `onForged` time to live API parameter.
+
+Its type is defined as:
+
+```ts
+export type ForgedAPI = {
+  updateModernConfig: (updateInfo: Record<string, any>) => Promise<void>;
+  ...
+};
+```
+
+## updateInfo
+
+Field update information.
+
+:::info
+This function is the package of updateJSONFile, which will automatically update the `modernConfig` field of `package.json`. Just fill in the update information relative to `modernConfig` in the updateInfo.
+
+:::

package/en/guides/topic-detail/generator/plugin/api/hook/afterForged.mdx

@@ -0,0 +1,35 @@
+---
+sidebar_position: 2
+---
+
+# AfterForged
+
+`afterForged` function is the generator plugin time to live function, which is usually used to define operations such as installation dependency and Git. Professional operations will be performed after the onForged function is executed.
+
+The method is available directly on the context.
+
+Its type is defined as:
+
+```ts
+export type PluginAfterForgedFunc = (
+  api: AfterForgedAPI,
+  inputData: Record<string, unknown>,
+) => Promise<void>;
+
+export interface IPluginContext {
+  afterForged: (func: PluginAfterForgedFunc) => void;
+  ...
+}
+```
+
+## func
+
+The onForged parameter is a callback function, and the function parameters are `api` and `inputData`.
+
+### api
+
+A list of supported functions in `afterForged` time to live, specifically viewabl [Git API](/guides/topic-detail/generator/plugin/api/git/isInGitRepo) 和 [NPM API](/guides/topic-detail/generator/plugin/api/npm/install).
+
+### inputData
+
+Current user input, the user can be used to obtain the current input information and configuration information.

package/en/guides/topic-detail/generator/plugin/api/hook/onForged.mdx

@@ -0,0 +1,35 @@
+---
+sidebar_position: 1
+---
+
+# OnForged
+
+`onForged` function is the generator plugin time to live function, which is usually used to define file type operations that will be performed after the completion of the base project solution file operation.
+
+The method is available directly on the context.
+
+Its type is defined as:
+
+```ts
+export type PluginForgedFunc = (
+  api: ForgedAPI,
+  inputData: Record<string, unknown>,
+) => void | Promise<void>;
+
+export interface IPluginContext {
+  onForged: (func: PluginForgedFunc) => void;
+  ...
+}
+```
+
+## func
+
+The onForged parameter is a callback function, and the function parameters are `api` and `inputData`.
+
+### api
+
+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/guides/topic-detail/generator/plugin/api/input/addInputAfter.mdx

@@ -0,0 +1,55 @@
+---
+sidebar_position: 3
+---
+
+# addInputAfter
+
+Add input question after default input.
+
+The method is available directly on the context.
+
+Its type is defined as:
+
+```ts
+export interface IPluginContext {
+  addInputAfter: (key: string, input: Schema) => void;
+  ...
+}
+```
+
+## key
+
+Modern.js the problem keyword of the configuration of the engineering solution, the specific configuration viewable [Generator Configuration](/guides/topic-detail/generator/config/common).
+
+## input
+
+Questions that need to be added, specific type definition viewable [Customize input related type definition](/guides/topic-detail/generator/plugin/api/input/type).
+
+## Example
+
+Add input after package management tool:
+
+```ts
+context.addInputAfter('packageManager', {
+  type: 'object',
+  properties: {
+    language: {
+      type: 'string',
+      title: 'Develop Language',
+      enum: [
+        { label: 'TS', value: 'ts' },
+        { label: 'ES6+', value: 'js' },
+      ],
+    },
+  },
+});
+```
+
+:::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/guides/topic-detail/generator/plugin/api/input/addInputBefore.mdx

@@ -0,0 +1,55 @@
+---
+sidebar_position: 2
+---
+
+# addInputBefore
+
+Add input question before default input.
+
+The method is available directly on the context.
+
+Its type is defined as:
+
+```ts
+export interface IPluginContext {
+  addInputBefore: (key: string, input: Schema) => void;
+  ...
+}
+```
+
+## key
+
+Modern.js the problem keyword of the configuration of the engineering solution, the specific configuration viewable [Generator Configuration](/guides/topic-detail/generator/config/common).
+
+## input
+
+Questions that need to be added, specific type definition viewable [Customize input related type definition](/guides/topic-detail/generator/plugin/api/input/type).
+
+## Example
+
+Add input before package management tool:
+
+```ts
+context.addInputBefore('packageManager', {
+  type: 'object',
+  properties: {
+    language: {
+      type: 'string',
+      title: 'Develop Langauge',
+      enum: [
+        { label: 'TS', value: 'ts' },
+        { label: 'ES6+', value: 'js' },
+      ],
+    },
+  },
+});
+```
+
+:::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/guides/topic-detail/generator/plugin/api/input/setInput.mdx

@@ -0,0 +1,43 @@
+---
+sidebar_position: 4
+---
+
+# setInput
+
+Set the problem attribute.
+
+The method is available directly on the context.
+
+Its type is defined as:
+
+```ts
+export interface IPluginContext {
+  setInput: (key: string, field: string, value: unknown) => void;
+  ...
+}
+```
+
+## key
+
+The problem keyword can be the problem keyword of the Modern.js project solution, or the keyword of the new problem in the generator plugin.
+
+## filed
+
+he problem field to be set, you can modify other fields except the key of the current Input, Input specific type definition viewable [Customize input related type definition](/guides/topic-detail/generator/plugin/api/input/type).
+
+## value
+
+The value of the problem field to be setted. value supports function, the function parameter is the current field value, and the return value needs to be the complete new field value.
+
+:::info
+For the input options provided by the Modern.js project type, only delete is temporarily supported, and increase is not supported. The increase will cause problems in the logical judgment in the code.
+
+:::
+
+## Example
+
+Modify the display name of `packageName`:
+
+```ts
+context.setInput('packageName', 'title', 'Show title');
+```

package/en/guides/topic-detail/generator/plugin/api/input/setInputValue.mdx

@@ -0,0 +1,31 @@
+---
+sidebar_position: 7
+---
+
+# setInputValue
+
+Sets the input default value.
+
+The method is available directly on the context.
+
+Its type is defined as:
+
+```ts
+export interface IPluginContext {
+    setInputValue: (value: Record<string, unknown>) => void;
+  ...
+}
+```
+
+## Example
+
+```ts
+context.setInputValue({
+  moduleRunWay: 'no',
+});
+```
+
+:::warning
+This method only supports setting the configuration parameter value corresponding to the project solution integrated by the generator plugin, and does not support setting the project solution type (solution) and project scene (scenes). These two configurations can be set by the `--config` parameter at execution default value.
+
+:::

package/en/guides/topic-detail/generator/plugin/api/input/type.mdx

@@ -0,0 +1,65 @@
+---
+sidebar_position: 1
+---
+
+# Customize input related type definition
+
+## Input
+
+Modern.js Input input type uses the open source [Formily](https://formilyjs.org/) Schema, with support for some of its Schema fields.
+
+### type
+
+schema types. Currently, the input supported by the generator plugin is of type `string`, `number` and `object`. Where `object` is used for implementation schema nested, it needs to be used in conjunction with `properties`.
+
+### name
+
+schema keyword.
+
+### title
+
+schema display name.
+
+### default
+
+schema default value.
+
+### enum
+
+If the schema is selection type, this field is used to define the option content.
+
+Each option supports two fields:
+
+- value: option value.
+
+- label: display name.
+
+### x-validate
+
+schema verification rules. Formily's verification method is supported here, for details, please refer to [Formily Validate](https://formilyjs.org/zh-CN/guide/advanced/validate).
+
+### x-reactions
+
+schema field linkage. Formily's linkage method is supported here, for details, please refer to [Formily Linkages](https://formilyjs.org/zh-CN/guide/advanced/linkages).
+
+### properties
+
+When schema type is `object`, define its subforms.
+
+## Example
+
+```ts
+const schema = {
+  type: 'object',
+  properties: {
+    language: {
+      type: 'string',
+      title: 'Develop Langauge',
+      enum: [
+        { label: 'TS', value: 'ts' },
+        { label: 'ES6+', value: 'js' },
+      ],
+    },
+  },
+};
+```

package/en/guides/topic-detail/generator/plugin/api/introduce.mdx

@@ -0,0 +1,90 @@
+---
+sidebar_position: 1
+---
+
+# Introduction
+
+Modern.js supports the customization of the provided engineering solutions by means of generator plugins or the customization of specific scenarios for engineering solutions.
+
+## Generator plugin composition
+
+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
+.
+├── README.md
+├── package.json
+├── src
+│   ├── index.ts
+│   └── modern-app-env.d.ts
+├── templates
+└── tsconfig.json
+```
+
+The `src/index.ts` is the source code directory, which is used to develop the generator plugin logic. The plugin exports a function by default, and the function parameter is `context`. Some methods are provided on the `context` to directly operate the current project. These methods will be introduced in detail later in this chapter.
+
+The `templates` directory is the template directory used to store template files that need to be used in the generator plugin.
+
+## Classification
+
+There are two types of generator plugins:
+
+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 schemes.
+
+### Type definition
+
+The classification of the generator plugin is provided by the meta information in the `package.json`.
+
+#### Extended engineering
+
+```json
+{
+  "meta": {
+    "extend": "mwa" // The three engineering is mwa, module, monorepo
+  }
+}
+```
+
+#### Create engineering scenes
+
+```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
+  }
+}
+```
+
+`key` is the scene scheme name and the value is a character string.
+`name` is the display name of the scene scheme, used for the display of the option when used, and the value is a character string.
+`type` is the project solution type. In addition to supporting three project solutions like `extend`, it also supports the customize (custom) type.
+
+### Custom type
+
+The customize type provides the implementation capability of the full custom project solution. When using this type to create a new project solution scenario, only a small amount of code for best practices at the development level is provided, such as `.gitignore`, `.editorConfig` and other files, specifically for the following directory structure:
+
+```
+.
+├── .editorconfig
+├── .gitignore
+├── .idea
+│   ├── codeStyles
+│   │   ├── Project.xml
+│   │   └── codeStyleConfig.xml
+│   ├── inspectionProfiles
+│   │   └── Project_Default.xml
+│   └── jsLinters
+│       └── eslint.xml
+├── .nvmrc
+└── .vscode
+    ├── extensions.json
+    └── settings.json
+```
+
+Customized types ensure flexible configuration according to their needs for engineering solutions.

package/en/guides/topic-detail/generator/plugin/api/new/createElement.mdx

@@ -0,0 +1,33 @@
+---
+sidebar_position: 2
+---
+
+# createElement
+
+Create engineering elements that only support application engineering solutions.
+
+This method is available on the `onForged` API parameter.
+
+Its type is defined as:
+
+```ts
+export enum ActionElement {
+  Entry = 'entry',
+  Server = 'server',
+}
+export type ForgedAPI = {
+  createElement: (
+    element: ActionElement,
+    params: Record<string, unknown>,
+  ) => Promise<void>;
+  ...
+};
+```
+
+## element
+
+Project element type, supports entry and server.
+
+## params
+
+For other parameters of creating elements, please refer to[MWA New Command](/guides/topic-detail/generator/config/mwa).

package/en/guides/topic-detail/generator/plugin/api/new/createSubProject.mdx

@@ -0,0 +1,35 @@
+---
+sidebar_position: 4
+---
+
+# createSubProject
+
+Create subprojects and only support Monorepo engineering solutions.
+
+This method is available on the `onForged` API parameter.
+
+Its type is defined as:
+
+```ts
+export enum SubSolution {
+  MWA = 'mwa',
+  MWATest = 'mwa_test',
+  Module = 'module',
+  InnerModule = 'inner_module',
+}
+export type ForgedAPI = {
+  createSubProject: (
+    solution: SubSolution,
+    params: Record<string, unknown>,
+  ) => Promise<void>;
+  ...
+};
+```
+
+## solution
+
+Sub-project engineering solution name.
+
+## params
+
+For other parameters of creating subprojects, please refer to[Monorepo Create Sub Project](/guides/topic-detail/generator/config/monorepo).

package/en/guides/topic-detail/generator/plugin/api/new/enableFunc.mdx

@@ -0,0 +1,44 @@
+---
+sidebar_position: 3
+---
+
+# enableFunc
+
+Enable functionality to support application and module engineering scenarios.
+
+This method is available on the `onForged` API parameter.
+
+Its type is defined as:
+
+```ts
+export enum ActionFunction {
+  UnBundle = 'unbundle',
+  TailwindCSS = 'tailwindcss',
+  BFF = 'bff',
+  MicroFrontend = 'micro_frontend',
+  I18n = 'i18n',
+  Test = 'test',
+  E2ETest = 'e2e_test',
+  Doc = 'doc',
+  Storybook = 'storybook',
+  RuntimeApi = 'runtimeApi',
+  SSG = 'ssg',
+  Polyfill = 'polyfill',
+  Deploy = 'deploy',
+}
+export type ForgedAPI = {
+  enableFunc: (
+    func: ActionFunction,
+    params?: Record<string, unknown> | undefined,
+  ) => Promise<void>;
+  ...
+};
+```
+
+## func
+
+The function name is passed according to the functions supported by the different engineering solutions.
+
+## params
+
+For other parameters when the function is enabled, please refer to[MWA New Command](/guides/topic-detail/generator/config/mwa)和[Module New Command](/guides/topic-detail/generator/config/module).

package/en/guides/topic-detail/generator/plugin/api/new/introduce.mdx

@@ -0,0 +1,15 @@
+---
+sidebar_position: 1
+---
+
+# Introduction
+
+The three engineering solutions provided by the Modern.js support executing the new command in the project to create elements and enable functions. In the generator plugin, the relevant API can be directly called to create some elements and enable supported functions by default.
+
+Different engineering solutions to support new operations:
+
+- [MWA](/guides/topic-detail/generator/config/mwa)
+
+- [Module](/guides/topic-detail/generator/config/module)
+
+- [Monorepo](/guides/topic-detail/generator/config/monorepo)