npm 包 conventional-changelog-cli 使用教程

介绍

conventional-changelog-cli 是一个用于生成规范化的 changelog 的 npm 包。该包可以根据提交信息自动生成 changelog,支持多种 commit 规范,例如 Angular、Ember 等。

本文将详细介绍如何安装和使用 conventional-changelog-cli。

安装

首先需要全局安装 conventional-changelog-cli:

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

使用

初始化

运行以下命令来初始化 conventional-changelog:

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

该命令将在当前目录下创建一个名为 CHANGELOG.md 的文件,并将最新的提交信息写入其中。-s 参数表示将生成的内容写入文件而不是终端。

更新

运行以下命令来更新 changelog:

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

-r 参数表示远程仓库地址,0 表示使用当前分支作为版本号。该命令会查找所有未记录到 CHANGELOG.md 中的提交信息,并将其添加到文件中。

格式化

运行以下命令来格式化 changelog:

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

-p 参数表示使用哪个 commit 规范进行格式化。例如使用 Angular 规范,该命令会将 CHANGELOG.md 文件按照规范格式化。

示例代码

以下是使用 Angular 规范的示例提交信息:

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

----------

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

该提交信息可以生成以下 changelog:

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

--- -----

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

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

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

- ---------

--- --------

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

结论

conventional-changelog-cli 是一个非常有用的 npm 包,可以帮助前端开发人员自动生成规范化的 changelog。熟练掌握其使用方法对于团队协作和项目管理都有很大的帮助。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/47445


猜你喜欢

  • npm包utils-flatten使用教程

    utils-flatten是一个常用的npm包,可以将多维嵌套的数据结构(如数组、对象等)展开为一维数组。在前端开发中,我们经常需要处理多层次的嵌套数据,使用该工具包可以轻松地将其扁平化,方便后续处理...

    6 年前
  • npm 包 m_flattened 使用教程

    在前端开发中,我们常常需要处理多层嵌套的 JSON 数据。m_flattened 是一个方便的 npm 包,它可以将多层嵌套的 JSON 数据展平成一层,并提供了一系列方法用于对展平后的数据进行操作。

    6 年前
  • npm 包 arr-flatten 使用教程

    在前端开发中,经常需要处理层级嵌套的数据结构,例如树形结构、多层嵌套的数组等。对于这种情况,我们可以使用 arr-flatten 这个 npm 包来进行扁平化操作,使得数据结构更加易于处理和操作。

    6 年前
  • npm 包 ansi-bold 使用教程

    在前端开发中,终端输出调试信息是一项非常重要的任务。然而,有时候我们需要强调某些信息,使其更容易被注意到。这时候就可以使用 ansi-bold 这个 npm 包来实现。

    6 年前
  • npm 包 arr-union 使用教程

    在前端开发中,处理数组是非常普遍的需求。而在 JavaScript 中,有一个名为 arr-union 的 npm 包可以方便地帮助我们合并多个数组并去重。本文将详细介绍如何使用这个包以及一些注意事项...

    6 年前
  • npm 包 ansi-yellow 使用教程

    在前端开发中,我们经常需要在控制台打印信息,以便于调试和查错。而有时候,我们希望突出某些信息,使其更易于识别。这时,就可以使用颜色来区分不同类型的信息。npm 包 ansi-yellow 正是为此而生...

    6 年前
  • npm 包 engine-utils 使用教程

    简介 engine-utils 是一个 Node.js 模块,旨在解析和比较版本号。它可以帮助前端开发人员在项目中正确地使用依赖包,并确保这些包满足所需的 Node.js 版本。

    6 年前
  • npm 包 engine-lodash 使用教程

    简介 engine-lodash 是一个基于 lodash 的 JavaScript 工具库,用于在 Node.js 环境下对数据进行快速、可靠的处理和转换。该工具库在许多开源项目中广泛应用,并得到了...

    6 年前
  • npm包data-store使用教程

    简介 data-store 是一个npm包,它提供了一个简单的JavaScript对象来存储和检索数据。这个对象可以在不同的模块之间共享,因此它非常适合在前端项目中使用。

    6 年前
  • npm 包 cwd 使用教程

    背景介绍 npm 是 Node.js 生态中常用的包管理工具,通过它可以轻松地安装、升级、删除依赖包。在使用 npm 安装依赖包时,我们经常会看到 cwd 这个参数。

    6 年前
  • npm 包 calculate-assets 使用教程

    在前端开发过程中,经常需要对资源文件进行计算,如图片、脚本、样式表等。而 npm 包 calculate-assets 可以帮助我们更轻松地完成这些计算。本文将介绍如何使用该 npm 包,并提供详细的...

    6 年前
  • npm 包 computed-property 使用教程

    computed-property 是一个常用的 JavaScript 库,它提供了一种方便和高效的方式来处理对象属性的计算。本文将介绍如何使用这个库进行前端开发。

    6 年前
  • npm 包 composer 使用教程

    什么是 npm 包 composer? npm 是 Node.js 的包管理器,它允许开发者共享和重复使用代码包。而 npm 包 composer 则是一个用于生成可重用的 npm 包的工具,它能够自...

    6 年前
  • npm 包 get-first 使用教程

    在前端开发中,我们经常需要从一个数组或对象中获取第一个非假值,这时候可以使用 get-first 这个 npm 包来简化代码。本文将为大家介绍 get-first 的使用方法和相关注意事项。

    6 年前
  • npm 包 gulp-drafts 使用教程

    简介 对于前端工程师来说,自动化是必不可少的一部分。而 Gulp 是自动化构建方案中使用最广泛的一个,它可以帮助你完成编译、压缩、发布等一系列操作,而且还可以通过插件扩展功能。

    6 年前
  • npm包parse-git-config的使用教程

    简介 如果你曾经在前端开发中使用git版本控制,那么你肯定会使用.gitconfig文件来配置git命令行。npm包parse-git-config是一个可以解析.gitconfig文件内容的工具,它...

    6 年前
  • npm 包 git-config-path 使用教程

    介绍 git-config-path 是一个用于获取 Git 配置文件路径的 npm 包。在前端开发中,我们经常需要对 Git 进行配置,例如配置用户名、邮箱地址、颜色等。

    6 年前
  • npm 包 git-user-name 使用教程

    当你想在你的前端项目中显示出当前 Git 用户名时,你可以使用 git-user-name npm 包。这个包提供了一种简便方法来获取当前 Git 用户名,并将其集成到你的代码中。

    6 年前
  • npm 包 helper-license 使用教程

    在前端开发中,我们经常会使用到许多第三方的 npm 包。然而,在使用这些包时,我们也需要遵守相应的许可证规定。helper-license 是一个非常实用的 npm 包,可以帮助我们快速查看和解析各种...

    6 年前
  • npm 包 try-open 使用教程

    简介 在前端开发中,我们经常需要打开外部链接或本地文件。try-open 是一个可以帮助我们快速打开链接或文件的 npm 包。它能够根据不同的操作系统和环境,自动选择最适合的方式来打开链接或文件。

    6 年前

相关推荐

    暂无文章