@modern-js/main-doc 0.0.0-next-1686037191101 → 0.0.0-next-1686044917772

package/docs/en/guides/topic-detail/changesets/changelog.mdx

@@ -2,15 +2,15 @@
 sidebar_position: 6
 ---
 
-# Customizing Changelog Generation
+# Customizing Changelog
 
-By default, Changesets will use `@changesets/cli/changelog` to generate changelog information. If the default changelog information cannot meet the requirements, you can customize the generation of changelog.
+By default, Changesets will use `@changesets/cli/changelog` to generate changelog. If the default changelog cannot meet the requirements, you can customize the generation of changelog.
 
 ## Customizing Changelog Content
 
-Changelog information mainly includes the following two types of information:
+Changelog mainly includes the following two types of information:
 
-- Changelog information written in the changeset.
+- Changelog written in the changeset.
 
 - Version change information of related packages in this version upgrade.
 
@@ -28,10 +28,10 @@ export type VersionType = 'major' | 'minor' | 'patch' | 'none';
 export type Release = { name: string; type: VersionType };
 
 export type Changeset = {
-  id: string; // changeset 的文件名称
-  commit?: string; // changeset 提交时的 commit id 信息
-  summary: string; // changeset 内容信息
-  releases: Array<Release>; // 当前计算出的 changeset 升级包名称及类型信息
+  id: string; // changeset id
+  commit?: string; // changeset commit id
+  summary: string; // changeset summary content
+  releases: Array<Release>; // The name and type information of the current computed changeset upgrade package.
 };
 ```
 
@@ -77,13 +77,13 @@ All associated changeset information, which is an array of `getReleaseLine` chan
 
 ```ts
 type ModCompWithPackage = {
-  name: string; // 依赖模块名称
-  type: VersionType; // 依赖模块的升级类型
-  oldVersion: string; // 依赖模块当前版本号
-  newVersion: string; // 依赖模块新版本号
-  changesets: string[]; // 关联的 changeset id 列表
-  packageJson: PackageJSON; // 依赖模块完整的 package.json 内容
-  dir: string; // 依赖模块的路径(绝对路径)
+  name: string; // Name of the dependent module
+  type: VersionType; // Upgrade type of the dependent module
+  oldVersion: string; // Current version of the dependent module
+  newVersion: string; // New version of the dependent module
+  changesets: string[]; // List of associated changeset ids
+  packageJson: PackageJSON; // Complete package.json content of the dependent module
+  dir: string; // Path (absolute path) of the dependent module
 };
 
 type DependenciesUpdated = ModCompWithPackage[];
@@ -95,7 +95,7 @@ Changelog content.
 
 #### Default Implementation
 
-By default, `@changesets/cli/changelog` will display the corresponding `Updated dependencies + commit id` information of the changesets as a list. Then, based on the `dependenciesUpdated` information, it will display the package name and new version number of the corresponding dependency package as a child list item of the list.
+By default, `@changesets/cli/changelog` will display the corresponding `Updated dependencies + commit id` information of the changesets as a list. Then, based on the `dependenciesUpdated` information, it will display the package name and new version of the corresponding dependency package as a child list item of the list.
 
 ```ts
 async function getDependencyReleaseLine(changesets, dependenciesUpdated) {
@@ -128,11 +128,11 @@ It is displayed as follows:
 
 ## Configuration
 
-The `changelog` field in the changesets configuration file is used to mark the way to obtain changelog information.
+The `changelog` field in the changesets configuration file is used to mark the way to get changelog.
 
-This configuration can be a string, directly declaring the module name or path of the changelog information acquisition module.
+This configuration can be a string, directly declaring the module name or path of the changelog module.
 
-This configuration also supports configuring arrays. The first element in the array is the module name or path of the changelog information acquisition module, and the second element is the parameter value passed to the corresponding function, which will be passed as the third parameter of the `getReleaseLine` and `getDependencyReleaseLine` functions.
+This configuration also supports configuring arrays. The first element in the array is the module name or path of the changelog module, and the second element is the parameter value passed to the corresponding function, which will be passed as the third parameter of the `getReleaseLine` and `getDependencyReleaseLine` functions.
 
 ### Configuring Relative Paths
 
@@ -160,9 +160,9 @@ Configure `changlog` as `./my-changelog-config.js`:
 }
 ```
 
-### Using Module Project
+### Using Npm Module
 
-Customizing changelog can also be managed using the module project to provide a common solution.
+Customizing changelog can also be managed using the NPM module project to provide a common solution.
 
 #### Use `npx @modern-js/create@latest` to create a module project.
 
@@ -181,11 +181,11 @@ export async function getReleaseLine() {}
 export async function getDependencyReleaseLine() {}
 ```
 
-#### Publish the module to NPM.
+#### Publish the module to NPM
 
-#### Install the corresponding module in the root directory of the target repository, such as `custom-changelog`.
+#### Install the module in the root directory of the target repository, such as `custom-changelog`.
 
-#### Configure the changelog configuration of Changesets as the package name.
+#### Configure the changelog configuration of changesets as the package name.
 
 ```json title=".changesets/config.json"
 {
@@ -196,9 +196,9 @@ export async function getDependencyReleaseLine() {}
 
 ### Using Monorepo Sub-Project
 
-If your current repository is Monorepo, you can directly manage it using module sub-projects.
+If your current repository is Monorepo, you can directly manage it using NPM module sub-projects.
 
-#### Run `pnpm run new` to create a module sub-project.
+#### Run `pnpm run new` to create a NPM module sub-project
 
 ```bash
 ? Please select the type of project you want to create: Npm Module
@@ -215,7 +215,7 @@ export async function getReleaseLine() {}
 export async function getDependencyReleaseLine() {}
 ```
 
-#### Add the sub-project module dependency, such as `custom-changelog`, to the Monorepo root directory.
+#### Add the sub-project module dependency, such as `custom-changelog`, to the Monorepo root directory
 
 ```json title="package.json"
 {
@@ -226,7 +226,7 @@ export async function getDependencyReleaseLine() {}
 }
 ```
 
-#### Configure the changelog configuration of Changesets as the package name.
+#### Configure the changelog configuration of Changesets as the package name
 
 ```json title=".changesets/config.json"
 {

package/docs/en/guides/topic-detail/changesets/commit.mdx

@@ -4,7 +4,7 @@ sidebar_position: 7
 
 # Customizing Commit Messages
 
-Changesets supports configuring `commit` to automatically submit the current changes when executing the `change` and `bump` commands.
+Changesets supports configuring `commit` to automatically submit the current changes when running the `change` and `bump` commands.
 
 The default `commit` information is provided by `@changesets/cli/commit`, and the default information format is:
 
@@ -17,8 +17,8 @@ When the default commit information cannot meet the requirements, custom commit
 
 Commit information is divided into two types:
 
-- Commit information automatically generated when executing the `change` command.
-- Commit information automatically generated when executing the `bump` command.
+- Commit information automatically generated when running the `change` command.
+- Commit information automatically generated when running the `bump` command.
 
 The custom logic mainly implements two functions, `getAddMessage` and `getVersionMessage`, which are used to define the above two types of information, respectively.
 
@@ -101,18 +101,18 @@ type ComprehensiveRelease = {
 };
 
 type PreState = {
-  mode: 'pre' | 'exit'; // pre 模式当前状态
-  tag: string; // pre 的类型
+  mode: 'pre' | 'exit'; // Current state of pre mode
+  tag: string; // Type of pre
   initialVersions: {
-    [pkgName: string]: string; // 版本升级前包名及版本号信息，Map 格式
+    [pkgName: string]: string; // Package name and version information before version upgrade
   };
-  changesets: string[]; // 本次升级的 changeset id 列表
+  changesets: string[]; // List of changeset ids for this upgrade
 };
 
 type ReleasePlan = {
-  changesets: Changeset[]; // 本次升级的 changeset 列表
-  releases: ComprehensiveRelease[]; // 当前升级的包信息，包含包名称、当前版本、升级后版本、升级类型等
-  preState: PreState | undefined; // 当前如果为 pre 发布，提供相关状态信息
+  changesets: Changeset[]; // List of changesets for this upgrade
+  releases: ComprehensiveRelease[]; // Information of the current upgrade, including package name, current version, upgraded version, and upgrade type
+  preState: PreState | undefined; // If it is a pre-release, provide relevant state information
 };
 ```
 
@@ -128,7 +128,7 @@ Commit message content.
 
 #### Default Implementation
 
-The default processing logic of `@changesets/cli/commit` is to first display the number of packages that need to be released, then display the names and new version numbers of the released packages, and [skip ci] information is added according to the `skipCI` parameter configuration passed in.
+The default processing logic of `@changesets/cli/commit` is to first display the number of packages that need to be released, then display the names and new version of the released packages, and [skip ci] information is added according to the `skipCI` parameter configuration passed in.
 
 ```ts
 const getVersionMessage = async (
@@ -157,7 +157,7 @@ const getVersionMessage = async (
 
 ## Configuration
 
-The `commit` field in the changesets configuration file is used to mark whether to submit commit information when executing the `change` and `bump` commands, and the way to obtain commit information.
+The `commit` field in the changesets configuration file is used to mark whether to submit commit information when running the `change` and `bump` commands, and the way to obtain commit information.
 
 This configuration can be a `boolean`. When it is `true`, the default `@changesets/cli/commit` formatting commit information will be used.
 
@@ -191,15 +191,15 @@ Configure `commit` as `./my-commit-config.js`:
 }
 ```
 
-### Using Module Project
+### Using NPM Module
 
-Customizing commit can also be managed using the module project to provide a common solution.
+Customizing commit can also be managed using the NPM module project to provide a common solution.
 
-#### Use `npx @modern-js/create@latest` to create a module project.
+#### Use `npx @modern-js/create@latest` to create a module project
 
 ```md
 ? Please select the type of project you want to create: Npm Module
-? Please fill in the project name: custom-changelog
+? Please fill in the project name: custom-commit
 ? Please select the programming language: TS
 ? Please select the package manager: pnpm
 ```
@@ -212,11 +212,11 @@ export async function getAddMessage() {}
 export async function getVersionMessage() {}
 ```
 
-#### Publish the module to NPM.
+#### Publish the module to NPM
 
-#### Install the corresponding module in the root directory of the target repository, such as `custom-commit`.
+#### Install the corresponding module in the root directory of the target repository, such as `custom-commit`
 
-#### Configure the commit configuration of changesets as the package name.
+#### Configure the commit configuration of changesets as the package name
 
 ```json title="package.json"
 {
@@ -227,9 +227,9 @@ export async function getVersionMessage() {}
 
 ### Using Monorepo Sub-Project
 
-If your current repository is Monorepo, you can directly manage it using module sub-projects.
+If your current repository is Monorepo, you can directly manage it using NPM module sub-projects.
 
-#### Run `pnpm run new` to create a module sub-project.
+#### Run `pnpm run new` to create a module sub-project
 
 ```bash
 ? Please select the type of project you want to create: Npm Module
@@ -246,7 +246,7 @@ export async function getAddMessage() {}
 export async function getVersionMessage() {}
 ```
 
-Add the sub-project module dependency, such as `custom-commit`, to the Monorepo root directory.
+#### Add the sub-project module dependency, such as `custom-commit`, to the Monorepo root directory
 
 ```json title="package.json"
 {
@@ -257,7 +257,7 @@ Add the sub-project module dependency, such as `custom-commit`, to the Monorepo
 }
 ```
 
-Configure the commit configuration of Changesets as the package name.
+#### Configure the commit configuration of Changesets as the package name
 
 ```json title=".changesets/config.json"
 {

package/docs/en/guides/topic-detail/changesets/config.mdx

@@ -4,9 +4,9 @@ sidebar_position: 5
 
 # Changesets Configuration
 
-As we learned earlier, when initializing a Modern.js repository, the configuration file for changesets will be initialized by default, that is, the `.changeset/config.json` file. Below, we will learn in detail what configurations are supported in this file.
+When initializing a Modern.js repository, the configuration file for changesets will be initialized by default, that is, the `.changeset/config.json` file. Below, we will learn in detail what configurations are supported in this file.
 
-## Configuration introduction
+## Introduction
 
 ### commit
 
@@ -14,14 +14,14 @@ Type: `boolean`
 
 Default: `false`
 
-When this field is configured as `true`, the code submission operation will be automatically executed when executing the `change` and `bump` commands.
+When this field is configured as `true`, the code submission operation will be automatically executed when running the `change` and `bump` commands.
 
 The default commit information format is as follows:
 
 ![change commit](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/changeset-change-commit-info.png)
 ![bump commit](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/changeset-bump-commit-info.png)
 
-This commit information supports customization, which we will discuss in detail in the [Customizing Commit Information](/guides/topic-detail/changesets/commit) chapter.
+This commit information supports customization, which we will discuss in detail in the [Customizing Commit Messages](/guides/topic-detail/changesets/commit) chapter.
 
 ### access
 
@@ -58,7 +58,7 @@ Type: `string[]`
 
 Default: `[]`
 
-Used to declare packages to be ignored when executing the `bump` command. The usage is consistent with the `--ignore` parameter of the `bump` command. Note that the two cannot be used at the same time.
+Used to declare packages to be ignored when running the `bump` command. The usage is consistent with the `--ignore` parameter of the `bump` command. Note that the two cannot be used at the same time.
 
 ### fixed
 
@@ -66,7 +66,7 @@ Type: `string[][]`
 
 Default: `[]`
 
-Used to group packages in monorepos. The version numbers of packages in the same group will be bound, and each time the `bump` command is executed, if a package in the same group is upgraded, others will be upgraded together.
+Used to group packages in monorepos. The version of packages in the same group will be bound, and each time the `bump` command is run, a package in the same group is upgraded, others will be upgraded together.
 Regular expressions can be used to match package names.
 
 ### linked
@@ -75,7 +75,7 @@ Type: `string[][]`
 
 Default: `[]`
 
-Similar to `fixed`, it also groups packages in monorepos, but only the packages related to the changeset declaration will be upgraded when the `bump` command is executed, and the version numbers of the changeset packages in the same group will remain consistent.
+Similar to `fixed`, it also groups packages in monorepos, but only the packages related to the changeset declaration will be upgraded when the `bump` command is run, and the version of the changeset packages in the same group will remain consistent.
 Regular expressions can be used to match package names.
 
 ### updateInternalDependencies
@@ -86,7 +86,7 @@ Default: `patch`
 
 Used to declare the version number rule for updating internal dependencies.
 
-When upgrading the version number by executing the `bump` command, the dependency declaration using the package in the repository will be automatically updated by default. After configuring this field as `minor`, if the version number is upgraded to `patch`, the reference dependency declaration will not be updated automatically.
+When upgrading the version number by running the `bump` command, the dependency declaration using the package in the repository will be automatically updated by default. After configuring this field as `minor`, if the version number is upgraded to `patch`, the reference dependency declaration will not be updated automatically.
 
 For example:
 
@@ -108,7 +108,7 @@ Default: `@changesets/cli/changelog`
 
 The rule for generating changelog.
 
-When configured as `false`, only the version number will be declared in the `CHANGELOG.md` file when executing the `bump` command, and no other changelog information will be declared.
+When configured as `false`, only the version number will be declared in the `CHANGELOG.md` file when running the `bump` command, and no other changelog information will be declared.
 
 ![Close changelog configuration](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/changeset-empty-changelog.png)
 
@@ -136,7 +136,7 @@ Type: `always` | `out-of-range`
 
 Default: `always`
 
-When upgrading the version number by executing the `bump` command, the dependency declaration using the package in the repository will be automatically updated by default. When this parameter is set to `out-of-range`, the dependency declaration using the package in the repository will be updated only when it is outside the declared range.
+When upgrading the version number by running the `bump` command, the dependency declaration using the package in the repository will be automatically updated by default. When this parameter is set to `out-of-range`, the dependency declaration using the package in the repository will be updated only when it is outside the declared range.
 
 #### useCalculatedVersionForSnapshots
 

package/docs/en/guides/topic-detail/changesets/github.mdx

@@ -28,7 +28,7 @@ After the configuration is completed, the robot will automatically check whether
 
 ![](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/changeset-bot-no-changeset.png)
 
-You can execute `pnpm run change` in the repository to add changeset, or click the second link below to fill in changeset directly.
+You can run `pnpm run change` in the repository to add changeset, or click the second link below to fill in changeset directly.
 
 #### Changeset added
 
@@ -44,11 +44,11 @@ You can directly ignore the prompt information when no changeset is added, which
 
 ### Automatically create Release Pull Request
 
-Modern.js provides a Github Action to automatically create release Pull Request, which can automatically execute bump operation, update lock file and create Pull Request operation based on the selected branch.
+Modern.js provides a Github Action to automatically create release Pull Request, which can automatically run bump command, update lock file and create Pull Request operation based on the selected branch.
 
 #### Usage
 
-Create a `.github/workflows/release-pull-request.yml` file in the repository and fill in the following content:
+- Create a `.github/workflows/release-pull-request.yml` file in the repository and fill in the following content:
 
 ```yaml
 name: Release Pull Request
@@ -93,25 +93,25 @@ jobs:
           REF: ${{ github.ref }}
 ```
 
-After merging Workflow into the main branch, go to the Action page corresponding to the Github repository and select Release Pull Request:
+- After merging Workflow into the main branch, go to the Action page corresponding to the Github repository and select Release Pull Request:
 
 ![Release Pull Request Action](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/action-pull-request.png)
 
-Select the release type of this release, and click the Run workflow button:
+- Select the release type of this release, and click the Run workflow button:
 
 ![Run Release Pull Request](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/action-pull-request.jpeg)
 
-After the workflow is completed, a `Release-${version}` Pull Request will be automatically created, the related version number of `bump` changeset will be automatically updated, and the lock file will be updated. The content of Pull Request is the Release Note automatically generated by executing the `gen-release-note` command.
+- After the workflow is completed, a `Release-${version}` Pull Request will be automatically created, the related version number of `bump` changeset will be automatically updated, and the lock file will be updated. The content of Pull Request is the Release Note automatically generated by running the `gen-release-note` command.
 
 ![Release Pull Request](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/release-pull-request.jpeg)
 
 ### Automatic Release
 
-Modern.js provides a Github Action to automatically release versions, which can automatically execute release operation based on the selected branch and publish the package to NPM.
+Modern.js provides a Github Action to automatically release versions, which can automatically run release command based on the selected branch and publish the package to NPM.
 
 #### Usage
 
-Create a `.github/workflows/release.yml` file in the repository and fill in the following content:
+- Create a `.github/workflows/release.yml` file in the repository and fill in the following content:
 
 ```yaml
 name: Release
@@ -160,16 +160,16 @@ jobs:
           REF: ${{ github.ref }}
 ```
 
-Configure the NPM_TOKEN of the repository:
+- Configure the NPM_TOKEN of the repository:
 
 ![](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/github-set-npm-token.png)
 
-After merging Workflow into the main branch, go to the Action page corresponding to the Github repository and select Release:
+- After merging Workflow into the main branch, go to the Action page corresponding to the Github repository and select Release:
 
 ![Release Action](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/release-action.png)
 
-Select the branch name and release version type, and click the Run workflow button:
+- Select the branch name and release version type, and click the Run workflow button:
 
 ![Run Release Action](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/run-release-workflow.png)
 
-Workflow will automatically complete the build and release to NPM process of the repository.
+- Workflow will automatically complete the build and release to NPM process of the repository.

package/docs/en/guides/topic-detail/changesets/introduce.mdx

@@ -2,25 +2,25 @@
 sidebar_position: 1
 ---
 
-# Introduction to Changesets
+# Introducing Changesets
 
-Modern.js integrates [changesets](https://github.com/changesets/changesets) by default for package version management in Npm Module and Monorepo project.
+Modern.js integrates [changesets](https://github.com/changesets/changesets) for package version management in Npm Module and Monorepo project.
 
 ## Features
 
 Changesets have the following features:
 
-- During development, developers need to provide the package names involved in this change, the type of version upgrade (`pathch`, `minor`, `major`), and change information, that is, changeset.
+- During development, developers need to provide the package names, the type of version upgrade (`pathch`, `minor`, `major`), and change information involved in this change.
 
 - When releasing a version, the version number of the corresponding package will be automatically upgraded based on the content of the changeset, and changelog information will be generated in the corresponding package.
 
-- In the Monorepo scenario, changesets will automatically generate a repository dependency graph, and only upgrade the version numbers of the changed packages and related dependent packages during upgrade.
+- In the Monorepo project, changesets will automatically generate a repository dependency graph, and only upgrade the version numbers of the changed packages and related dependent packages during upgrade.
 
 ## Initialization
 
-The module and Monorepo project schemes created by Modern.js have already initialized changesets. The `.changeset` directory and the configuration file `.changeset/config.json` will be automatically created in the project root directory.
+The Npm Module and Monorepo project created by Modern.js have already initialized changesets. The `.changeset` directory and the configuration file `.changeset/config.json` will be automatically created in the project root directory.
 
-In addition, Modern.js provides corresponding commands for changesets in its corresponding project scheme tools `@modern-js/module-tools` and `@modern-js/monorepo-tools`, and there is no need to manually install changeset-related dependencies.
+In addition, Modern.js provides corresponding commands for changesets in its corresponding project tools `@modern-js/module-tools` and `@modern-js/monorepo-tools`, and there is no need to manually install changeset-related dependencies.
 
 The default configuration for changesets is as follows:
 
@@ -37,20 +37,20 @@ The default configuration for changesets is as follows:
 }
 ```
 
-The configuration file provides some basic configurations for generating changesets. For detailed field descriptions, please refer to the following chapter: [changesets configuration](/guides/topic-detail/changesets/config).
+The configuration file provides some basic configurations for generating changesets. For detailed field descriptions, please refer to [Changesets configuration](/guides/topic-detail/changesets/config).
 
 ## Commands
 
-- `change` Creates a changeset. After executing this command, a changeset file will be automatically generated in the `.changeset` directory.
+- `change`: Creates a changeset. After running this command, a changeset file will be automatically generated in the `.changeset` directory.
 
-- `bump` Upgrades the version number of the corresponding package based on the current changeset.
+- `bump`: Upgrades the version of the corresponding package based on the current changeset.
 
-- `pre` Marks entering and exiting `pre release` mode. When executing the `bump` command in `pre release` mode, the version number format will be `x.x.x-${pre-tag}.x`.
+- `pre`: Marks entering and exiting `pre release` mode. When running the `bump` command in `pre release` mode, the version format will be `x.x.x-${pre-tag}.x`.
 
-- `release` Publishes the package to NPM.
+- `release`: Publishes the package to NPM.
 
-- `status` Views the current changeset status.
+- `status`: Views the current changeset status.
 
-- `gen-release-note` Generates Release Note information based on the current chagneset status.
+- `gen-release-note`: Generates Release Note information based on the current chagneset status.
 
 For specific command-supported parameters, please refer to the corresponding chapter introduction.