npm 包 @zazen/conventional-changelog 使用教程

阅读时长 5 分钟读完

随着前端技术的不断发展,我们在开发过程中所依赖的库和包也越来越多,而如何管理这些包的版本号,提交信息等等是一个很重要的问题。在这个问题上,npm 包 @zazen/conventional-changelog 就成为了一个非常不错的选择。本文就将带领大家了解这个包的使用方法。

什么是 @zazen/conventional-changelog

@zazen/conventional-changelog 是一个基于 conventional-changelog 的 npm 包。它的主要作用是通过使用规范的提交信息,生成 ChangeLog 和版本号等信息,并且能够自动地根据 git 的提交历史生成版本更新信息。

安装和使用

使用该包,我们需要全局安装 conventional-recommended-bumpconventional-changelog-cli

安装完毕后,我们可以在工程目录下运行 conventional-recommended-bump 命令来确定下一个应该发布的版本号。可以通过 --preset 参数指定配置规范,如 --preset angular

确定了版本号后,我们就可以运行 conventional-changelog 来生成更新日志了。同样,可以通过 --preset 参数指定配置规范。下面是一个生成基于 Angular 规范的更新日志的例子:

其中,-i 参数指定输出到的文件,-s 参数表示使用插入方式。生成的日志文件如下:

-- -------------------- ---- -------
- ---------

-- -------------------------------------------------------------------- ------------

--- --------

- --- --- --- --------------------------------------------------------------
- ------ --- --------------------------------------------------------------

--- --- -----

- --- --- --------------------------------------------------------------

-- -------------------------------------------------------------------- ------------

---

生成的日志将按照时间倒序排列,最新的版本放在最上面,每个版本会列出其新增、变更和移除的功能,以及修复的 bug。通常我们会将这个日志文件添加到 Git 的提交中,然后提交并推送到远程仓库中。

为什么要使用 @zazen/conventional-changelog

上面我们已经解释了 @zazen/conventional-changelog 的主要作用和用法。那么,为什么我们要使用它呢?下面是一些使用 @zazen/conventional-changelog 的好处:

  1. 标准化:@zazen/conventional-changelog 是基于常用的提交信息规范而生成的更新日志。这一点对于多人协同开发来说是非常有帮助的,可以让不同人的提交信息保持一致,并且能够使得更新日志更加容易被阅读。

  2. 自动化:使用 @zazen/conventional-changelog 后,我们可以通过简单的命令就能够生成更新日志和版本号等信息,不需要手动编辑或者增加额外的工作量。

  3. 适应性:@zazen/conventional-changelog 支持多种提交信息规范,如 angular, eslint 和 jquery 等主流的规范。这使得它可以适应不同的开发需求和场景。

总结

在现代前端开发中,管理 npm 包和版本号是一个很重要的工作。使用 @zazen/conventional-changelog 可以让我们更好地管理这些工作,并且在多人协作时能够使得提交信息保持一致。本文介绍了使用 @zazen/conventional-changelog 的方法,并总结了其使用的好处。希望能够对您有所帮助!

参考

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5f29213a3b0ab45f74a8ba86

纠错
反馈