@modern-js/main-doc 2.1.0 → 2.2.0

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

@@ -0,0 +1,58 @@
+---
+sidebar_position: 5
+---
+
+# addManyFile
+
+Import in batches file. Multiple files for adding the `templates` directory.
+
+This method can be used with any file type, for file types other than binary, Handlebars render is performed when files are added.
+
+This method is available on the `onForged` time to live API parameter.
+
+Its type is defined as:
+
+```ts
+export interface AddManyFilesParams {
+  type: FileType;
+  destination: string;
+  templateFiles: string[] | (() => string[]);
+  templateBase?: string;
+  fileNameFunc?: (name: string) => string;
+  data?: Record<string, string>; // template data
+}
+export type ForgedAPI = {
+  addManyFiles: (params: AddManyFilesParams) => Promise<void>;
+  ...
+};
+```
+
+## type
+
+File type, specific viewable[File type](/guides/topic-detail/generator/plugin/api/file/introduce).
+
+## destination
+
+Create the target folder path. Since it is an import in batches file, fill in the folder path that needs to be written here.
+
+## templateFiles
+
+List of template files.
+
+This parameter supports the function parameter, as well as [globby](https://www.npmjs.com/package/globby).
+
+## templateBase
+
+Template base path.
+
+The template path is usually the template file in the same directory. If the render result needs to remove the template file prefix directory, this field can be used.
+
+Template render file content will be equal to `templateFiles - templateBase`
+
+## fileNameFunc
+
+Rename file function, where the file name of render is passed in once, and can be renamed in this function.
+
+## data
+
+Handlebars renders data.

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

@@ -0,0 +1,39 @@
+---
+sidebar_position: 1
+---
+
+# Introduction
+
+The file operation API can be used in the `onForged` time to live function, which can add, delete and change the current project file.
+
+File operation API related path to fill in the project relative path, generator plugin will automatically add the current project path prefix.
+
+## File type
+
+The generator plugin divides file types into the following categories:
+
+- Text files: plain text content files, files that can be templated using handlebars.
+
+- Binary files: pictures, audio, video and other files.
+
+:::warning
+The jsx or tsx file using the variable is a binary file, and its syntax conflicts with handlebars render, which will cause the template file failed to create.
+
+:::
+
+- 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`.
+
+The file manipulation API for the generator plugin will operate on these four file types.
+
+Its type is defined as:
+
+```ts
+export enum FileType {
+  Text = 'text',
+  Binary = 'binary',
+  Json = 'json',
+  TextRaw = 'textRaw',
+}
+```

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

@@ -0,0 +1,54 @@
+---
+sidebar_position: 6
+---
+
+# updateJSONFile
+
+Update the JSON file fields.
+
+This method is suitable for JSON file types, and can batch update field values in JSON files.
+
+This method is available on the `onForged` time to live API parameter.
+
+Its type is defined as:
+
+```ts
+export type ForgedAPI = {
+  updateJSONFile: (
+    fileName: string,
+    updateInfo: Record<string, unknown>,
+  ) => Promise<void>;
+  ...
+};
+```
+
+## fileName
+
+The filename or file path of the JSON file.
+
+## updateInfo
+
+Field update information.
+
+This information is represented in Record form.
+
+For example, the name field needs to be updated:
+
+```ts
+api.updateJSONFile(file, {
+  name: 'new name',
+});
+```
+
+Nested fields need to be updated:
+
+```ts
+api.updateJSONFile(file, {
+  'dependencies.name': 'new name',
+});
+```
+
+:::warning
+Pay attention to the field name when updating the nested field. If it is not a total volume update, the nested key should also be written into the field name.
+
+:::

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/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/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)