在开发前端项目时，我们通常需要对代码进行版本控制，并随着项目的迭代逐渐更新版本。而随着版本的不断增加，我们也需要及时地生成 changelog，以清晰地记录每个版本的变化及新增功能。这时，npm 包 git-changelog 就可以派上用场了。
什么是 git-changelog？
git-changelog 是一个 npm 包，旨在帮助开发者在 git 上生成 changelog。它通过解析 git 的 commit 记录，并根据 commit message 的格式来生成 changelog。与手动编写 changelog 不同的是，git-changelog 可以快速准确地生成 changelog，让我们可以更好地专注于代码的开发与维护。
如何使用 git-changelog？
下面是 git-changelog 的使用示例及一些注意事项。
安装 git-changelog
使用 npm 进行安装：
npm install -g git-changelog
生成 changelog
在项目根目录下执行以下命令，即可生成 changelog：
git-changelog -t v
-t 参数用于指定生成的版本范围，这里的 v 表示所有以字母 v 开头的版本，如 v1.0.0、v1.1.0。
除了 -t 参数，还有一些其他参数需要了解：
- -h：查看帮助信息
- -v：查看版本信息
- -o：输出文件路径
- -d：日期格式
- -s：生成 changelog 的样式
指定 commit message 格式
默认的 commit message 格式可以不用自己指定，但对于项目需要的特定格式，可以在项目根目录下新建名为 .changelogrc 的文件，配置格式规则。
例如，以下内容是一个格式规则示例：
-- -------------------- ---- -------
-
-------- -
------- -
-------- ----------
--
------ -
-------- ---- ------
--
------- -
-------- ------
--
-------- -
-------- --------
--
----------- -
-------- ----- ------------
--
------- -
-------- ------------ -------------
--
------- -
-------- -------
--
-------- -
-------- ------ -------
--
----- -
-------- ----------- ------------
--
-------- -
-------- --------
-
--
----------- -
--------- -- --------- -------------
------ ---------
-
-以上规则中，指定了一些常见 commit message 类型及其对应的 title。
整合到项目中
为了更加方便地使用 git-changelog，我们可以将其整合到项目脚本中，比如结合 npm scripts，使用以下命令：
{
"scripts": {
"changelog": "git-changelog -t v > CHANGELOG.md"
}
}运行 npm run changelog 命令即可生成 changelog，并保存到项目根目录下的 CHANGELOG.md 文件中。
小结
git-changelog 是一款优秀的 npm 包，能够帮助我们快速地生成 changelog。在开发过程中，使用 git-changelog，可以帮我们更好地跟进项目进度，记录重要的变化，并提高项目的可维护性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64704