npm 包 @wrench/standard-version-config 使用教程

前言

万物皆可配置,版本号也不例外。使用诸如 2.1.3 等形式的版本号标记软件的语义化版本控制(Semantic Versioning,简称 SemVer)已经成为了通用做法。为了让版本号在不同的软件之间规范化,SemVer 指定了一套标准的版本命名规则,定义了版本号的格式和内容。

但是,在实际的开发中,需要编写的文件可能涉及到多种语言和质量控制,对于版本号的语义化控制和规范化管理变得十分重要。为此,我们有了 @wrench/standard-version-config 这一 npm 包。

@wrench/standard-version-config 简介

@wrench/standard-version-config 是针对前端工程项目的标准版本控制配置工具。通过使用这个包,可以方便地为项目制定多种语言的语义化版本、版本号及发布计划,确保符合语义化版本控制规范。

该包的主要功能如下:

  • 使用简单,只需安装后在项目配置文件中进行简单配置即可;
  • 具有多种语言及版本情况下的配置方式;
  • 可自定义发布前的版本号升级操作,如在修复 bug 后自动升级次版本号、在重构后自动升级主版本号等。

安装

通过 npm 安装:

--- ------- ------------------------------- ----------

配置文件

@wrench/standard-version-config 的配置主要与 standard-version 相关,需要在根目录下创建 .versionrc.js 配置文件,内容如下:

----- ------------ - -------------------------------------------

----- ------------- - -
  ---
  -------------- --------
  ------------ ----
  ---------------- ---------------- ------- ----
  ---
--

-------------- - ------------------ -------------- ------ -------------------

上述配置中的 wrenchOptions 对象,是针对 standard-version 的配置,它里面的各项参数可以根据自己的需要进行自定义。其中一些主要的参数说明如下:

  • updateTypes:设置自动增加的版本号类型,默认为 "patch"。可选值:"major"、"minor"、"patch";
  • tagPrefix:打标签时的前缀,可选参数;
  • commitMessage:提交记录的模版。

使用

安装后,可以通过在代码库的根目录中运行以下命令(使用 yarn 或者 npm)从控制台调用:

---- --------------
--- --- --------------

这个命令会生成下一个版本号,并自动根据 git 日志更新版本号,并自动执行打标签和提交更新操作。命令结束后,将自动出现具有标签和提交日志的新版本发布状态。

示例代码

下面我们使用 React 项目为例,演示如何使用 @wrench/standard-version-config 进行版本控制:

  1. 安装 @wrench/standard-version-config 包:

    --- ------- ------------------------------- ----------
  2. 在项目根目录下添加 .versionrc.js 配置文件,如下:

    ----- ------------ - -------------------------------------------
    
    ----- ------------- - -
      ---
      -------------- --------
      ------------ ----
      ---------------- ---------------- ------- ----
      ---
    --
    
    -------------- - ------------------ -------------- ------ -------------------
  3. package.json 配置文件中添加脚本命令:

    ---------- -
      ---
      ----------------- ----------------- ---------- ------------- ---------------- -- --- --- ------------ ------------ -- --- ------ -- ----------------- ------- ----- ----- -- --- --- -- ------ -- -- -------------------------------------- -- -- ----------------- ------- ----- ----- -- --- ---- ------ ---- ---------------
      ---
    -
  4. 运行命令发布新版本:

    ---- --------------

    此时会自动生成版本号,并自动更新指定位置的版本号,然后在终端上打印出 VERSION X.X.X

  5. 其他查看版本号相关命令:

    ---- -------
    ---- ------- -------
    ---- ------- -------
    ---- ------- -------
  6. 其他查看版本号相关命令1:

    ---- -------
    ---- ------- -------
    ---- ------- -------
    ---- ------- -------

以上就是使用 @wrench/standard-version-config 进行前端项目版本控制的详细方法和步骤。在使用过程中,如果遇到任何问题,可以参考相关文档进行解决。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/600673defb81d47349e53bbb


猜你喜欢

  • npm 包 apostille-library 使用教程

    什么是 apostille-library? apostille-library 是一个 JavaScript 库,它可以帮助开发者创建和验证 NEM 区块链上的 apostille 文件。

    4 年前
  • npm 包 @quickts/nestjs-mongodb 使用教程

    前言 在现代 Web 开发中,使用数据库存储数据已成为常态。Node.js 生态圈中有许多优秀的数据库操作库,而在这些库中 MongoDB 变得越来越受欢迎。Nest.js 作为目前流行的 Node....

    4 年前
  • npm 包 qm-dom-to-image 使用教程

    在前端开发过程中,我们经常需要将 DOM 元素转换成图片进行展示或截图。这时候就需要使用到 qm-dom-to-image 这个 npm 包。本文将详细介绍如何使用这个包来实现将 DOM 元素转换成图...

    4 年前
  • npm 包 @dfeidao/fd-w000027 使用教程

    介绍 @dfiedao/fd-w000027 是一款基于 Vue.js 的前端 UI 组件库。它提供了一些常用的 UI 组件,如按钮、表单、对话框等,可以在你的项目中快速搭建 UI。

    4 年前
  • npm 包 ipv4-calculator 使用教程

    本文将介绍一个叫做 ipv4-calculator 的 npm 包,它可以帮助开发者计算 IPv4 的相关信息,比如子网掩码、广播地址、网络地址等等。在本教程中,我们将介绍如何安装和使用 ipv4-c...

    4 年前
  • npm 包 postcss-vars-process 使用教程

    前言 在前端开发中,我们常常需要使用 CSS 变量来实现一些比较常规的效果,比如主题切换、自适应布局等。而 postcss-vars-process 就是一个可以解决这类问题的 npm 包。

    4 年前
  • npm 包 angular-jsonld-component 使用教程

    简介 在前端开发中,使用 schema.org 提供的 JSON-LD 对网页的结构化数据进行标记化是非常重要的。angular-jsonld-component 是一个方便的 Angular 组件,...

    4 年前
  • npm 包 md-info-generator 使用教程

    简介 md-info-generator 是一款基于 Node.js 平台的 npm 包,能够帮助前端开发者快速生成 markdown 格式的项目信息。本文将介绍该包的使用方法和使用场景,并提供详细的...

    4 年前
  • npm 包 @smiirl/smiirl-library 使用教程

    前言 在前端开发中,我们经常需要使用各种第三方库来提高开发效率,其中有一些是由社区开发并发布到 npm 上的,例如 @smiirl/smiirl-library 这个库。

    4 年前
  • npm 包 @traveloka/react-native-pace 使用教程

    在前端开发过程中,我们经常需要使用各种 npm 包来简化我们的工作。本文将介绍一款名为 @traveloka/react-native-pace 的 npm 包,它能够为 React Native 应...

    4 年前
  • npm 包 @flovermeer/npxcard 使用教程

    在前端开发中,项目的管理和维护是必不可少的一环。而 npm 是当前最常用的管理工具之一。除了可以安装和管理项目自身的依赖,npm 还提供了很多第三方的包供我们使用。

    4 年前
  • npm 包 boostnode 使用教程

    前言 npm(全称 Node Package Manager)是一个基于 Node.js 的包管理工具,通过它可以方便地安装、升级、删除各种 Node.js 模块。这一系列操作都是基于 npm 包的。

    4 年前
  • npm 包 @jarred/react-native-photo-manipulator 使用教程

    在前端开发中,经常需要处理图片。而如果想要使用 React Native 开发移动应用的话,就需要使用 @jarred/react-native-photo-manipulator 这个 npm 包来...

    4 年前
  • npm 包 cumulocity-kitchensink 使用教程

    简介 cumulocity-kitchensink 是一个基于 Cumulocity IoT 平台开发的前端组件库,其中包含了许多实用的 UI 组件和功能模块。借助这个组件库,我们可以快速地开发出基于...

    4 年前
  • npm 包 @0yi0/ethereumjs-vm 使用教程

    什么是 EthereumJS-VM EthereumJS-VM 是 Ethereum 客户端实现的一部分,它模拟了以太坊区块链的虚拟机。用户可以利用 EthereumJS-VM 执行智能合约,而无需连...

    4 年前
  • npm 包 codeceptjs-saucehelper 使用教程

    前言 在前端开发的过程中,自动化测试是一个重要的环节。CodeceptJS 是一个流行的前端自动化测试工具,许多开发人员使用它来进行测试。 在这篇文章中,我们将介绍一个 npm 包 codeceptj...

    4 年前
  • npm 包 rest-api-url-builder 使用教程

    在前端开发中,我们经常需要与后端 API 进行交互。而设计好的 API 都需要一些参数来进行查询或操作。而这些参数则需要以 URL 的形式传递给后端进行处理。在拼接这些 URL 时,我们通常需要花费一...

    4 年前
  • npm包gen-h5使用教程

    #npm包gen-h5使用教程 简介 gen-h5是一个可以快速生成响应式h5页面的npm包。其生成的页面适配多种屏幕大小,支持键盘和触摸屏幕交互等特性。使用gen-h5,可以让开发者节省时间和精力,...

    4 年前
  • npm 包 gen-pc 使用教程

    前言 在前端开发中,我们经常需要依赖各种第三方库,这时候 npm 包管理器就显得尤为重要。其中一个非常实用的 npm 包就是 gen-pc,它可以帮助我们快速地生成 PC 端项目的文件结构和基础代码。

    4 年前
  • npm 包 eslint-config-ecollect-base 使用教程

    概述 eslint-config-ecollect-base 是一个基于 eslint 的配置包,旨在为前端开发者提供一套适用于 ecollect 的 JavaScript 代码规范。

    4 年前

相关推荐

    暂无文章