NPM 包 generate-changelog 使用教程

在一个项目中，随着代码的迭代，我们需要不断地更新日志，以便于其他开发者能够了解到项目的最新进展。但是手动编写和维护这些日志往往是一件繁琐的事情。为了减轻这个负担，我们可以使用 generate-changelog 这个 NPM 包来自动生成并维护我们的项目日志。

什么是 generate-changelog

generate-changelog 是一个命令行工具，用于根据 Git 历史记录生成 Markdown 格式的日志文件。通过提供统一的 commit message 规范，并使用类似 Angular 的规范来自动生成 CHANGELOG.md 文件，使得项目的日志始终保持最新、整洁且易于阅读。

安装 generate-changelog

安装 generate-changelog 很简单，只需要在命令行中输入以下命令即可：

npm install -g generate-changelog

使用 generate-changelog

使用 generate-changelog 生成日志非常简单，只需要在项目根目录中执行以下命令即可：

generate-changelog

执行完毕后，会在当前目录下生成一个 CHANGELOG.md 文件，其中包含了项目的所有修改历史。

配置 generate-changelog

generate-changelog 支持多种配置选项，让你可以完全自定义生成的日志文件。以下是一些常用的配置选项：

• -p 或 --preset：指定配置预设。可选值有 angular、conventional-changelog 等。
• -i 或 --infile：指定 input 文件路径。
• -o 或 --outfile：指定 output 文件路径。
• --release-count：指定生成日志的版本数。

例如，如果要使用 Angular 风格的 commit message 规范，并将生成的日志文件输出到根目录下的 mylog.md 文件中，可以执行以下命令：

generate-changelog --preset angular -o mylog.md

结语

generate-changelog 是一个非常实用的工具，它可以帮助我们轻松地维护项目的日志文件，减少了手动编写和维护日志的繁琐过程。如果你还没有尝试过 generate-changelog，不妨在自己的项目中试一试吧！

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