npm 包 conventional-changelog-ui-router-core 使用教程

阅读时长 6 分钟读完

前言

随着前端开发的不断发展,前端项目的复杂度也越来越高,如何管理和维护项目的变更历史成为了一个非常重要的问题。而 conventional-changelog-ui-router-core 正是一款实现了这一功能的 npm 包,可以帮助开发者更加方便地管理和查看项目的变更历史。本文将介绍如何使用该 npm 包。

安装

在开始使用之前,你需要先安装 conventional-changelog-ui-router-core。可以通过 npm 命令进行安装:

配置

安装完成后,需要进行一些配置。在项目的 package.json 文件中添加以下配置:

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

其中:

  • preset: 指定 changelog 的预设规则,这里我们使用 angular 的预设规则。
  • outputUnreleased: 是否输出未发布的变更历史(即当前修改未打 tag)。
  • outputMarkdownTable: 输出 markdown 格式的变更历史。
  • commitUrlFormat: 显示 commit 的链接地址。
  • compareUrlFormat: 显示版本比较的链接地址。
  • types: 指定变更历史中的分类,可根据实际情况进行修改。

使用

完成了配置后,我们就可以使用 conventional-changelog-ui-router-core 生成变更历史了。可以通过执行以下命令生成:

其中:

  • -p angular: 指定预设规则。
  • -i CHANGELOG.md: 指定输出文件的名称。
  • -s: 从第一个 tag 开始输出。
  • -r 0: 最多输出一个版本的变更历史。

以上命令会生成一个 markdown 格式的变更历史文件 CHANGELOG.md。我们还可以通过执行以下命令生成 html 格式的变更历史:

生成的变更历史文件为 CHANGELOG.html

示例代码

以下是一个完整的示例代码:

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

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

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

总结

conventional-changelog-ui-router-core 是一款非常好用的 npm 包,可以帮助我们更加方便地管理和查看项目的变更历史。它的配置也非常简单,只需要按照上面的步骤进行即可。希望本文能够帮助大家更好地使用该 npm 包。

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