npm 包 sem-rel 使用教程

阅读时长 4 分钟读完

前言

在开发中,版本管理是必不可少的。sem-rel 是一个非常方便的 npm 包,它能够帮助我们快速实现版本号的自动升级。

本篇文章主要介绍 sem-rel 的使用教程。首先我们来看一下 sem-rel 的特点。

sem-rel 特点

sem-rel 使用 Semantic Versioning 方式管理版本号。在开发过程中,我们通常会遵循以下规范:

  • 如果只是进行了小的改动或 bug 修复,则升级 patch 版本号(如 1.0.1 -> 1.0.2);
  • 如果新增了功能,但是向下兼容,则升级 minor 版本号(如 1.0.2 -> 1.1.0);
  • 如果新增了功能,但是不再向下兼容,则升级 major 版本号(如 1.1.0 -> 2.0.0)。

sem-rel 能够根据上述规范自动升级版本号,大大减轻了我们版本控制的负担。

安装 sem-rel

首先,我们需要安装 sem-rel:

全局安装后,我们可以在命令行中调用 sem-rel 并使用它提供的功能。

sem-rel 命令

sem-rel 提供了三个命令:current、major、minor、patch。我们依次来看一下这三个命令的使用。

current 命令

使用 current 命令可以查看当前版本号:

下面是一个示例输出:

patch、minor、major 命令

使用 patch、minor、major 命令可以根据 Semver 规则自动升级版本号。以 patch 命令为例:

执行该命令后,sem-rel 会自动分析 git log 中最近的提交记录并自动升级 patch 版本号。我们可以使用 current 命令查看当前版本号是否已经升级。

确认版本号升级

使用 sem-rel 升级版本号后,我们需要确认该版本号升级是否生效。我们可以在 package.json 中查看版本号是否正确,并且在提交代码时查看 COMMIT_MSG 是否包含了 sem-rel 自动生成的版本号信息。

开发者应当注意到,sem-rel 自动生成的版本号信息中包含了很多额外的信息,如前缀必须是 "v"。如果需要更改 sem-rel 自动生成的版本号信息,可以通过配置文件进行自定义。

配置文件

sem-rel 提供了一个配置文件,可以用来自定义生成的版本号。在项目根目录创建名为 "semrelrc.json" 的文件,并在其中使用如下格式定义配置项:

我们来看一下各个配置项的含义:

  • parts:允许的版本号部分,可以是 "major"、"minor" 或 "patch";
  • version_prefix:版本号前缀;
  • version_suffix:版本号后缀;
  • version_tag_prefix:版本号 tag 前缀;
  • version_tag_suffix:版本号 tag 后缀;
  • version_tag_part:版本号 tag 部分。

我们可以通过修改配置文件来实现对版本号的自定义控制。例如,我们可以将 version_tag_part 设为 "major",以实现将 tag 加在 major 版本号中。

总结

本篇文章主要介绍了 npm 包 sem-rel 的使用教程。sem-rel 的方便的版本号控制功能能够大大减轻开发过程中版本管理的负担,并且使得版本号的升级变得更加规范化。

如果您的项目中还没有使用 sem-rel,我强烈建议您引入它。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005601281e8991b448de0af

纠错
反馈