简介
conventional-changelog-writer 是一个 Node.js 模块，它可以根据 Git 提交信息生成符合 AngularJS Commit Message Conventions 标准的 CHANGELOG.md 文件。
安装
你可以通过 npm 安装 conventional-changelog-writer：
--- ------- -- -----------------------------
使用
命令行使用方式
首先，你需要在项目根目录下创建一个名为 changelog.config.js 的配置文件，内容如下：
-------------- - -
---- -
-------------- -
----------- - --- - ------------
------ ----
-
--
---------- -------------
--其中，pkg.transform 选项用于自定义版本号的格式，tagPrefix 选项用于指定 Git Tag 的前缀。
接着，在命令行中执行以下命令：
----------------------------- -- ------- -- ------------ -- -- -
其中，-p 选项用于指定提交信息风格，这里选择了 AngularJS Commit Message Conventions；-i 选项用于指定输出文件名，这里是 CHANGELOG.md；-s 选项用于从 Git Tag 开始生成 CHANGELOG.md 文件；-r 选项用于指定从最近的版本开始生成 CHANGELOG.md 文件，这里选择了最近的一次提交（即 -r 0）。
如果你想生成所有版本的 CHANGELOG.md 文件，可以执行以下命令：
----------------------------- -- ------- -- ------------ -- -
JavaScript API 使用方式
你也可以在代码中使用 conventional-changelog-writer，首先需要安装模块：
--- ------- -----------------------------
接着，在代码中引入模块并调用 writer 函数：
----- -- - --------------
----- - ------ - - -----------------------------------------
----- ------ - -
---- -
-------------- -
----------- - --- - ------------
------ ----
-
--
---------- -------------
--
----- ------- - -
------- ----------
------------- -
--
-------------- ----------------------------------------------------其中，config 和 options 对象分别对应命令行参数 -c 和 -p。
总结
conventional-changelog-writer 可以帮助我们自动化生成符合规范的 CHANGELOG.md 文件，提高项目管理效率。如有任何问题或建议，请在 Issue 中提出。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/49573