npm 包 mol-conventional-changelog 使用教程

如果你正在使用 Git 进行代码管理，那么你一定知道 Conventional Commits 规范。这个规范定义了一种提交信息的格式，旨在帮助团队更好地管理代码提交历史和版本号。

mol-conventional-changelog 是一个基于 Conventional Commits 规范生成 CHANGELOG.md 文件的工具。本文将详细介绍如何使用此工具以及它的学习和指导意义。

安装

安装此 npm 包非常简单，只需要运行以下命令即可：

npm install --save-dev mol-conventional-changelog

使用教程

1. 添加配置文件

要开始使用 mol-conventional-changelog，首先需要添加一个配置文件。在项目根目录下创建一个名为 .molconventionalchangelogrc 的文件，并添加以下内容：

{
  "preset": "angular",
  "releaseCount": 0,
  "output": "./CHANGELOG.md"
}

以上配置中：

• preset：选择所需的预设。我们选择了 "angular"，因为它是最常用的。
• releaseCount：生成 changelog 的版本数量。如果这个值为 0，则会生成所有版本的 changelog。
• output：生成的 changelog 文件的路径和名称。

2. 执行命令

在配置完毕后，可以执行以下命令来生成 changelog：

npx conventional-changelog -p mol-conventional-changelog -i CHANGELOG.md -s

说明：

• -p：指定所需的 preset，这里我们选择了 mol-conventional-changelog。
• -i：指定需要更新的 changelog 文件路径。
• -s：将生成的 changelog 写入 changelog 文件，如果不加这个参数，则会在控制台打印 changelog。

3. 手动添加版本号

在执行完上面的命令后，你将得到一个 changelog 文件，但是它并没有版本号。手动为你的项目添加一个版本号非常重要，因为它能够让其他人更好地理解你的项目演变过程。将 ## [Unreleased] 修改为所需的版本号即可。

4. 提交代码

现在你已经生成了 changelog，并且手动添加了版本号，可以提交你的代码和 changelog 文件了。此时，你应该注意以下几点：

• 确保提交信息符合 Conventional Commits 规范。
• 提交代码和 changelog 文件的 commit 应当同时发生。这样可以确保 changelog 中记录的内容和代码库中实际的代码变更一致。

学习和指导意义

使用 mol-conventional-changelog 并手动维护版本号和 changelog 文件，可以帮助你更好地管理你的项目版本历史。以下是一些学习和指导意义：

• 提高代码质量：遵循 Conventional Commits 规范可以让你的代码质量更高，因为它鼓励编写更清晰、更明确的提交信息。
• 方便项目管理：有了 changelog 文件，你可以更方便地了解项目的版本历史和演变过程。这对于团队协作和项目维护非常重要。
• 增强可读性：手动添加版本号和 changelog 可以让其他人更好地理解你的项目，从而更容易参与到项目中来。

示例代码

以下是一些符合 Conventional Commits 规范的提交信息示例：

• feat: 添加登录功能
• fix: 修复用户注册时的一个 bug
• chore: 更新 webpack 配置文件

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