在前端开发的过程中,我们经常需要维护一些项目,包括但不限于 Web 应用、移动应用、桌面应用等等。这些项目都需要进行版本管理,而版本管理又需要十分规范、符合标准,以方便项目的迭代和协作开发。在这个过程中,npm 包 conventional-changelog-common
就显得非常重要了。
什么是 conventional-changelog-common
?
conventional-changelog-common
是一个基于标准化 commit message 自动生成 changelog 的工具包,适用于 Node.js 环境。通过使用这个工具包,我们可以将 commit message 自动分类为 feat、fix、docs、style、refactor、perf、test、chore 等标准类型,然后自动生成对应的 changelog,以方便项目的迭代和协作开发。
为什么要使用 conventional-changelog-common
?
传统的 changelog 文件需要手动编辑,十分繁琐,而且容易出现格式不统一等问题。而使用 conventional-changelog-common
可以大大简化 changelog 的维护工作,同时在代码提交时就规范 commit message 的写法,提高项目整体代码的质量。
如何使用 conventional-changelog-common
?
在项目中安装 conventional-changelog-common
:
npm install conventional-changelog-common --save-dev
在项目根目录下添加配置文件 .cz-config.js
,定义我们预定义的标准话 commit message 规则:
-- -------------------- ---- ------- -------------- - - -- ----- ------ - - ------ ------- ----- ------ ----- -- - ------ ------ ----- ----- -- ---- -- - ------ ------- ----- ------ ----- -- - ------ -------- ----- ------- ----------------- -- - ------ ----------- ----- ---------- ------------------ ----- -- - ------ ------- ----- ------ ----- -- - ------ ------- ----- ------ ----- -- - ------ -------- ----- ------- ------------- -- - ------ --------- ----- -------- --------- -- - ------ -------- ----- ------- ----- -- -- -- -- ----- ---- ------- -- ----- ----------- -- - ----- -------- -- - ----- -------- --- -- -------- --- --------- -------- --- -- ------- --------- - ----- -------------- ------ ------ ----- ------- ------------ ---- -------- -------- -------- ----- ---------------------- --------- ------------------- ------- --- ---- -- - ----------- ----------- ------- -------------- -------- -- -- -------- -------------- ------------- -- ------- --------------- ------------- --- -------------- ---- -- - ---- ------------- ------------- ------- ------ --
在 package.json
的 scripts
中添加对应的命令:
{ "scripts": { "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0 && git add CHANGELOG.md && git cz" } }
然后我们就可以通过运行 npm run changelog
命令来创建并更新 CHANGELOG.md 文件了。
总结
conventional-changelog-common
的使用,可以极大提高我们项目的代码质量和规范化,让我们远离繁琐的手动编辑 changelog 的工作。同时,规范的 commit message 也能让我们更好的跟进项目的开发进程,提高团队的协作效率,是前端开发必不可少的工具包。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600671a830d0927023822708