当你维护一个 JavaScript 项目时，很多时候你需要记录每个版本的改动。为了方便用户了解变化和开发者跟踪进展，许多项目使用 changelog 文件来记录版本历史。npm 包提供了一种简单的方式来向 changelog 文件中添加新版本的信息。
安装
首先，我们需要安装 changelog：
--- ------- -- ---------
初始化
接下来，让我们在项目根目录下创建一个 CHANGELOG.md 文件，这将是我们的版本历史记录文件。然后运行以下命令：
--------- ----
这个命令会在 package.json 中添加 changelog 字段，并创建一个名为 .changelogrc 的配置文件。你可以编辑 .changelogrc 文件来配置工具的行为。
生成版本记录
当你完成了一个版本的更新后，运行以下命令来生成对应的版本记录：
---------
这个命令将会：
- 自动检测你最近的 Git 提交日志，并将其转换成
changelog格式。 - 将新的条目写入到
CHANGELOG.md文件中。 - 将最新的提交标记为已经发布的版本。
配置
.changelogrc 文件支持多种配置选项，以帮助你自定义工具的行为。例如：
- ------- ------------- ----------- ----------------- -
上面的配置将指定 changelog 将输出到名为 HISTORY.md 的文件中，并使用 my-template.hbs 模板来格式化输出。
示例
下面是一个简单的示例，演示如何更新版本记录：
- ---------- --- --- - --- ------ -- ------ --------- - -- --------- ------- --------- - --------- --- ------------
输出结果应该类似于：
- ------ -- ------------ --- -- - --------
结论
npm 包提供了一个方便的方式来管理 changelog 文件。通过遵循本教程中的步骤，你可以轻松地创建和维护版本历史记录，以及自定义工具的行为。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/47078