npm 包 conventional-changelog-ember 使用教程

阅读时长 3 分钟读完

简介

conventional-changelog-ember 是一个可以帮助前端项目实现自动化 changelog 生成的 npm 包。它使用了 Ember.js 的命名规范,同时兼容了 Conventional Commits 规范。通过使用它,我们可以方便地在项目中生成高质量的 changelog,提升项目的可读性和可维护性。

安装

使用 conventional-changelog-ember 前,需要先安装它。可以通过以下命令进行安装:

配置

安装完成之后,我们需要对其进行配置。在项目根目录下创建 .conventional-changelog-ember.js 文件。具体配置如下:

-- -------------------- ---- -------
-------------- - -
  -------- -
    - ------- ------- ---------- ----- --
    - ------- ------ ---------- ------ --
    - ------- ------- ---------- ------ --
    - ------- -------- ---------- ------ --
    - ------- ----------- ---------- ------ --
    - ------- ------- ---------- ------ --
    - ------- ------- ---------- ------ --
    - ------- -------- --------- ---- --
    - ------- --------- --------- ---- -
  -
-
展开代码

以上代码中,我们定义了常用的修改类型(type),并指定了对应的变更类型(section),同时也可以隐藏某些不必要的修改类型。

使用

在完成了安装和配置之后,我们就可以使用 conventional-changelog-ember 生成 changelog。使用以下命令:

其中,-p 指定了解析器(parser),这里选择使用 anguler;-i 指定了 changelog 文件名;-s 指定了是否需要将新的 changelog 追加到原来的 changelog 中;-r 指定了应该从哪个版本开始生成 changelog,这里选择从 0 开始。

执行完毕后,我们就可以在项目目录下看到生成的 CHANGELOG.md 文件了。

结论

conventional-changelog-ember 是一个非常实用的 npm 包,它能够帮助我们自动生成高质量的 changelog,提升项目的可读性和可维护性。在使用它的过程中,我们需要进行一些简单的配置,并遵循一定的命名规范,即可轻松地生成 changelog。

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

纠错
反馈

纠错反馈