简介
changelog-maker 是一个基于 Node.js 开发的 CLI 工具，用于生成项目的 ChangeLog 文件。它可以从 Git 提交记录自动生成项目的版本变更记录，包括新增功能、修复 bug、性能优化等内容。
本文将介绍 changelog-maker 的安装和使用，以及如何集成到你的项目中。
安装
全局安装 changelog-maker：
npm install -g changelog-maker
使用
初始化配置文件
在项目根目录下新建文件 .changelog-maker.json，并写入以下内容：
-- -------------------- ---- -------
-
--------- -----------
---------------------- -----
------------------ -----------------------------------------
---------------------- -- -- ------------
---------- -------------------------------
----------- -
-
-------- ---- -------
------- ------------
-------- ----
--
-
-------- ---- ----------
------- -----------------
-------- ---
--
-
-------- ------------ --------------
------- ---------------------
-------- ----
--
-
-------- ----------------
------- -------------
-------- ----
--
-
-------- ---------
------- ----
-
-
-上面的配置文件包括了以下几个选项：
format: ChangeLog 文件的格式，支持 markdown、json、text 等。groupSimilarCommits: 是否将相似的提交记录合并为一个条目，以省略冗余信息。commitUrlFormat: 提交记录的 URL 格式，用于生成链接 URL。commitMessageFormat: 提交记录的信息格式，用于生成 ChangeLog 条目。repoUrl: 项目的 URL，用于生成链接 URL。sections: ChangeLog 的各个分区，包括标题、正则表达式和 emoji。
生成 ChangeLog
在项目根目录下运行以下命令即可生成 ChangeLog 文件：
changelog-maker
程序会自动从 Git 记录中获取提交记录，并按照 sections 字段中的正则表达式进行分类，最终生成 ChangeLog 文件。
集成到项目中
可以将 changelog-maker 集成到项目的构建流程中，在每次发布时自动生成 ChangeLog 文件。将以下命令加入发布流程即可：
npm run changelog
其中，npm run changelog 要在 npm version 命令之前运行，以保证版本号变更已经在 ChangeLog 中记录完毕。
以下是一个示例的 package.json：
{
"name": "my-project",
"version": "1.0.0",
"scripts": {
"changelog": "changelog-maker && git add CHANGELOG.md",
"version": "npm run changelog && git commit -a -m \"chore: update changelog\" && npm version"
}
}其中，version 命令将在每次发布时更新版本号、生成 ChangeLog 文件并提交 Git 记录。
总结
本文介绍了 npm 包 changelog-maker 的安装和使用，以及如何将其集成到项目中。通过自动生成 ChangeLog 文件，可以帮助开发团队更好地管理项目，并且方便用户了解版本更新情况。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/57816