随着前端开发的发展，项目变得越来越复杂，代码也变得更加多样化。为了更好地管理和维护项目，我们需要借助一些工具来规范化代码的提交信息和版本管理。本文将介绍一个非常实用的 npm 包，conventional-changelog，它可以帮助我们规范化提交信息，生成 changelog 文件，并按照 semver 规则自动更新版本号。
什么是 conventional-changelog
conventional-changelog 是一款基于 GitHub flow 工作流程的规范化的提交信息和版本管理工具。它可以帮助开发者规范化提交信息的格式、生成 changelog、维护 semver 版本，并严格按照规范管理 git 提交日志。
安装
可以使用 npm 全局安装 conventional-changelog：
npm install -g conventional-changelog
使用
规范化提交信息
conventional-changelog 规定了一些规范化的提交信息格式。在提交代码时，我们需要按照其规范标准来填写提交信息。具体规范见官方文档。
生成 changelog
在项目根目录下执行以下命令，即可生成 changelog 文件：
conventional-changelog -p angular -i CHANGELOG.md -s
其中 -p 参数指定了使用的规范化插件，-i 参数指定了 changelog 文件的名称，-s 参数代表着覆盖掉原来的 changelog 文件。
这时，就会在项目根目录下生成一个新的 changelog 文件。
更新版本
在 changelog 生成之后，conventional-changelog 会自动根据 semver 规则更新版本。我们需要手动修改 package.json 中的版本号，然后执行以下命令：
npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease] [-m <commit-message> | -f]
其中 <newversion> 代表新版本号，使用 major/minor/patch 等参数来自动更新版本号，-m 参数指定提交信息。执行该命令后，npm 会自动更新版本号，并自动生成一个 git 提交记录。
集成到项目中
conventional-changelog 可以通过集成到项目脚本中来使用。我们可以使用 gulp 等构建工具，在添加新代码、修改代码和发布版本时，自动提交 changelog 和版本号。
下面是一个使用 gulp 集成 conventional-changelog 的示例代码：
-- -------------------- ---- ------- --- ---- - ---------------- --- --------------------- - --------------------------------------- --- ---- - --------------------- --- --- - -------------------- --- ------ - ----------------------- --- ----------- - ---------------------------- ---------------------- -------- -- - ------ ------------------------ - ------- ----- -- ----------------------------- ------- --------- --- ----------------------- --- ----------------- ----------- ------ -------------------------- --------------------------- ---------------------- ----------------------- ------- ---------- ----------------------------- --------------------- ---展开代码
在上述代码中，我们使用 gulp-conventional-changelog 和 gulp-bump 来自动生成 changelog 并更新版本号。
结语
conventional-changelog 是一个非常实用的工具，它可以帮助我们规范化提交信息，生成 changelog 文件，并自动维护版本号。在项目中集成 conventional-changelog，可以极大地提高项目的维护效率，减少出错的可能性。建议开发者在自己的项目中积极使用。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/40346
