@modern-js/main-doc 2.21.1 → 2.22.1

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

@@ -1,35 +0,0 @@
----
-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/docs/en/guides/topic-detail/generator/plugin/api/new/enableFunc.mdx

@@ -1,44 +0,0 @@
----
-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 [App New Command](/guides/topic-detail/generator/config/app) and [Module New Command](/guides/topic-detail/generator/config/module).

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

@@ -1,15 +0,0 @@
----
-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:
-
-- [Web App](/guides/topic-detail/generator/config/app)
-
-- [Module](/guides/topic-detail/generator/config/module)
-
-- [Monorepo](/guides/topic-detail/generator/config/monorepo)

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

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

package/docs/en/guides/topic-detail/generator/plugin/api/npm/install.mdx

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

package/docs/en/guides/topic-detail/generator/plugin/develop.mdx

@@ -1,125 +0,0 @@
----
-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@latest 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: Npm Module
-? Please select the scene you want to create: Generator Plugin
-? Plugin Package Name: plugin
-? Development Language: TS
-? Package Manager: pnpm
-? Plugin Type: extend
-? Plugin Base Type: Web App
-```
-
-### Customized type
-
-```
-? Plugin Package Name: plugin
-? Development Language: TS
-? Package Manager: pnpm
-? Plugin Type: custom
-? Plugin Key: mobile-app
-? Plugin Show Name: Mobile App
-? Plugin Base Type: Web App
-```
-
-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/web-infra-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](/guides/topic-detail/generator/plugin/api/introduce).
-
-### Customize input
-
-- addInputBefore
-
-Add input before the default input, such as adding questions before the `Select package manager` question.
-
-Specific Modern.js configuration viewable for each problem [Project Solution Configuration](/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](/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](/guides/topic-detail/generator/plugin/api/hook/afterForged).

package/docs/en/guides/topic-detail/generator/plugin/use.mdx

@@ -1,61 +0,0 @@
----
-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@latest --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/docs/en/guides/topic-detail/generator/project.mdx

@@ -1,118 +0,0 @@
----
-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@latest [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@latest --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 managers 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 manager:
-
-```bash
-npx @modern-js/create@latest --config '{"packageManager": "pnpm"}'
-```
-
-Specific configuration information viewable [Project Configuration](/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](/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@latest`, you can use this parameter directly.
-
-For custom microgenerators, please refer to [Develop Microgenerator](/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 manager selects pnpm) or `resolutions`.
-
-The parameter value is a JSON character string.

package/docs/zh/apis/app/hooks/api/framework/_category_.json

@@ -1,4 +0,0 @@
-{
-  "label": "Framework Mode",
-  "position": 2
-}

package/docs/zh/apis/app/hooks/api/functions/_category_.json

@@ -1,4 +0,0 @@
-{
-  "label": "Function Mode",
-  "position": 1
-}

package/docs/zh/apis/app/hooks/api/functions/app.mdx

@@ -1,12 +0,0 @@
----
-title: _app.[tj]s
-sidebar_position: 3
----
-# _app.[tj]s
-
-在函数写法下，该文件可以为 [BFF 函数](/apis/app/hooks/api/functions/api)添加前置中间件。
-
-:::note
-具体示例请参考 [hook](/apis/app/runtime/bff/hook)
-
-:::

package/docs/zh/apis/app/hooks/api/functions/common.mdx

@@ -1,9 +0,0 @@
----
-title: '**/_*.[tj]s, _*/**'
-sidebar_position: 2
----
-# **/_*.[tj]s, _*/**
-
-在 BFF 函数写法下，这些文件不会注册为路由。
-
-你可以在这种目录或文件下放任意项目中需要的代码，文件等。

package/docs/zh/guides/topic-detail/generator/codesmith/_category_.json

@@ -1,4 +0,0 @@
-{
-  "label": "开发微生成器",
-  "position": 5
-}

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

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

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

@@ -1,152 +0,0 @@
----
-sidebar_position: 1
----
-
-# @modern-js/codesmith-api-app
-
-微生成器开发过程中常用 API 的组合封装，包含 fs、git、npm 等其他包的 API 封装，在能满足需求时，推荐使用该 npm 包的 API。
-
-## 使用姿势
-
-```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，具体介绍请看[微生成器项目组成](/guides/topic-detail/generator/codesmith/structure)。
-- 调用其实例上 API 即可。
-
-## API
-
-### checkEnvironment
-
-检查当前生成器运行环境，检查项为：
-
-1. node 及 node 版本，默认大于 12.22.12，可传递参数执行 node 版本。
-2. 可使用 yarn、pnpm 或者 npm。
-
-参数：
-
-- nodeVersion?: `string` 校验的 node 版本。
-
-### runInstall
-
-安装依赖，可传入安装依赖命令，默认根据 config 中的 `packageManager` 值进行。
-
-参数：
-
-- command?: `string` 安装依赖命令。
-
-### runGitAndInstall
-
-该函数完成以下动作：
-
-1. 校验当前生成器执行目录是否为一个 git 仓库。
-2. 如果不是一个 git 仓库，初始化为一个 git 仓库。
-3. 安装依赖。
-4. 在非 monorepo 项目(判断条件，config 中 `isMonorepoSubProject` 不存在或者为 false)中提交初始 commit，commit 信息为 feat: init，支持自定义。
-
-参数：
-
-- commitMessage?: `string` 初始化 commit message 信息。
-- installFunc?: `() => Promise<void>` 安装依赖函数。
-
-### forgeTemplate
-
-渲染生成器模板文件。
-
-参数：
-
-- templatePattern: string 模板文件匹配正则，例如： `templates/base-templates/**/*` 。
-- 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。
-
-例如:
-
-```ts
-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),
-  },
-);
-```
-
-### showSuccessInfo
-
-展示成功信息。
-
-参数：
-
-- successInfo?: `string`，默认为 Success || 成功。
-
-### runSubGenerator
-
-运行子生成器。
-
-参数：
-
-- subGenerator: `string` 子生成器名称或者路径。
-- relativePwdPath?: `string` 子生成器运行的相对路径。
-- config?: `Record<string, unknown>` 子生成器运行的默认 config 配置。
-
-例如：
-
-```ts
-await appApi.runSubGenerator(
-  getGeneratorPath('@modern-js/repo-generator', context.config.distTag),
-  undefined,
-  { ...context.config, hasPlugin: false },
-);
-```
-
-### getInputBySchema
-
-通过 schema 完成用户交互输入。
-
-参数：
-
-- schema: `FormilySchema | Question[]` 问题列表，支持 Formily schema 和 inquirer 类型。
-- type: `'formily' | 'inquirer'` 类型，默认值为 formily。
-- 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 中字段的初始化值。
-
-Formily Schema 类型支持方式可参考[自定义输入相关类型定义](/guides/topic-detail/generator/plugin/api/input/type)。
-
-### getInputBySchemaFunc
-
-通过 schema 完成用户交互输入，schema 参数值为函数，用户处理国际化问题，仅支持 Formily schema。
-
-参数：
-
-- schema: `config?: Record<string, any>) => FormilySchema` 获取问题列表函数，config 参数为当前生成器中的 config 配置信息。
-- 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 中字段的初始化值。
-
-Formily Schema 类型支持方式可参考[自定义输入相关类型定义](/guides/topic-detail/generator/plugin/api/input/type)。

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

@@ -1,56 +0,0 @@
----
-sidebar_position: 6
----
-
-# @modern-js/codesmith-api-ejs
-
-微生成器中使用 [ejs](https://ejs.co/) 进行文件操作的 API 封装，提供渲染单个模板文件和文件夹的方法。
-
-## 使用姿势
-
-```ts
-import { EjsAPI } from '@modern-js/codesmith-api-ejs';
-
-export default async (context: GeneratorContext, generator: GeneratorCore) => {
-  const ejsAPI = new EjsAPI(generator);
-  await ejsAPI.renderTemplate(
-     material.get('templates/a.js'),
-     target: 'b.js',
-     { data: "data" }
-   );
-}
-```
-
-- 创建 EjsAPI 实例，参数为微生成器函数参数的 generator，具体介绍请看微生成器项目组成 。
-- 调用其实例上 API 即可。
-
-## API
-
-### renderTemplate
-
-渲染单个模板文件。
-
-参数：
-
-- templateResource: `FsResource` 模板文件资源，通过 `context.materials.get(<filename>)` 使用。
-- target: `string` 目标文件路径名称。
-- parameters?: `Record<string, string>` 渲染参数。
-
-### renderTemplateDir
-
-渲染模板文件夹。
-
-参数：
-
-- material: `FsMaterial` 当前微生成器执行的 material 上下文。
-- findGlob: `string` 模板文件匹配正则。
-- target: `(globMatch: string) => string` 目标文件路径生成函数，参数为 `resourceKey。`
-- options?: `RenderTemplateDirOptions` glob 查找文件配置，具体函数可查看这里 [glob](https://www.npmjs.com/package/glob)。
-
-```ts
-type RenderTemplateDirOptions = {
-  nodir?: boolean;
-  dot?: boolean;
-  ignore?: string | readonly string[];
-};
-```