前言
在开发过程中,我们经常需要获取版本号来做一些相关操作,比如版本控制、打 tag 等。npm 包 vss-version 就是一款非常方便的获取版本号的工具,本文将详细介绍 vss-version 的使用方法,帮助读者更好地理解和掌握这款工具。
安装
通过 npm 安装:
npm install vss-version
使用
在代码中引入 vss-version:
const { getPackageVersion } = require('vss-version');
在获取版本号前,我们需要先设置一下我们的配置信息,如下:
-- -------------------- ---- ------- ----- ------- - - ----------------- -- -- ---- ------- ----- ----- -- -------- ----------------------------------------------------------------------------- -- ---- -- ------- --- - ------- -------------- ----------- -- ------- ------------ - -- ---- --------- ----------- --------- ---------- -- --
针对这些参数,我们做一个简单的说明:
buildsPerChannel
: 表示单个 channel 需要挑选的 build 个数,比如我们希望在 dev channel 中挑选前 5 个 build 来做版本号。baseUrl
: VSTS 项目 release api 的 baseUrl,根据自己项目的情况进行填写。versionFormat
: 表示版本号格式,常用的有:
转换符 | 含义 |
---|---|
%Y |
4 位数的年份 |
%y |
2 位数的年份 |
%M |
代表月份(01~12) |
%m |
代表月份,带前导零(01~12) |
%D |
日期,不带前导零 |
%d |
日期,带前导零(01~31) |
%H |
时(00~23) |
%h |
时,带前导零(00~23) |
%N |
分钟(00~59) |
%n |
分钟,带前导零(00~59) |
%S |
秒(00~59) |
%s |
秒,带前导零(00~59) |
%p |
channel 的 build 标志位 |
credentials
: VSTS 账户信息,其中username
和password
为你的 VSTS 账户用户名和密码。
接下来,我们就可以通过调用 getPackageVersion
方法来获取版本号了,如下:
// 获取 dev channel 中最新的版本号 const version = await getPackageVersion('dev', options); console.log(`version: ${version}`);
其中 getPackageVersion
的参数为 channel 的标志位,即我们之前在 options
中指定的标志位,比如 dev
、release
等。
在上面的示例代码当中,我们使用了 await
关键字来等待 getPackageVersion
方法的执行结果。因为在执行 getPackageVersion
方法时需要获取 API 的数据,如果不加 await
,很可能导致获取不到正确的版本号。
示例
我们可以通过以下示例来更好地理解 vss-version 的使用方法:
-- -------------------- ---- ------- ----- - ----------------- - - ----------------------- ----- -------- ------ - ----- ------- - - ----------------- -- -------- ----------------------------------------------------------------------------- -------------- ----------- ------------ - --------- ----------- --------- ---------- -- -- -- -- --- ------- ------- ----- ------- - ----- ------------------------ --------- --------------------- ------------- -- -- ------- ------- ------- ----- -------- - ----- ---------------------------- --------- ---------------------- -------------- - -------
总结
通过本文的介绍,我们可以发现 vss-version 的使用方法非常简单,只需要在代码中引入并设置一下参数即可。相比手动获取版本号,使用 vss-version 可以有效地提高开发效率,减少出错的可能性,因此在项目中应该得到更加广泛的应用。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005679481e8991b448e3edb