简介
在开发过程中，对于一个项目的变更日志是非常重要的一部分，可以帮助我们跟踪项目的进程，更好地了解项目的变化，以及记录项目的历史。@deja-js/generate-changelog 是一个基于 conventional-changelog 的 npm 包，可以帮助我们自动生成项目的变更日志。
安装
在使用 @deja-js/generate-changelog 之前，需要先安装 Node.js。然后使用以下命令安装 @deja-js/generate-changelog：
npm install -g @deja-js/generate-changelog
使用
@deja-js/generate-changelog 的使用非常简单。在项目的根目录下，执行以下命令将会生成一个变更日志：
generate-changelog
@deja-js/generate-changelog 会从 Git 提交信息中提取变更日志，并按照规定的格式输出到控制台。例如：
-- -------------------- ---- ------- -- ----- - ---------- --- -------- - --- --- -------- ------ - --- --- -------- ------ --- --- ----- - --- --- -------- ------
我们也可以将输出保存到文件中：
generate-changelog -o CHANGELOG.md
配置
@deja-js/generate-changelog 默认使用 conventional-changelog 的配置。如果我们需要自定义配置，可以使用 -c 或 --config 参数指定配置文件的路径。例如：
generate-changelog -c ./.changelogrc
配置文件的语法如下：
-- -------------------- ---- -------
-
-------- -
-
------- -------
---------- -----------
--------- -----
--
-
------- ------
---------- ---- -------
--------- -----
-
--
------------------ ----------------------------------------------
-示例代码
下面是一个示例项目的代码，可以用于测试和学习 @deja-js/generate-changelog 的使用：
-- -------------------- ---- ------- ----- --- - --- -- -- - ------ - - -- -- ----- --- - --- -- -- - ------ - - -- -- ----- --- - --- -- -- - ------ - - -- -- ------ --- -- - ------ --- -- - ------ --- -- -
总结
@deja-js/generate-changelog 是一个非常实用的自动化工具，可以帮助我们更好地管理项目的变更日志。本文介绍了 @deja-js/generate-changelog 的安装、使用、配置以及示例代码，希望能对读者有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600562ff81e8991b448e0d35