简介
project-version-cli
是一个命令行工具,用于管理项目版本。它可以实现版本号的自动更新、版本记录的生成等功能。并且,它可以与大多数前端项目无缝集成。
安装
你可以使用npm全局安装
npm install -g project-version-cli
使用
初始化
使用project-version-cli init
命令初始化版本记录
project-version-cli init
执行此命令后,会创建一个version.json
文件,并在其中写入如下内容:
{ "versions": [] }
在开发过程中,此文件将用于记录你项目的版本号
自动更新
在package.json
中,我们通常会添加一个version
属性,用于标识包的版本。在使用project-version-cli
后,你可以在此基础上自动更新项目版本号。
在根目录的package.json
中添加如下代码:
"scripts": { "ver-patch": "project-version-cli patch", "ver-minor": "project-version-cli minor", "ver-major": "project-version-cli major" }
这里,我们添加了三个scripts
,用于自动更新项目版本号。其中,
ver-patch
表示小修改,例如修复bugver-minor
表示小版本更新,例如添加新功能ver-major
表示大版本更新,例如重构代码
以ver-patch
为例,使用以下命令进行版本更新:
npm run ver-patch
你可以根据你的需求选择不同的命令进行版本更新。
添加版本记录
在使用project-version-cli
后,将自动为你创建version.json
文件,用于记录你项目的版本号。
使用以下命令可以为版本号添加记录:
project-version-cli log
执行此命令后,会提示你输入版本记录及相关信息,例如:
? Input version log and description:new feature: 添加了批量操作功能
此时,你只需输入你的版本记录即可完成添加。
查看版本记录
使用以下命令查看版本号及其对应的记录:
project-version-cli view
执行此命令后,将会在终端中打印出所有版本号及其对应的记录。
示例代码
这里,我以一个React项目为例,演示如何使用project-version-cli
在根目录的package.json
中添加如下代码:
-- -------------------- ---- ------- ---------- - -------- -------------- ------- -------- -------------- ------- ------- -------------- ------ -------- -------------- ------- ------------ -------------------- ------- ------------ -------------------- ------- ------------ -------------------- ------ -
在App.js
中,加入一个按钮,在点击后触发版本号自动更新:
-- -------------------- ---- ------- ------ ----- ---- -------- ------ ---- ---- ------------- ------ ------------ -------- ----- - ----- ----------- - -- -- - ----------------------- ---------------------------------- ------------------------------------------- - ------ - ---- ---------------- ------- ----------------------- ---- ---------- -------------------- ---------- -- --- ---- ----------------------- --- ---- -- ------- ---- ------- -------------------------------------- -- -------------------- -------------------------- --------------- ------------- ----------- - ----- ----- ---- --------- ------ -- - ------ ------- ----
最后,在终端中输入以下命令,即可完成版本号自动更新:
npm run ver-patch
在project-version-cli
的帮助下,你可以轻松完成项目的版本管理,更好地管理你的前端项目。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60065f8b238a385564ab6e26