npm包cli-changelog使用教程

介绍

cli-changelog是一款用于生成changelog的npm包。使用它能够让我们轻松地生成项目的changelog，以便更好地管理我们的代码。

安装

首先需要安装Node.js环境，然后使用npm命令进行安装：

npm install cli-changelog -g

为了在命令行中使用cli-changelog，需要将其安装为全局模块。

使用

初始化

首先需要在项目中初始化一个changelog：

changelog init

此命令会在项目根目录下生成changelog.json文件。

添加改动记录

使用以下命令可以将改动记录添加到changelog.json中：

changelog add <type> <description>

需替换<type>和<description>为实际的内容。例如：

changelog add feat "添加了一个新的功能"

生成changelog

输入以下命令即可生成changelog：

changelog generate

此命令会根据当前的changelog.json文件生成一个Markdown格式的changelog文件。

自定义输出文件路径

默认情况下，生成的changelog文件会保存在根目录下的CHANGELOG.md文件中。但是，我们也可以通过以下命令来指定输出文件的路径：

changelog generate -o <output_file>

例如：

changelog generate -o docs/CHANGELOG.md

以上命令会将changelog文件保存在docs/CHANGELOG.md路径下。

注意事项

在使用cli-changelog时需要注意以下几点：

1. 必须先初始化changelog，否则无法添加改动记录或生成changelog；
2. 改动记录的类型（type）需要使用规范的关键词，包括feat、fix、docs、style、refactor、test、chore、build和perf；
3. 生成changelog时可以添加参数，以自定义输出文件的路径。

示例代码

以下是一个使用cli-changelog的示例：

changelog init
changelog add feat "添加了一个新的功能"
changelog add fix "修复了一个bug"
changelog generate -o docs/CHANGELOG.md

以上代码将在项目中初始化changelog，添加了两个改动记录，并将changelog保存在docs/CHANGELOG.md路径下。

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