npm 包 @favoloso/conventional-changelog-emoji 使用教程

阅读时长 5 分钟读完

介绍

在前端开发中,我们经常需要进行版本控制和 changelog 的管理。而传统的 changelog 往往难以阅读和理解,这时候使用表情符号可以使得 changelog 更加清晰明了。@favoloso/conventional-changelog-emoji 就是一个为 changelog 添加表情符号的 npm 包。

安装

使用 npm 安装 @favoloso/conventional-changelog-emoji:

使用

配置文件

在使用 @favoloso/conventional-changelog-emoji 之前,你需要创建一个 conventional-changelog.yml 配置文件,指定 changelog 的格式、标签和表情符号。示例配置如下:

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

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

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

生成 changelog

使用 conventional-changelog 命令生成 changelog:

这里的 p 参数指定使用的 changelog 格式(可以选择其他 preset),i 参数指定生成的 changelog 文件名,s 参数指定是否排序,r 参数指定版本区间,这里选取所有版本(0 表示所有版本)。

如果你已经把 @favoloso/conventional-changelog-emoji 添加到了全局安装的包中,你可以使用以下命令生成 changelog:

结果

根据上面的配置,@favoloso/conventional-changelog-emoji 生成的 changelog 如下:

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

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

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

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

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

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

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

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

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

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

总结

使用 @favoloso/conventional-changelog-emoji 可以使得 changelog 更加直观易懂,同时也提高了开发者的使用体验。为了让 changelog 更加优秀,我们需要配置一个符合我们实际项目的 conventional-changelog.yml 文件。

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

纠错
反馈