简介
obg-conventional-changelog 是一个帮助前端工程师和开发组织和记录每次变更的 npm 包。该工具可以帮助开发人员维护好一个良好的变更日志，以便更好的进行版本管理和追踪。
安装
npm install obg-conventional-changelog --save-dev
配置
创建一个 .conventional-changelog.js 文件，然后按照格式配置字段：
-- -------------------- ---- -------
-------------- - -
------ -
- ----- ------- -------- ---------- --
- ----- ------ -------- ---- ------ --
- ----- -------- -------- -------- --
- ----- ------- -------- --------------- --
- ----- -------- -------- -------- --
- ----- ----------- -------- ------------- --
- ----- ------- -------- ------------- --
- ----- ------- -------- ------- --
- ----- -------- -------- ------ ------- --
- ----- ----- -------- ------- --
- ----- --------- -------- --------- --
- ----- ------ -------- ----- -- --------- -
--
------- ------------
--------------------------- ---------------- -------------- ----- -----
--------------------------- ---------------- -------------- ----- -----
---------------- ---------------------------------------------------------
-----------------
---------------------------------------------------------------------------------
-使用
生成一份 CHANGELOG.md 文件
npx conventional-changelog -p angular -i CHANGELOG.md -s
- -p (--preset) angular 参数表示我们需要使用的格式预设，按照惯例是使用 angular 的格式。
- -i (--infile) CHANGELOG.md 参数表示用该文件来记录变更日志。
- -s (--same-file) 参数表示将生成的内容直接加入到 CHANGELOG.md 文件末尾。
如果你希望使用默认配置，可以直接使用以下命令：
npx conventional-changelog -i CHANGELOG.md -s
写入一条新的变更
npm run changelog-add
清空 CHANGELOG.md 文件
npm run changelog-clear
定时更新 CHANGELOG.md 文件
npm run changelog-autoupdate
总结
obg-conventional-changelog 可以帮助团队有效的记录并管理变更历史，从而更好的进行版本管理和追踪。它对开发流程的约定非常符合前端开发团队的习惯，从而避免了文档失灵的问题。
在开发项目的过程中，为了更好的管理变更历史，使用 obg-conventional-changelog 是非常必要的，因为在开发过程中有很多次的变更，而这些变更通常不是一份文档就可以涵盖的，所以在从多个方面保障项目变更历史记录的同时，也增加了一个更方便的管理渠道。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066f9c3d1de16d83a66e8b