@modern-js/main-doc 2.0.0-beta.1 → 2.0.0-beta.3

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

@@ -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
+
+```typescript
+const schema = {
+  type: 'object',
+  properties: {
+    language: {
+      type: 'string',
+      title: 'Develop Langauge',
+      enum: [
+        { label: 'TS', value: 'ts' },
+        { label: 'ES6+', value: 'js' },
+      ],
+    },
+  },
+};
+```

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

@@ -0,0 +1,91 @@
+---
+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/docusaurus-plugin-content-docs/current/guides/topic-detail/generator/plugin/api/new/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "Enable function API",
+  "position": 6
+}

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

@@ -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](/docs/guides/topic-detail/generator/config/mwa).

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

@@ -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](/docs/guides/topic-detail/generator/config/monorepo).

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

@@ -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](/docs/guides/topic-detail/generator/config/mwa)和[Module New Command](/docs/guides/topic-detail/generator/config/module).

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

@@ -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](/docs/guides/topic-detail/generator/config/mwa)
+
+- [Module](/docs/guides/topic-detail/generator/config/module)
+
+- [Monorepo](/docs/guides/topic-detail/generator/config/monorepo)

package/en/docusaurus-plugin-content-docs/current/guides/topic-detail/generator/plugin/api/npm/_category_.json

@@ -0,0 +1,4 @@
+{
+  "label": "NPM API",
+  "position": 7
+}

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

@@ -0,0 +1,18 @@
+---
+sidebar_position: 1
+---
+
+# install
+
+Install dependency in the project root directory.
+
+In the install function, the dependency will be installed using the corresponding package management tool based on the value of `packageManager`.
+
+Its type is defined as:
+
+```ts
+export type AfterForgedAPI = {
+  install: () => Promise<void>;
+  ...
+};
+```

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

@@ -0,0 +1,125 @@
+---
+sidebar_position: 3
+---
+
+# How to develop generator plugins
+
+## Create project
+
+Modern.js provides a generator plugin to create a generator plugin project, you can directly execute the following command to create:
+
+```bash
+npx @modern-js/create plugin --plugin @modern-js/generator-plugin-plugin
+```
+
+Different plugin types will ask different questions. You can choose the plugin type according to your needs.
+
+### Extension type
+
+```
+? Please select the solution you want to create Module Solution
+? Please select the scene you want to create 生成器插件
+? Plugin Package Name plugin
+? Development Language TS
+? Package Management Tool pnpm
+? Plugin Type extend
+? Plugin Base Type MWA Solution
+```
+
+### Customized type
+
+```
+? Plugin Package Name plugin
+? Development Language TS
+? Package Management Tool pnpm
+? Plugin Type custom
+? Plugin Key mobile-app
+? Plugin Show Name Mobile App
+? Plugin Base Type MWA Solution
+```
+
+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)
+:::
+
+## Develop plugin logic
+
+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
+
+- addInputBefore
+
+Add input before the default input, such as adding questions before the `Select package management tool` question.
+
+Specific Modern.js configuration viewable for each problem [Project Solution Configuration](/docs/guides/topic-detail/generator/config/common).
+
+```ts
+context.addInputBefore('input2', {
+  type: 'object',
+  properties: {
+    'input1.2': {
+      type: 'string',
+      title: 'input1.2',
+    },
+  },
+});
+```
+
+- setInput
+
+Set attributes of existing problems.
+
+```ts
+context.setInput('test', 'type', 'number')
+context.setInput('test', 'enum', [{ value: 'option1', label: '选项一' }])
+```
+
+### onForged
+
+After the implementation of the hook related operations of the project plan type file is completed, multiple extended inspection will execute its `onForged` function in sequence according to the `plugin` parameter order.
+
+The `onForged` parameter is a callback function, and the function parameters are `api` and `input`.
+
+Some file manipulation related methods are provided on the `api`, which can operate on the current template file in this hook.
+
+`input` is the current user input, which can be used to obtain the current input information and configuration information of the user.
+
+When you need a new template file, you can add it directly in the `templates` directory. In the `onForged` function, you can directly operate the `templates` directory file. For example, the `templateFile` parameter in the `addFile` below is the file in the `templates` directory. There is no need to display the declaration `templates` here, just write the relative path relative to `templates`.
+
+API functions supported in `onForged` can also be found in [Generator Plugin API](/docs/guides/topic-detail/generator/plugin/api/hook/onForged).
+
+```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,
+    });
+})
+```
+
+### afterForged
+
+After the `onForged` function is executed, it can mainly install dependencies, Git operations, etc.
+
+If your project plan is based on the three projects provided by the Modern.js, this hook function may not be required. The default project plan will automatically include the installation dependency and commit code logic.
+
+The generator plugin also supports a customized `custom` type, which only provides a small amount of development-level best practice code, such as `.gitignore`, `editorConfig` and other files. In this case, you need to manually supplement the installation dependency and Git operation logic in the `afterForged` function.
+
+The `afterForged` parameter is also a callback function, and the function parameters are `api` and `input`.
+
+The `api` will provide some npm, Git and other methods, which can install dependency and Git operations in this hook.
+
+`input` is the current user input, which can be used to obtain the current input information and configuration information of the user.
+
+The API functions supported in `afterForged` can also be found in [Generator Plugin API] (/docs/guides/topic-detail/generator/plugin/api/hook/afterForged).

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

@@ -0,0 +1,61 @@
+---
+sidebar_position: 2
+---
+
+# How to use the generator plugin
+
+`@modern-js/create` provides the `--plugin` parameter to declare the generator plugin used.
+
+You can use the generator plugin directly by executing the following command:
+
+```bash
+npx @modern-js/create --plugin <pluginName>
+```
+
+The plugin parameter supports multiple declarations, which means that multiple generator plugins are used at the same time.
+
+## 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
+    }
+}
+```
+
+### Execution timing
+
+The execution timing of different types of custom engineering solutions is different.
+
+#### Extended engineering
+
+The generator plugin of the extended engineering type will execute in sequence according to the declaration order of the plugin parameter after selecting the corresponding extended project scheme.
+
+#### Create engineering scenes
+
+The generator plugin that create engineering scenes will have the option to select the scene after selecting the project solution type. The option list includes the current default project scenes and the project scenes defined by the plugin. If you select the corresponding scene, the corresponding generator will be executed plugin.

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

@@ -0,0 +1,118 @@
+---
+sidebar_position: 2
+---
+
+# Project Generator
+
+Modern.js provides `@modern-js/create` as a project generator for Modern.js project creation.
+
+## Use
+
+There is no need to install `@modern-js/create` globally, just execute the tool directly with npx:
+
+```bash
+npx @modern-js/create [projectDir]
+```
+
+:::info
+Use npx to get the latest version of `@modern-js/create` every time.
+:::
+
+## Params
+
+### [projectDir]
+
+Project directory name.
+
+When executing the above command, the 'projectDir` folder will be created in the current directory by default, and the initialization project will be in this folder. When this parameter is empty, the initialization project will be directly generated in the current directory.
+
+### --version
+
+Get the `@modern-js/create` tool version.
+
+```bash
+$ npx @modern-js/create --version
+
+[INFO] @modern-js/create v2.0.0
+```
+
+### --lang
+
+Specifies the execution language, supports `zh` and `en`.
+
+By default, `@modern-js/create` will automatically identify the user's system language, choose to use Chinese or English, if the recognition fails or you want to specify the language manually, you can use this parameter.
+
+### -c, --config
+
+Specifies the project default configuration.
+
+By default, `@modern-js/create` will have interaction problems such as language selection and package management tools during execution. When you need to specify these configuration contents in advance, you can pass in this field.
+
+This field is a JSON character string, for example when running a package management tool:
+
+```bash
+npx @modern-js/create --config '{"packageManager": "pnpm"}'
+```
+
+Specific configuration information viewable [Project Configuration](/docs/guides/topic-detail/generator/config/common).
+
+###  --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.
+
+### --dist-tag <distTag\>
+
+Specifies the generator and Modern.js dependency versions.
+
+A smaller micro-generator will be executed during the execution of `@modern-js/create`, and the version number of the micro-generator that can be executed with this parameter and the version number of the corresponding installation Modern.js related dependencies.
+
+### --registry <registry/>
+
+Execute the npm registry to get the generator and npm packages.
+
+### --debug
+
+Displays debug log information during generator execution.
+
+### --mwa
+
+One-click to create an application engineering solution project.
+
+With this parameter, `@modern-js/create` will create the application project with the configuration default value.
+
+### --module
+
+One-click to create a module engineering solution project.
+
+With this parameter, `@modern-js/create` will create the module project with the configuration default value.
+
+### --monorepo
+
+One-click to create a Monorepo engineering solution project.
+
+With this parameter, `@modern-js/create` will create the Monorepo project with the configuration default value.
+
+### --plugin <plugin\>
+
+Specifies the generator plugin.
+
+Modern.js support the use of the generator plug-in custom Modern.js the default project type or add the project type scenes, the parameter user specifies the customized generator plugin.
+
+For custom generator plugins, please refer to [Development Generator Plugin](/docs/guides/topic-detail/generator/plugin/abstract).
+
+### --generator <generator\>
+
+Specifies the microgenerator.
+
+By default, `@modern-js/create` will execute the microgenerator Modern.js framework build-in. If you need to execute a customized microgenerator, and you need to use the posture of'npx @modern-js/create ', you can use this parameter directly.
+
+For custom microgenerators, please refer to [Develop Microgenerator](/docs/guides/topic-detail/generator/codesmith/introduce).
+
+### --packages <packages\>
+
+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.