在前端开发中,管理 npm 包的版本是一个重要的任务。bumped 是一个能够自动更新你的 npm 包版本号的工具,能极大地简化这个过程。
安装 bumped
使用以下命令安装 bumped:
npm install bumped --save-dev
安装完成后,你可以在 package.json 中添加如下配置:
{ "scripts": { "version": "bumped" } }
这样,在执行 npm version
命令时,bumped 就会自动更新你的 package.json 文件中的版本号。
bumped 的配置文件
如果你想更全面地控制 bumped 的行为,可以创建一个名为 .bumpedrc
的 JSON 配置文件。该文件应该放在项目根目录下。
以下是一个示例配置文件,其中包含了一些常用的配置项:
-- -------------------- ---- ------- - -------- - --------------- ------------ -- -------- - - ------- -------- -------- --------- -------- -- - ------- -------- -------- ---- --------- -- - ------- -------- -------- ---- ------ - -- --------- - ----------- --------- --------- ---------- ---- ---------- ------ ---- ------ -- ---------------- -------------- ---------------- --------------- ----------- ---------- --------- ------ ---------- ----- -
上述配置文件中有几个重要的属性:
files
:需要更新版本号的文件列表。types
:定义了三种版本号变更类型,分别是 major、minor 和 patch。label 属性是版本变更类型的人类可读名称。commitMessage
:commit 消息模板,可以使用{{version}}
占位符插入版本号。template
:生成 CHANGELOG.md 文件的模板,其中default
是 bumped 内置的默认模板。
bumped 的使用示例
以下是一个示例,演示如何使用 bumped 更新 npm 包的版本并自动生成 changelog:
- 在项目根目录下,创建一个名为
.bumpedrc
的配置文件,并添加上述示例配置。 - 修改代码后,使用 git add 命令将修改的文件添加到暂存区。
- 执行
npm version patch
命令,该命令会自动更新 package.json 中的版本号,并提交一个 commit,commit 消息为 "vX.X.X"(X 表示对应的版本号)。 - 执行
npm publish
命令发布新版本的 npm 包。 - 执行
npm run changelog
命令生成 CHANGELOG.md 文件。
执行完毕后,你会发现项目根目录下生成了一个 CHANGELOG.md 文件,其中包含了这个版本中所有变更的详细记录,非常方便。
结论
通过本文,我们学习了如何安装和配置 bumped,并演示了如何使用它来更新版本号并生成 changelog。使用 bumped 可以大大简化我们在 npm 包开发中的版本管理工作,提高开发效率。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/56540