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

package/.turbo/turbo-build.log

@@ -1,4 +1,4 @@
 
-> @modern-js/main-doc@2.0.0-beta.1 build /github/workspace/packages/toolkit/main-doc
+> @modern-js/main-doc@2.0.0-beta.2 build /github/workspace/packages/toolkit/main-doc
 > npx ts-node ./scripts/sync.ts
 

package/en/docusaurus-plugin-content-docs/current/apis/app/commands/build.md

@@ -39,6 +39,6 @@ Open the above HTML file in the browser, you can see the tile diagram of the pac
 
 ## Command Arguments
 
-import CommandTip from '@site-docs/components/command-tip.md'
+import CommandTip from '@site-docs-en/components/command-tip.md'
 
 <CommandTip />

package/en/docusaurus-plugin-content-docs/current/apis/app/commands/dev.md

@@ -26,6 +26,6 @@ App running at:
   > Network:  http://192.168.0.1:8080/
 ```
 
-import CommandTip from '@site-docs/components/command-tip.md'
+import CommandTip from '@site-docs-en/components/command-tip.md'
 
 <CommandTip />

package/en/docusaurus-plugin-content-docs/current/apis/app/commands/lint.md

@@ -17,6 +17,6 @@ Run ESLint to check the syntax of the code. Normally, only the part of the code
 
 * `--no-fix` close auto fix by lint.
 
-import CommandTip from '@site-docs/components/command-tip.md'
+import CommandTip from '@site-docs-en/components/command-tip.md'
 
 <CommandTip />

package/en/docusaurus-plugin-content-docs/current/apis/app/commands/new.md

@@ -19,7 +19,7 @@ The `modern new` command is used to enable features to an existing project.
 
 For example, add application entry, enable some optional features such as Tailwind CSS, micro frontend, etc.
 
-import CommandTip from '@site-docs/components/command-tip.md'
+import CommandTip from '@site-docs-en/components/command-tip.md'
 
 <CommandTip />
 
@@ -32,7 +32,6 @@ $ npx modern new
 ? 请选择你想要的操作 创建工程元素
 ? 创建工程元素 新建「应用入口」
 ? 请填写入口名称 entry
-? 是否需要调整默认配置? 否
 ```
 
 ### Enable Features

package/en/docusaurus-plugin-content-docs/current/apis/app/commands/start.md

@@ -25,7 +25,7 @@ export default defineConfig({
 })
 ```
 
-import CommandTip from '@site-docs/components/command-tip.md'
+import CommandTip from '@site-docs-en/components/command-tip.md'
 
 <CommandTip />
 

package/en/docusaurus-plugin-content-docs/current/apis/app/commands/test.md

@@ -31,6 +31,6 @@ Time:        0.994 s, estimated 1 s
 files match `*.test.(js|ts)` in `api/` or `src/` will be recognized as test cases by default。
 :::
 
-import CommandTip from '@site-docs/components/command-tip.md'
+import CommandTip from '@site-docs-en/components/command-tip.md'
 
 <CommandTip />

package/en/docusaurus-plugin-content-docs/current/apis/app/overview.md

@@ -2,7 +2,7 @@
 sidebar_position: 0
 ---
 
-# Overview
+# overview
 
 This section covers all APIs in `@modern-js/app-tools`.
 

package/en/docusaurus-plugin-content-docs/current/apis/app/runtime/model/auto-actions.md

@@ -3,7 +3,7 @@ sidebar_position: 6
 title: Auto actions
 ---
 
-import ReduckTip from '@site-docs/components/reduck-tip.md'
+import ReduckTip from '@site-docs-en/components/reduck-tip.md'
 
 <ReduckTip />
 

package/en/docusaurus-plugin-content-docs/current/apis/app/runtime/model/connect.md

@@ -3,7 +3,7 @@ sidebar_position: 5
 title: connect
 ---
 
-import ReduckTip from '@site-docs/components/reduck-tip.md'
+import ReduckTip from '@site-docs-en/components/reduck-tip.md'
 
 <ReduckTip />
 

package/en/docusaurus-plugin-content-docs/current/apis/app/runtime/model/create-app.md

@@ -3,7 +3,7 @@ sidebar_position: 11
 title: createApp
 ---
 
-import ReduckTip from '@site-docs/components/reduck-tip.md'
+import ReduckTip from '@site-docs-en/components/reduck-tip.md'
 
 <ReduckTip />
 

package/en/docusaurus-plugin-content-docs/current/apis/app/runtime/model/create-store.md

@@ -3,7 +3,7 @@ sidebar_position: 10
 title: createStore
 ---
 
-import ReduckTip from '@site-docs/components/reduck-tip.md'
+import ReduckTip from '@site-docs-en/components/reduck-tip.md'
 
 <ReduckTip />
 

package/en/docusaurus-plugin-content-docs/current/apis/app/runtime/model/handle-effect.md

@@ -3,7 +3,7 @@ sidebar_position: 7
 title: handleEffect
 ---
 
-import ReduckTip from '@site-docs/components/reduck-tip.md'
+import ReduckTip from '@site-docs-en/components/reduck-tip.md'
 
 <ReduckTip />
 

package/en/docusaurus-plugin-content-docs/current/apis/app/runtime/model/model_.md

@@ -3,7 +3,7 @@ sidebar_position: 1
 title: model
 ---
 
-import ReduckTip from '@site-docs/components/reduck-tip.md'
+import ReduckTip from '@site-docs-en/components/reduck-tip.md'
 
 <ReduckTip />
 

package/en/docusaurus-plugin-content-docs/current/apis/app/runtime/model/use-local-model.md

@@ -3,7 +3,7 @@ sidebar_position: 4
 title: useLocalModel
 ---
 
-import ReduckTip from '@site-docs/components/reduck-tip.md'
+import ReduckTip from '@site-docs-en/components/reduck-tip.md'
 
 <ReduckTip />
 

package/en/docusaurus-plugin-content-docs/current/apis/app/runtime/model/use-model.md

@@ -3,7 +3,7 @@ sidebar_position: 2
 title: useModel
 ---
 
-import ReduckTip from '@site-docs/components/reduck-tip.md'
+import ReduckTip from '@site-docs-en/components/reduck-tip.md'
 
 <ReduckTip />
 

package/en/docusaurus-plugin-content-docs/current/apis/app/runtime/model/use-static-model.md

@@ -3,7 +3,7 @@ sidebar_position: 3
 title: useStaticModel
 ---
 
-import ReduckTip from '@site-docs/components/reduck-tip.md'
+import ReduckTip from '@site-docs-en/components/reduck-tip.md'
 
 <ReduckTip />
 

package/en/docusaurus-plugin-content-docs/current/apis/app/runtime/model/use-store.md

@@ -3,7 +3,7 @@ sidebar_position: 9
 title: useStore
 ---
 
-import ReduckTip from '@site-docs/components/reduck-tip.md'
+import ReduckTip from '@site-docs-en/components/reduck-tip.md'
 
 <ReduckTip />
 

package/en/docusaurus-plugin-content-docs/current/components/command-tip.md

@@ -0,0 +1,56 @@
+:::tip 提示
+The pnpm v6 and pnpm v7 versions do not use the same posture when executing commands. The following should be noted:
+
+pnpm v7：
+
+When using pnpm to invoke a command in `package.json`, if you need to pass arguments to pnpm, you need to put the arguments before the command.
+
+For example, execute the prepare command with the pnpm '--filter' parameter:
+
+```bash
+pnpm run --filter "./packages/**" prepare
+```
+
+If you need to pass parameters to a command, you need to put the parameters after the command.
+
+For example, in the following `package.json` configuration:
+
+``` json
+{
+  "scripts": {
+    "command": "modern command"
+  }
+}
+```
+
+The way to carry parameters when executing the command command is:
+```bash
+pnpm run command --options
+```
+
+pnpm v6:
+
+In the following `package.json` configuration:
+
+``` json
+{
+  "scripts": {
+    "command": "modern command"
+  }
+}
+```
+
+If you need to execute `modern command --option`,
+
+When using pnpm, you need to execute the `pnpm run command -- --option`。
+
+This is because pnpm does not handle command parameters the same as Yarn, but is similar to npm: when not adding a `--` character string, the parameters of pnpm are passed; when using a `--` character string, the parameters of the execution script are passed.
+
+In the above example the parameter `--option` is passed to `modern command`. If `pnpm run command --option` is executed, the parameter `--option` will be passed to pnpm.
+
+Summary:
+
+** When using pnpm v7, if you pass arguments to pnpm, you need to put the arguments before the command **
+
+** When using pnpm v6, if the parameter passed to pnpm, you do not need to add `--`; if the parameter passed is for script use, you need to add `--` character string **.
+:::

package/en/docusaurus-plugin-content-docs/current/components/reduck-tip.md

@@ -0,0 +1,5 @@
+:::info  information
+By default, the export package name for all APIs in this section is: `@modern-js/runtime/model`.
+
+If Reduck is integrated separately from Modern.js, the export package name is: `@modern-js-reduck/react`.
+:::

package/en/docusaurus-plugin-content-docs/current/configure/app/output/disable-css-extract.md

@@ -0,0 +1,12 @@
+---
+title: output.disableCssExtract
+sidebar_label: disableCssExtract
+---
+
+:::info BUILDER
+This configuration is Modern.js Builder configuration, there may be links that cannot be redirected. for details, please refer to [output.disableCssExtract](https://modernjs.dev/builder/zh/api/config-output.html#output-disablecssextract)。
+:::
+
+import Main from '@modern-js/builder-doc/en/config/output/disableCssExtract.md'
+
+<Main />

package/en/docusaurus-plugin-content-docs/current/configure/app/runtime/router.md

@@ -9,7 +9,7 @@ sidebar_label: router
 
 When `router` is enabled, routing management using conventional routes provided by Modern.js default is supported.
 
-具体配置如下：
+## Configuration
 
 ### supportHtml5History
 

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

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

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

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

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

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

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

@@ -0,0 +1,152 @@
+---
+sidebar_position: 1
+---
+
+# @modern-js/codesmith-api-app
+
+The combination encapsulation of APIs commonly used in the development of microgenerators, including APIs encapsulation of other packages such as fs, git, npm, etc. When the requirements can be met, it is recommended to use the API of the npm package.
+
+## Use
+
+```typescript
+import { AppAPI } from '@modern-js/codesmith-api-app';
+
+export default async (context: GeneratorContext, generator: GeneratorCore) => {
+  const appApi = new AppAPI(context, generator);
+  await appApi.runInstall();
+}
+```
+
+- Create AppAPI instance, the parameter is the generator of the microgenerator function parameter, please see the composition of the microgenerator project for details.
+- Just call the API on its example.
+
+## API
+
+### checkEnvironment
+
+Check the current generator operating environment, the check items are:
+
+1. The node and node versions, the default is greater than 12.22.12, and the node version can be executed by passing parameters.
+2. Yarn, pnpm or npm can be used.
+
+Parameter:
+
+- nodeVersion?: `string`. Node version want to check.
+
+### runInstall
+
+To install dependency, you can pass in the install dependency command, which defaults to the `packageManager` value in config.
+
+Parameter:
+
+- command?: `string`, Install dependency command.
+
+### runGitAndInstall
+
+This function performs the following actions:
+
+1. Check whether the current generator execution directory is a git repository.
+2. If not a git repository, initialization is a git repository.
+3. Install dependencies.
+4. Commit the initial commit in a non-monorepo project (judging the condition, `isMonorepoSubProject` does not exist or is false in the config), the commit information is feat: init, and customize is supported.
+
+
+Parameter:
+- commitMessage?: `string`, Initialization commit message
+- installFunc?: `() => Promise<void>`. Install dependency function
+
+### forgeTemplate
+
+Render generator template file.
+
+Parameter:
+
+- templatePattern: `string`. Template files match regularities,for example: `templates/base-templates/**/*` .
+- filter?: `(resourceKey: string) => boolean`. Filter function, the parameter is the file path matching the `templatePattern`, return true to render the file, return false to render the file.
+- rename?: `(resourceKey: string) => string`. Rename function, the parameter is the file path matching `templatePattern`, and the new filename is returned. The templates directory at the beginning of `resourceKey` and the `.handlebars` suffix at the end will be replaced by default.
+- parameters?: `Record<string, any>`. Render parameter, when there is a handlebars or ejs variable in the template, use it to pass the corresponding variable value.
+- type?: `'handlebars' | 'ejs'`. Template file type, defaults to handlebars.
+
+For example:
+
+```typescript
+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
+
+Display success information.
+
+Parameter:
+
+- successInfo?: `string`. Default is Success.
+
+### runSubGenerator
+
+Run the subgenerator.
+
+Parameter:
+
+- subGenerator: `string`. Subgenerator name or path.
+- relativePwdPath?: `string`. The relative path to which the'string 'subgenerator runs.
+- config?: `Record<string, unknown>`. Default config configuration for subgenerator runs.
+
+For example:
+
+```typescript
+  await appApi.runSubGenerator(
+    getGeneratorPath('@modern-js/repo-generator', context.config.distTag),
+    undefined,
+    { ...context.config, hasPlugin: false },
+  );
+```
+
+### getInputBySchema
+
+User interaction input is done through schema.
+
+Parameter:
+
+- schema: `FormilySchema | Question[]`. Question list, supports Formily schema and inquirer types.
+- type: `'formily' | 'inquirer'`. Schema type, the default value is formily.
+- configValue: `Record<string, unknown> = {}`. Schema default value, the problem corresponding to the schema field passed in this value will no longer interact with the user.
+- validateMap?: `Record<string, (input: unknown, data?: Record<string, unknown>) => { success: boolean; error?: string }>`. Validation function for special fields in schema.
+- initValue?: `Record<string, any>`. Schema the initialization value of the field.
+
+For Formily Schema type support, please refer to [Customize input related type definition](/docs/guides/topic-detail/generator/plugin/api/input/type).
+
+### getInputBySchemaFunc
+
+By schema to complete user interaction input, schema parameter value as function, the user handles globalization problems, and only supports Formily schema.
+
+Parameter:
+
+- schema: `config?: Record<string, any>) => FormilySchema`. Get the problem list function, the config parameter is the config configuration information in the current generator.
+- configValue: `Record<string, unknown> = {}`. Schema default value, the problem corresponding to the schema field passed in this value will no longer interact with the user.
+- validateMap?: `Record<string, (input: unknown, data?: Record<string, unknown>) => { success: boolean; error?: string }>`. Validation function for special fields in schema.
+- initValue?: `Record<string, any>`. Schema the initialization value of the field.
+
+For Formily Schema type support, please refer to [Customize input related type definition](/docs/guides/topic-detail/generator/plugin/api/input/type).

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

@@ -0,0 +1,56 @@
+---
+sidebar_position: 6
+---
+
+# @modern-js/codesmith-api-ejs
+
+An API wrapper for file operations using [ejs] (https://ejs.co/) in microgenerators, providing a way to render individual template files and folders.
+
+## Use
+
+```typescript
+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" }
+   );
+}
+```
+
+- Create EjsAPI instance, the parameter is the generator of the microgenerator function parameter, please see the composition of the microgenerator project for details.
+- Just call the API on its example.
+
+## API
+
+### renderTemplate
+
+Render a single template file.
+
+Parameter:
+
+- templateResource: `FsResource`. Template file resource, used by  `context.materials.get(<filename>)`.
+- target: `string`. Target file path name.
+- parameters?: `Record<string, string>`. Render parameter.
+
+### renderTemplateDir
+
+Render template folder.
+
+Parameter:
+
+- material: `FsMaterial`. The material context of the current microgenerator execution.
+- findGlob: `string`. Template file matches the regular.
+- target: `(globMatch: string) => string`. The target file path generation function, the parameter is `resourceKey.`
+- options?: `RenderTemplateDirOptions`. Glob Find the file configuration, the specific function viewable is here [glob] (https://www.npmjs.com/package/glob).
+
+```typescript
+type RenderTemplateDirOptions = {
+  nodir?: boolean;
+  dot?: boolean;
+  ignore?: string | readonly string[];
+};
+```

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

@@ -0,0 +1,54 @@
+---
+sidebar_position: 3
+---
+
+# @modern-js/codesmith-api-fs
+
+API wrapper for file operations in microgenerators, providing methods to render individual template files and folders. FsAPI is usually used to handle binaries or template files that cannot be handled with handlebars, ejs.
+
+## Use
+
+```typescript
+import { FsAPI } from '@modern-js/codesmith-api-fs';
+
+export default async (context: GeneratorContext, generator: GeneratorCore) => {
+  const handlebarApi = new HandlebarsAPI(generator);
+  await handlebarsAPI.renderFile(
+     material.get('templates/a.js'),
+     target: 'b.js'
+   );
+}
+```
+
+- Create FsAPI instance, the parameter is the generator of the microgenerator function parameter, please see the composition of the microgenerator project for details.
+- Just call the API on its example.
+
+## API
+
+### renderFile
+
+Render a single template file.
+
+Parameter:
+
+- resource: `FsResource`. Template file resource, used by  `context.materials.get(<filename>)`.
+- target: `string`. Target file path name.
+
+### renderDir
+
+Render template folder.
+
+Parameter:
+
+- material: `FsMaterial`. The material context of the current microgenerator execution.
+- findGlob: `string`. Template file matches the regular.
+- target: `(globMatch: string) => string`. The target file path generation function, the parameter is `resourceKey.`
+- options?: `RenderTemplateDirOptions`. Glob Find the file configuration, the specific function viewable is here [glob] (https://www.npmjs.com/package/glob).
+
+```typescript
+type RenderTemplateDirOptions = {
+  nodir?: boolean;
+  dot?: boolean;
+  ignore?: string | readonly string[];
+};
+```

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

@@ -0,0 +1,49 @@
+---
+sidebar_position: 4
+---
+
+# @modern-js/codesmith-api-git
+
+The API encapsulation of git-related operations in the micro-generator provides methods for judging git repository, initialization and commit code.
+
+## Use
+
+```typescript
+import { GitAPI } from '@modern-js/codesmith-api-git';
+
+export default async (context: GeneratorContext, generator: GeneratorCore) => {
+  const gitApi = new GitAPI(generatorCore, generatorContext);
+  await gitApi.initGitRepo();
+}
+```
+
+- Create GitAPI instance, the parameter is the generator of the microgenerator function parameter, please see the composition of the microgenerator project for details.
+
+- Just call the API on its example.
+
+## API
+
+### isInGitRepo
+
+Whether the current directory is a git repository.
+
+Parameter:
+
+- cwd?: `string`. The execution directory of the git command, the default is microgenerator `outputPath`.
+
+### initGitRepo
+
+The initialization is the git repository. The default branch name for init can be configured via `defaultBranch` in the generator config.
+
+Parameter:
+
+- cwd?: `string`. The execution directory of the git command, the default is microgenerator `outputPath`.
+- force?: `boolean`. Use this parameter to force git init when the current directory is already a git repository.
+
+### addAndCommit
+
+Execute `git add .` and `git commit` commit the current changes.
+
+Parameter:
+- commitMessage: `string`. Commit information.
+- cwd?: `string`. The execution directory of the git command, the default is microgenerator `outputPath`.

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

@@ -0,0 +1,58 @@
+---
+sidebar_position: 5
+---
+
+# @modern-js/codesmith-api-handlebars
+
+An API wrapper for file operations using [handlebars] (https://handlebarsjs.com/) in the microgenerator, providing a way to render individual template files and folders.
+
+## Use
+
+```typescript
+import { HandlebarsAPI } from '@modern-js/codesmith-api-handlebars';
+
+export default async (context: GeneratorContext, generator: GeneratorCore) => {
+  const handlebarApi = new HandlebarsAPI(generator);
+  await handlebarsAPI.renderTemplate(
+     material.get('templates/a.js'),
+     target: 'b.js',
+     { data: "data" }
+   );
+}
+```
+
+- Create HandlebarsAPI instance, the parameter is the generator of the microgenerator function parameter, please see the composition of the microgenerator project for details.
+
+- Just call the API on its example.
+
+
+## API
+
+### renderTemplate
+
+Render a single template file.
+
+Parameter:
+
+- templateResource: `FsResource`. Template file resource, used by  `context.materials.get(<filename>)`.
+- target: `string`. Target file path name.
+- parameters?: `Record<string, string>`. Render parameter.
+
+### renderTemplateDir
+
+Render template folder.
+
+Parameter:
+
+- material: `FsMaterial`. The material context of the current microgenerator execution.
+- findGlob: `string`. Template file matches the regular.
+- target: `(globMatch: string) => string`. The target file path generation function, the parameter is `resourceKey.`
+- options?: `RenderTemplateDirOptions`. Glob Find the file configuration, the specific function viewable is here [glob] (https://www.npmjs.com/package/glob).
+
+```typescript
+type RenderTemplateDirOptions = {
+  nodir?: boolean;
+  dot?: boolean;
+  ignore?: string | readonly string[];
+};
+```