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

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

@@ -0,0 +1,52 @@
+---
+sidebar_position: 4
+---
+
+# addFile
+
+Add a single file. Use to add a single template file to the `templates` directory or add to a template file directly using templates.
+
+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 AddFileParams {
+  type: FileType;
+  file: string;
+  template?: string;
+  templateFile?: string;
+  force?: boolean;
+  data?: Record<string, string>;
+}
+export type ForgedAPI = {
+  addFile: (params: AddFileParams) => Promise<void>;
+  ...
+};
+```
+
+## type
+
+File type, specific viewable[File type](/docs/guides/topic-detail/generator/plugin/api/file/introduce).
+
+## file
+
+The path to the created target file.
+
+## template
+
+File template, configuration This field value can be used directly for template render files. The priority is lower than `templateFile`.
+
+## templateFile
+
+Template file, the template file path used for rendering, its value is the relative path of `templates`.
+
+## force
+
+Whether to force coverage, when the added file already exists, an error will be reported in conflict by default. When setting this value to true, coverage can be forced.
+
+## data
+
+Handlebars renders data.

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

@@ -0,0 +1,26 @@
+---
+sidebar_position: 2
+---
+
+# addHelper
+
+For text files, add a customized Help function of Handlebars，the specific viewable document[Custom Helpers](https://handlebarsjs.com/guide/#custom-helpers).
+
+This method is available on the `onForged` time to live API parameter.
+
+Its type is defined as:
+
+```ts
+export type ForgedAPI = {
+  addHelper: (name: string, fn: Handlebars.HelperDelegate) => void;
+  ...
+};
+```
+
+## name
+
+help function name.
+
+## fn
+
+help function.

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

@@ -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](/docs/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/docusaurus-plugin-content-docs/current/guides/topic-detail/generator/plugin/api/file/addPartial.md

@@ -0,0 +1,26 @@
+---
+sidebar_position: 3
+---
+
+# addPartial
+
+For text files, add a customized Partial fragment of Handlebars, the specific viewable document [Partials](https://handlebarsjs.com/guide/#partials).
+
+This method is available on the `onForged` time to live API parameter.
+
+Its type is defined as:
+
+```ts
+export type ForgedAPI = {
+  addPartial: (name: string, str: Handlebars.Template) => void;
+  ...
+};
+```
+
+## name
+
+partial name.
+
+## str
+
+partial template string.

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

@@ -0,0 +1,38 @@
+---
+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/docusaurus-plugin-content-docs/current/guides/topic-detail/generator/plugin/api/file/rmDir.md

@@ -0,0 +1,24 @@
+---
+sidebar_position: 10
+---
+
+# rmDir
+
+Delete folder. This method deletes all files under the folder in recursion.
+
+This method can be used for any file type.
+
+This method is available on the `onForged` time to live API parameter.
+
+Its type is defined as:
+
+```ts
+export type ForgedAPI = {
+  rmDir: (dirName: string) => Promise<void>;
+  ...
+};
+```
+
+## dirName
+
+The folder name or folder path to delete.

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

@@ -0,0 +1,24 @@
+---
+sidebar_position: 9
+---
+
+# rmFile
+
+Delete the file.
+
+This method can be used for any file type.
+
+This method is available on the `onForged` time to live API parameter.
+
+Its type is defined as:
+
+```ts
+export type ForgedAPI = {
+  rmFile: (fileName: string) => Promise<void>;
+  ...
+};
+```
+
+## fileName
+
+File name or file path to delete.

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

@@ -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/docusaurus-plugin-content-docs/current/guides/topic-detail/generator/plugin/api/file/updateModernConfig.md

@@ -0,0 +1,26 @@
+---
+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/docusaurus-plugin-content-docs/current/guides/topic-detail/generator/plugin/api/file/updateTextRawFile.md

@@ -0,0 +1,33 @@
+---
+sidebar_position: 7
+---
+
+# updateTextRawFile
+
+Update the text list file content.
+
+This method works with the text list file type.
+
+This method is available on the `onForged` time to live API parameter.
+
+Its type is defined as:
+
+```ts
+export type ForgedAPI = {
+updateTextRawFile: (
+    fileName: string,
+    update: (content: string[]) => string[],
+  ) => Promise<void>;
+  ...
+};
+```
+
+## fileName
+
+The filename or file path of the text list file.
+
+## update
+
+Update function.
+
+The function parameter is the current file content. The content will be divided by `\n` and passed into function in the form of array. The return value of function is also array. The internal will be automatically merged with `\n` and written to the source file.

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

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

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

@@ -0,0 +1,20 @@
+---
+sidebar_position: 3
+---
+
+# gitAddAndCommit
+
+Commit the current repository changes.
+
+Its type is defined as:
+
+```ts
+export type AfterForgedAPI = {
+  gitAddAndCommit: (commitMessage: string) => Promise<void>;
+  ...
+};
+```
+
+## commitMessage
+
+Commit information.

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

@@ -0,0 +1,16 @@
+---
+sidebar_position: 2
+---
+
+# initGitRepo
+
+nitialization The current directory is the Git repository.
+
+Its type is defined as:
+
+```ts
+export type AfterForgedAPI = {
+  initGitRepo: () => Promise<void>;
+  ...
+};
+```

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

@@ -0,0 +1,16 @@
+---
+sidebar_position: 1
+---
+
+# isInGitRepo
+
+Determines whether the current project is a Git repository.
+
+Its type is defined as:
+
+```ts
+export type AfterForgedAPI = {
+  isInGitRepo: () => Promise<boolean>;
+  ...
+};
+```

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

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

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

@@ -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](/docs/guides/topic-detail/generator/plugin/api/git/isInGitRepo) 和 [NPM API](/docs/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/docusaurus-plugin-content-docs/current/guides/topic-detail/generator/plugin/api/hook/onForged.md

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

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

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

@@ -0,0 +1,22 @@
+---
+sidebar_position: 2
+---
+
+# isFileExit
+
+Determine if the file exists.
+
+The method is available directly on the context.
+
+Its type is defined as:
+
+```ts
+export interface IPluginContext {
+  isFileExit: (fileName: string) => Promise<boolean>;
+  ...
+}
+```
+
+## fileName
+
+The file name or file path that needs to be judged is based on the relative path of the created project.

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

@@ -0,0 +1,17 @@
+---
+sidebar_position: 1
+---
+
+# locale
+
+Current language.
+
+The method is available directly on the context.
+
+There are two values for this field:
+
+- zh: Chinese
+
+- en: English
+
+The generator plugin can adjust the value of the relevant display field according to this field.

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

@@ -0,0 +1,22 @@
+---
+sidebar_position: 3
+---
+
+# readDir
+
+Read the folder and get the file list.
+
+The method is available directly on the context.
+
+Its type is defined as:
+
+```ts
+export interface IPluginContext {
+  readDir: (dir: string) => Promise<string[]>;
+  ...
+}
+```
+
+## dir
+
+Its type is defined as: folder name or path, based on the relative path of the created project.

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

@@ -0,0 +1,4 @@
+{
+  "label": "Customized Input API",
+  "position": 3
+}

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

@@ -0,0 +1,57 @@
+---
+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](/docs/guides/topic-detail/generator/config/common).
+
+## input
+
+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:
+
+```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.
+:::