npm 包 nf-conventional-changelog 使用教程

介绍

nf-conventional-changelog 是一个 npm 包，它为项目自动生成具有规范性的 changelog。其基于 Conventional Commits 标准，它提供了一个规范化的 commit message 的写法，使得 changelog 更加易于生成和阅读，因此使用习惯良好的 commit message 非常重要。接下来，我将介绍如何使用 nf-conventional-changelog 生成 changelog。

安装和使用

使用 npm 包 nf-conventional-changelog 生成 changelog，首先需要使用 npm 安装该包。

npm install -D nf-conventional-changelog

安装完成后，我们需要在 package.json 中添加 script，需要执行以下内容。

"scripts": {
  "changelog": "nf-conventional-changelog -p angular -i CHANGELOG.md -s -r 0",
},

这些参数的含义:

• -p 指定项目的 commit message 的格式规范，一般为 angular，代表符合 Angular 标准的格式。
• -i 指定 changelog 文件的地址和名称，一般为 CHANGELOG.md。
• -s 指定需要提取的 commit message 的种类。如果不指定，默认是「修复 bug」和「增加功能」。
• -r 在 commit message 中提取“版本号”时，如何处理。我们一般设为 0，代表自动检索。

在 package.json 中添加完上述脚本后，我们需要执行 changelog 命令，生成每次的 changelog，执行方式如下：

npm run changelog

执行完毕后，就会在我们指定的 CHANGELOG.md 文件中生成 changelog。

示例代码

{
  "devDependencies": {
    "nf-conventional-changelog": "^4.0.0"
  },
  "scripts": {
    "changelog": "nf-conventional-changelog -p angular -i CHANGELOG.md -s -r 0",
  },
}

总结

在实际的前后端应用开发中，规范的 commit message 对于团队合作非常重要，通过使用 nf-conventional-changelog，可以将这些规范性的 commit message 转化为易读且规范统一的 changelog，在后面的开发过程中，对于团队沟通和任务分配起到了非常好的作用，并且防止了信息冗杂和误解。因此，在实际开发过程中，我们应该使用 nf-conventional-changelog 来规范我们的 changelog 内容。

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