前言
在前端项目中，我们通常会使用一些开源的 npm 包或自己编写的 npm 包来处理项目的一些功能。而每次修改代码之后，为了方便团队成员知晓更新情况，我们都需要按照一定格式书写 changelog 文件，记录更新内容。为了减少手动编写 changelog 的时间和精力，本文介绍一个 npm 包 — write-changelog，它能够帮助我们自动生成 changelog。
write-changelog 介绍
write-changelog 是一个能够在项目中生成 changelog 文件的 npm 包，它支持多种格式的 changelog 文件生成，包括 Markdown，HTML，JSON 等。并且，write-changelog 可以根据 Git 提交记录自动生成 changelog。
安装 write-changelog
使用 npm 命令来安装 write-changelog：
npm install write-changelog --save-dev
write-changelog 命令
write-changelog 提供了一个命令行工具，我们可以使用该工具来生成 changelog 文件。
命令行选项
--format <format>：指定生成的文件格式，默认为 markdown--from <commit>：指定 changelog 开始的 Git 提交记录，默认为上次发布的版本--to <commit>：指定 changelog 结束的 Git 提交记录，默认为当前 HEAD（最新提交）
例子
生成 Markdown 格式的 changelog 文件
npx write-changelog --format markdown --from v1.0.0 --to HEAD
生成 HTML 格式的 changelog 文件
npx write-changelog --format html --from v1.0.0 --to HEAD
生成 JSON 格式的 changelog 文件
npx write-changelog --format json --from v1.0.0 --to HEAD
集成到 package.json 中
我们可以将 write-changelog 集成到 package.json 中，这样就可以通过 npm 命令来生成 changelog 文件。
新增 scripts
在 package.json 中新增一个 scripts，配置如下：
"scripts": {
"changelog": "write-changelog --format markdown --from v1.0.0 --to HEAD"
}其中，--format markdown 表示生成 Markdown 格式的 changelog，--from v1.0.0 --to HEAD 表示从 v1.0.0 到当前 HEAD（最新提交）的提交记录生成 changelog。
执行命令
执行以下命令：
npm run changelog
总结
write-changelog 是一个方便实用的 npm 包，能够帮助我们自动生成 changelog 文件。通过本文的介绍，你已经了解了如何安装和使用 write-changelog，以及如何将其集成到 package.json 中。写好 changelog，让团队合作更加高效，让项目开发更加稳定！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f2c927b3b0ab45f74a8bb94