在前端开发中，发布版本是非常重要的一项任务。版本的发布需要经过机制审核、测试、代码质量检查等多个环节。为了更好的管理版本，开发人员可以使用 conventional-changelog-angular-vstst 工具包来生成标准的发布版本日志。本文将介绍该工具包的使用教程。
什么是 conventional-changelog-angular-vstst
conventional-changelog-angular-vstst 是一个可用于生成标准版本更新日志的 npm 包。使用该工具，您可以根据您的提交记录自动生成具有标准格式的更新日志。核心思想是约定式提交，让提交信息包含更多的上下文信息。可以解决更多人参与项目开发的时候，难以统一 Commit message 格式，更新情况的不透明度等问题。
安装 conventional-changelog-angular-vstst
首先您需要在项目中安装 conventional-changelog-angular-vstst，您可以使用以下命令进行安装：
npm install --save-dev conventional-changelog-angular-vstst
该命令会将 conventional-changelog-angular-vstst 安装到项目的开发依赖中。
使用 conventional-changelog-angular-vstst
conventional-changelog-angular-vstst 提供了一些 CLI 命令和配置文件来帮助您生成版本更新日志。
命令行工具
使用以下命令行工具来操作 conventional-changelog-angular-vstst：
conventional-changelog: 使用默认或自定义的配置文件生成更新日志。conventional-commits-detector: 如果您在提交信息中使用了约定式提交的格式，则会将信息打印到控制台。否则，该命令将不起作用。该命令用于检测提交信息是否符合约定式提交的格式。如果您想在提交代码之前检查您的提交信息，这个命令会很有用。
配置文件
conventional-changelog-angular-vstst 提供了一个默认的配置文件，您也可以自定义一个 .conventional-changelog 文件来控制输出的格式。以下是默认配置文件的示例：
-- -------------------- ---- -------
-
-------- -
- ------- ------- ---------- ---------- --
- ------- ------ ---------- ---- ------ --
- ------- -------- --------- ---- --
- ------- ------- --------- ---- --
- ------- -------- --------- ---- --
- ------- ----------- --------- ---- --
- ------- ------- --------- ---- --
- ------- ------- --------- ---- -
-
-可以使用以下命令来自定义配置文件：
conventional-changelog -p <path-to-config-file>
您可以在配置文件中添加自定义类型、隐藏类型等。详见 官方文档。
示例
以下是在 Angular 项目中生成版本更新日志的示例：
确保您已在项目中安装了
conventional-changelog-angular-vstst，使用命令行切换到项目的根目录下。运行以下命令，将生成类型为
feat和fix的提交更新日志。
conventional-changelog -p angular -i CHANGELOG.md -s -r 0
说明：
-p angular指定了使用默认的 Angular 配置文件。-i CHANGELOG.md指定输出到 CHANGELOG.md 中。-s指定生成版本的起始点为当前版本。-r 0指定要生成哪些 Tags 之间的更新日志。
- 执行以上命令后，您会看到生成的更新日志保存在
CHANGELOG.md中。
约定式提交
conventional-changelog-angular-vstst 工具包的核心思想是约定式提交。它要求您在提交更新前，遵循以下规则：
- 每次提交的格式必须为："
type:subject"。 type是必选字段，并且必须是以下列表中的一个：build,chore,ci,docs,feat,fix,perf,refactor,revert,style,test。subject是必选字段，是一个简短的描述。
例如，当您提交了一个修复 Bug 的更新时，应该按照以下格式提交：
fix: 修复某个 Bug
除此之外，具体的格式约定也有更加详细的规则，可以参考官方文档进行查看。
总结
本文介绍了如何使用 conventional-changelog-angular-vstst 工具包来帮助您生成标准的版本更新日志。您可以自定义配置文件，以控制输出的格式。同时，我们也讲述了使用约定式提交的规则，这是工具包的核心思想之一。相信在您的开发中，使用 conventional-changelog-angular-vstst 工具包将会给您带来很大的帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005590881e8991b448d664f