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

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

@@ -4,7 +4,7 @@ sidebar_position: 1
 
 # 认识 Changesets
 
-Modern.js 默认集成了 [changesets](https://github.com/changesets/changesets) 用于模块和 Monorepo 工程方案项目中的包版本管理。
+Modern.js 默认集成了 [changesets](https://github.com/changesets/changesets) 用于模块和 Monorepo 工程方案的包版本管理。
 
 ## 特点
 
@@ -14,7 +14,7 @@ Changesets 具有以下几个特点：
 
 - 在发布版本时，会根据 changeset 内容自动升级对应包的版本号，并在对应的包中生成 changelog 信息。
 
-- 在 Monorepo 场景中，changeset 会自动生成仓库依赖图，升级时只会升级变更包及相关依赖包的版本号。
+- 在 Monorepo 项目中，changeset 会自动生成仓库依赖图，升级时只会升级变更包及相关依赖包的版本号。
 
 ## 初始化
 
@@ -37,20 +37,20 @@ Changesets 默认配置如下：
 }
 ```
 
-配置文件提供了生成 changesets 的一些基本配置，字段详细介绍请参考后续章节： [changesets 配置文件](/guides/topic-detail/changesets/config)。
+配置文件提供了生成 changesets 的一些基本配置，字段详细介绍请参考 [Changesets 配置文件](/guides/topic-detail/changesets/config)。
 
 ## 命令
 
-- `change` 创建一个 changeset，执行完成该命令后会自动在 `.changeset` 目录生成一个 changeset 文件。
+- `change`： 创建一个 changeset，执行完成该命令后会自动在 `.changeset` 目录生成一个 changeset 文件。
 
-- `bump` 根据当前 changeset 升级对应包版本号。
+- `bump`： 根据当前 changeset 升级对应包版本号。
 
-- `pre` 标记进入和退出 `pre release` 模式，在 `pre release` 模式下执行 `bump` 命令，将会生成 `x.x.x-${pre-tag}.x` 的版本号格式。
+- `pre`： 标记进入和退出 pre-release 模式，在 pre release 模式下执行 `bump` 命令，将会生成 `x.x.x-${pre-tag}.x` 的版本号格式。
 
-- `release` 发布包到 NPM。
+- `release`： 发布包到 NPM。
 
-- `status` 查看当前 changeset 状态。
+- `status`： 查看当前 changeset 状态。
 
-- `gen-release-note` 根据当前的 chagneset 状态生成 Release Note 信息。
+- `gen-release-note`： 根据当前的 chagneset 状态生成 Release Note 信息。
 
 具体命令支持的参数可以查看后续对应章节介绍。

package/docs/zh/guides/topic-detail/changesets/release-note.mdx

@@ -22,15 +22,13 @@ Modern.js 提供了 `modern gen-release-note` 命令，支持通过当前存在
 
 ## 信息
 
-### 自定义 Release Note 所需信息
+### getReleaseInfo
 
 生成 Release Note 信息需要先收集一些信息，比如 commit ID、Pull Request ID、commit message 等等。
 
 该逻辑可通过 `getReleaseInfo` 函数实现。
 
-#### getReleaseInfo
-
-##### Params
+#### Params
 
 - commit
 
@@ -45,9 +43,17 @@ Modern.js 提供了 `modern gen-release-note` 命令，支持通过当前存在
 初步解析 commit 获取基本信息。
 
 ```ts
+export enum CommitType {
+  Performance = 'performance',
+  Features = 'features',
+  BugFix = 'bugFix',
+  Doc = 'doc',
+  Other = 'other',
+}
+
 interface Commit {
   id: string; // commit id
-  type: 'feature' | 'fix'; // commit 类型，默认通过开头字符串如果为 fix，类型为 fix，其他为 feature
+  type: CommitType;
   repository?: string; // 参数传入的 repo 信息或者 package.json 中定义的 repository 信息
   pullRequestId?: string;
   author?: string;
@@ -58,17 +64,17 @@ interface Commit {
 }
 ```
 
-##### 返回值
+#### 返回值
 
 commitObj， 补充后完整的 commit 对象。
 
-##### 默认实现
+#### 默认实现
 
 Modern.js 的默认实现为：根据 commit 信息拆分出 Pull Request ID，并根据 commit id 获取到用户信息，加入到 commitObj 中。
 
 ```ts
 function getReleaseInfo(commit: string, commitObj: Commit) {
-const commitRegex = /(.*)\(#(\d*)\)/;
+  const commitRegex = /(.*)\(#(\d*)\)/;
 
   const [commitId, message, email] = commit.split('--');
 
@@ -108,15 +114,13 @@ const commitRegex = /(.*)\(#(\d*)\)/;
 }
 ```
 
-### 使用获取的信息生成 Release Note
+#### getReleaseNoteLine
 
 根据 `getReleaseInfo` 中获取的 commit 对象信息，生成对应的 Release Note。
 
 该逻辑可通过 `getReleaseNoteLine` 函数实现。
 
-#### getReleaseNoteLine
-
-##### Params
+#### Params
 
 - commit
 
@@ -128,11 +132,11 @@ const commitRegex = /(.*)\(#(\d*)\)/;
 
 获取对应语言的 Release Note 信息，支持 `en` 和 `zh`，默认为 `en`。
 
-##### 返回值
+#### 返回值
 
 生成的 Release Note。
 
-##### 默认实现
+#### 默认实现
 
 Modern.js 的默认实现为：
 
@@ -186,7 +190,7 @@ module.exports = {
 pnpm run gen-release-note --custom ./scripts/my-release-note-config.js
 ```
 
-也可以把命令参数直接定义到 package.json 中：
+也可以把命令参数直接定义到 `package.json` 中：
 
 ```json title="package.json"
 {
@@ -204,7 +208,7 @@ pnpm run gen-release-note --custom ./scripts/my-release-note-config.js
 
 custom 参数值还可以使用模块工程方案进行管理，提供通用方案。
 
-1. 使用 npx @modern-js/create@latest 创建模块工程方案。
+#### 使用 `npx @modern-js/create@latest` 创建模块工程方案
 
 ```md
 ? 请选择你想创建的工程类型：Npm 模块
@@ -213,7 +217,7 @@ custom 参数值还可以使用模块工程方案进行管理，提供通用方
 ? 请选择包管理工具：pnpm
 ```
 
-2. 实现自定义内容。
+#### 实现自定义内容
 
 ```ts title="src/index.ts"
 export function getReleaseInfo() {}
@@ -221,9 +225,9 @@ export function getReleaseInfo() {}
 export function getReleaseNoteLine() {}
 ```
 
-3. 将模块发布到 NPM。
-4. 在目标仓库根目录安装对应模块，例如 `custom-release-note`。
-5. 执行 gen-release-note 命令添加 custom 参数
+#### 将模块发布到 NPM
+#### 在目标仓库根目录安装对应模块，例如 `custom-release-note`
+#### 执行 gen-release-note 命令添加 custom 参数
 
 ```bash
 pnpm run gen-release-note --custom custom-release-note
@@ -233,7 +237,7 @@ pnpm run gen-release-note --custom custom-release-note
 
 如果你当前仓库为 Monorepo 工程方案，可以直接使用模块子项目进行管理。
 
-1. 执行 `pnpm run new` 创建模块子项目
+#### 执行 `pnpm run new` 创建模块子项目
 
 ```md
 ? 请选择你想创建的工程类型：Npm 模块
@@ -242,7 +246,7 @@ pnpm run gen-release-note --custom custom-release-note
 ? 请选择开发语言：TS
 ```
 
-2. 实现自定义内容。
+#### 实现自定义内容
 
 ```ts title="src/index.ts"
 export function getReleaseInfo() {}
@@ -250,7 +254,7 @@ export function getReleaseInfo() {}
 export function getReleaseNoteLine() {}
 ```
 
-3. 在 Monorepo 根目录添加子项目模块依赖，例如 `custom-release-note`。
+#### 在 Monorepo 根目录添加子项目模块依赖，例如 `custom-release-note`。
 
 ```json title="package.json"
 {
@@ -260,7 +264,7 @@ export function getReleaseNoteLine() {}
 }
 ```
 
-4. 执行 `gen-release-note` 命令添加 `--custom` 参数
+#### 执行 `gen-release-note` 命令添加 `--custom` 参数
 
 ```bash
 pnpm run gen-release-note --custom custom-release-note

package/docs/zh/guides/topic-detail/changesets/release-pre.mdx

@@ -13,7 +13,7 @@ sidebar_position: 4
 
 :::
 
-#### 执行以下命令升级预发布版本版本号：
+#### 执行 bump 命令升级预发布版本版本号
 
 ```bash
 pnpm run bump --canary --preid <preid>
@@ -23,11 +23,11 @@ pnpm run bump --canary --preid <preid>
 
 使用 `--canary` 参数后，`bump` 命令由以下三个步骤完成：
 
-- `changeset pre enter <preid>` 进入预发布模式
+- `changeset pre enter <preid>` 进入预发布模式。
 
-- `changeset version` 升级版本号
+- `changeset version` 升级版本号。
 
-- `changeset pre exit` 退出预发布模式
+- `changeset pre exit` 退出预发布模式。
 
 #### 检查相关变更并提交
 
@@ -35,7 +35,7 @@ pnpm run bump --canary --preid <preid>
 
 建议预发布操作不在主分支上进行，不合入主分支，当预发布验证完成后，直接基于主分支发布正式版本。
 
-#### 执行以下命令发布预发布版本：
+#### 执行 release 命令发布预发布版本
 
 ```bash
 pnpm run release --tag <tag>

package/docs/zh/guides/topic-detail/changesets/release.mdx

@@ -4,7 +4,7 @@ sidebar_position: 3
 
 # 发布正式版本
 
-发版正式版本时，我们需要根据开发过程中生成的 changeset 进行相关包版本号升级，并执行 publish 命令发布到 NPM 上。
+发版正式版本时，我们需要根据开发过程中生成的 changesets 进行相关包版本号升级，并执行 publish 命令发布到 NPM 上。
 
 ## 步骤
 
@@ -15,7 +15,7 @@ sidebar_position: 3
 
 ### 模块工程方案
 
-#### 在根目录执行以下命令：
+#### 在根目录执行 bump 命令
 
 ```bash
 pnpm run bump
@@ -29,16 +29,16 @@ pnpm run bump
 
 - 根据 changeset 信息升级该包版本号。
 
-- 在根目录的 `CHANGELOG.md` 文件中写入 Changelog 信息，文件不存在时会自动创建。
+- 在根目录的 `CHANGELOG.md` 文件中写入 changelog 信息，文件不存在时会自动创建。
 
-#### 确认并提交当前变更：
+#### 确认并提交当前变更
 
 ```bash
 git add .
 git commit -m "release: bump package"
 ```
 
-#### 在根目录执行以下命令发布包至 NPM：
+#### 在根目录执行以下命令发布包至 NPM
 
 ```bash
 pnpm run release
@@ -46,7 +46,7 @@ pnpm run release
 
 ![执行 release 命令](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/changeset-module-release.png)
 
-#### push 对应的 tag 信息至远程仓库：
+#### push 对应的 tag 信息至远程仓库
 
 ```bash
 git push --follow-tags
@@ -54,7 +54,7 @@ git push --follow-tags
 
 ### Monorepo 工程方案
 
-#### 在根目录执行以下命令：
+#### 在根目录执行 bump 命令
 
 ```bash
 pnpm run bump
@@ -62,7 +62,7 @@ pnpm run bump
 
 ![执行 bump 命令](https://lf3-static.bytednsdoc.com/obj/eden-cn/zq-uylkvT/ljhwZthlaukjlkulzlp/changeset-monorepo-bump.png)
 
-执行该命令时，changeset 会自动进行以下操作：
+执行该命令时，changesets 会自动进行以下操作：
 
 - 删除 `.changesets` 目录下的所有 changeset 文件。
 
@@ -70,7 +70,7 @@ pnpm run bump
 
 - 在需要升级的包目录的 `CHANGELOG.md` 文件中写入 Changelog 信息，文件不存在时会自动创建。
 
-#### 确认并提交当前变更：
+#### 确认并提交当前变更
 
 :::info
 需确认自动升级的版本号是否符合预期，如果需要了解版本升级策略，请查看[升级版本策略](/guides/topic-detail/changesets/release#升级版本策略)。
@@ -82,7 +82,7 @@ git add .
 git commit -m "release: bump package"
 ```
 
-#### 在根目录执行以下命令发布包至 NPM：
+#### 在根目录执行以下命令发布包至 NPM
 
 ```bash
 pnpm run release
@@ -95,7 +95,7 @@ pnpm run release
 
 :::
 
-#### push 对应的 tag 信息至远程仓库：
+#### push 对应的 tag 信息至远程仓库
 
 ```bash
 git push --follow-tags
@@ -105,7 +105,7 @@ git push --follow-tags
 
 ### bump 命令参数
 
-- `--snapshot` 生成基于时间戳的版本号。
+- `--snapshot`：生成基于时间戳的版本号。
 
 ```bash
 pnpm run bump --snapshot canary
@@ -115,7 +115,7 @@ pnpm run bump --snapshot canary
 
 该参数主要用于发布临时测试版本进行测试，不需要进行代码提交。
 
-- `--ignore` 发布时手动忽略部分包。
+- `--ignore`：发布时手动忽略部分包。
 
 例如本次发布你需要忽略 `module-2` 包：
 
@@ -133,19 +133,19 @@ pnpm run bump --ignore module-2 --ignore module-3
 
 ### release 命令参数
 
-- `--otp` 使用 `npm token` 执行 release 命令发布对应包
+- `--otp`：使用 `npm token` 发布包。
 
 ```bash
 pnpm run relese --otp <token>
 ```
 
-- `--tag` 本地发布使用特定的 tag，默认使用 `latest`
+- `--tag`：发布使用特定的 tag，默认使用 `latest`
 
 ```bash
 pnpm run release --tag <tag>
 ```
 
-- `--ignore-scripts` 发布时忽略 npm scripts。
+- `--ignore-scripts`：发布时忽略 npm scripts。
 
 执行 `publish` 命令时，npm 会自动触发很多命令，比如 `prepare`、`prepublish`，使用该参数可以忽略这些命令执行。该参数仅支持在使用 pnpm 的 Monorepo 中使用。
 
@@ -153,7 +153,7 @@ pnpm run release --tag <tag>
 pnpm run release --ignore-scripts
 ```
 
-- `--no-git-checks` 发布时忽略检查当前分支。
+- `--no-git-checks`：发布时忽略检查当前分支。
 
 执行发布命令时，默认会自动检查当前分支是否为发布分支，是否存在未提交变更等等，使用该参数可以忽略 git 相关检查。
 
@@ -165,7 +165,7 @@ pnpm run release --no-git-checks
 
 ### dependencies 或者 devDependencies 依赖
 
-#### patch 版本依赖只升级自身
+- patch 版本依赖只升级自身
 
 例如存在如下场景：
 
@@ -175,7 +175,7 @@ Monorepo 中存在两个包，`module-1` 和 `module-2`，`module-2` 的 `depend
 
 执行 bump 命令后将只会升级 `module-1` 的 patch 版本号。
 
-#### major / minor 版本自身升级 major 或者 minor 版本号，依赖包升级 patch 版本号
+- major / minor 版本自身升级 major 或者 minor 版本号，依赖包升级 patch 版本号
 
 例如存在如下场景：
 
@@ -187,7 +187,7 @@ Monorepo 中存在两个包，`module-1` 和 `module-2`，`module-2` 的 depende
 
 ### peerDependencies 依赖
 
-#### patch 版本依赖自身和依赖包都升级 patch 版本号
+- patch 版本依赖自身和依赖包都升级 patch 版本号
 
 例如存在如下场景：
 
@@ -197,7 +197,7 @@ Monorepo 中存在两个包，`module-1` 和 `module-2`，`module-2` 的 `peerDe
 
 执行 bump 命令后将 `module-1` 和 `module-2` 都升级 patch 版本号。
 
-#### major / minor 版本自身升级 major 或者 minor 版本号，依赖包升级 major 版本号
+- major / minor 版本自身升级 major 或者 minor 版本号，依赖包升级 major 版本号
 
 例如存在如下场景：
 
@@ -207,7 +207,7 @@ Monorepo 中存在两个包，`module-1` 和 `module-2`，`module-2` 的 `peerDe
 
 执行 bump 命令后将 module-1 将升级 `minor` 版本号， `module-2` 升级 `major` 版本号。
 
-#### 修改 peerDependencies 的升级策略
+- 修改 peerDependencies 的升级策略
 
 `peerDependencies` 的升级策略支持通过配置 `onlyUpdatePeerDependentsWhenOutOfRange` 来修改依赖升级策略，当只有超出声明的版本类型范围时，才对应升级 `peerDependencies`。
 

package/package.json

@@ -15,13 +15,13 @@
     "modern",
     "modern.js"
   ],
-  "version": "0.0.0-next-1686037191101",
+  "version": "0.0.0-next-1686045734613",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
   "peerDependencies": {
-    "@modern-js/builder-doc": "0.0.0-next-1686037191101"
+    "@modern-js/builder-doc": "0.0.0-next-1686045734613"
   },
   "devDependencies": {
     "classnames": "^2",
@@ -33,9 +33,9 @@
     "fs-extra": "^10",
     "@types/node": "^16",
     "@types/fs-extra": "^9",
-    "@modern-js/builder-doc": "0.0.0-next-1686037191101",
-    "@modern-js/doc-plugin-auto-sidebar": "0.0.0-next-1686037191101",
-    "@modern-js/doc-tools": "0.0.0-next-1686037191101"
+    "@modern-js/builder-doc": "0.0.0-next-1686045734613",
+    "@modern-js/doc-plugin-auto-sidebar": "0.0.0-next-1686045734613",
+    "@modern-js/doc-tools": "0.0.0-next-1686045734613"
   },
   "scripts": {
     "dev": "modern dev",