什么是 @msowa/gf-release
@msowa/gf-release 是一个可以为你的前端项目生成 changelog 的 npm 包,它可以帮助你追踪每一个版本之间的变化并且生成标准的 changelog。
安装
你可以使用 npm 来安装 @msowa/gf-release,只需要在命令行中输入以下命令即可:
npm install -g @msowa/gf-release
使用方法
初始化
使用 @msowa/gf-release 之前,你需要在项目中创建配置文件 changelog.json
,保存项目版本信息、commit messages 的类型和范围等信息。
-- -------------------- ---- ------- - ----------- - - ------- -------- ------- ------------- -------------- ------- -- - ------- -------- ------- ------------- -------------- -------- - -- -------- - - ------- ------- -------------- ----- -- - ------- ------ -------------- ------ -- - ------- ------- -------------- ------ -- - ------- -------- -------------- ------ -- - ------- ----------- -------------- ------ -- - ------- ------- -------------- ------ -- - ------- ------- -------------- ---- -- - ------- -------- -------------- ---- -- - ------- ----- -------------- ------- -- - ------- -------- -------------- ------ - - -
生成 changelog
只需要在项目根目录下运行以下命令即可生成 changelog:
gf-release
除此之外,你还可以向命令中添加参数来实现更多的功能。常用的参数如下:
-f, --file
,用于指定 changelog 文件的保存路径。-n, --name
,用于为生成的版本号自定义名称。-t, --type
,用于自定义生成 changelog 时 commit message 的过滤规则。比如只显示 type 为 feat 和 fix 的 commit message。
例如,为新版本创建一个新的名为 bugfix
的标签,只显示 type 为 feat 和 fix 的 commit message,保存 changelog 文件到当前目录的 CHANGELOG.md
文件中,可以运行以下命令:
gf-release -n bugfix -t feat,fix -f ./CHANGELOG.md
示例代码
以下是一个基于 React 的项目示例的使用代码:
-- -------------------- ---- ------- - ------- ------------------ ---------- -------- --------------- - -------- ----------- ------------ ---------- -- ------------------ - -------------------- -------- -- ---------- - ------------ ------------ - -
在命令行中运行 npm run changelog
即可查看运行结果。
总结
@msowa/gf-release 是一个功能强大的 npm 包,它可以帮助开发者轻松地生成 changelog,减少人们的重复劳动。此外,开发者还可以通过自定义规则和参数来更好地使用这个工具。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60056bd681e8991b448e578e