简介
mt-changelog 是一款用于生成项目变更日志的 npm 包。它可以根据 git commit 记录自动生成一个简洁明了的变更日志，方便团队成员查看项目最新进展。
安装
使用 npm 安装 mt-changelog：
--- ------- ------------ ----------
安装完成后，在项目中引入 mt-changelog：
----- ----------- - ------------------------
使用
1. 初始化配置文件
在项目的根目录下创建一个名为 changelog.config.js 的文件，并添加以下配置内容：
-------------- - -
------ -
- ----- ------- -------- ------ --
- ----- ------ -------- ------ --
- ----- ------- -------- ------ -
--
-------- ----------
----------- ----------------
--上述配置文件指定了变更类型、排除类型和输出文件路径等信息。其中，types 数组定义了变更类型及其所属的小节名称；exclude 数组定义了需要排除的变更类型；outputFile 指定了输出的变更日志文件路径。
2. 生成变更日志
在命令行中执行以下命令即可生成变更日志：
--- ------------
执行完成后，会在指定的输出文件路径下生成一个名为 CHANGELOG.md 的变更日志文件。
示例
在项目中提交以下两次 commit：
----- ------ ---- ----------
按照上述配置文件生成的变更日志如下：
- ---- -- ---- - ------ -- ---- - ----------
总结
通过使用 mt-changelog，我们可以方便地为项目生成变更日志，并且可以根据自己的需要进行灵活配置。同时，变更日志的生成也可以帮助团队成员更好地了解项目的最新进展，提高协作效率。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/46339