npm包commits 的使用教程

在前端开发过程中,npm是我们必须要使用的包管理工具之一。如果您正在开发一个npm包,为了确保代码质量和可维护性,需要规范commit信息。那么,npm包commits就可以帮助您了解commit信息规范,并且可以自动生成版本号并发布到npm。

什么是commits?

在代码管理中,commit是指按照一定要求记录提交信息到版本控制系统中的过程。commit信息一般包括提交者姓名、提交时间、修改的文件、修改内容以及修改原因等。

commits 包是一个用来规范 commit message 的包。

进行 commits 规范约束

首先,我们需要在项目中安装commits:

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

在安装完成后,我们需要在 package.json 文件中添加 commits 配置属性。

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

上述配置定义了常见的几种类型的 commit,包括 style(样式)、feat(新功能)、fix(修复)、docs(文档)、perf(性能)、test(测试)、chore(日常工作)、refactor(重构)、revert(撤销)等。

commits类型规范

  • 重大版本变更 breaking: (用于撤销、删除等一些破坏性修改);
  • 新的特性feat: (支持接口、页面等);
  • 修复 bug fix: (修复已知的 bug);
  • 日常操作 chore: (对项目本身的页面、文件结构,调整、修改);
  • 对文档的增加、修改 docs: (文档的修改);
  • 对已有的某个功能部分重构 refactor: (重构已有功能);
  • 性能的优化 perf: (关于代码性能的优化);
  • 关于代码测试的操作 test:(更新了代码测试);
  • 撤销某一个历史 commit revert: (撤回某个操作,重新做);
  • 对建立在CI(持续集成)系统上的自动化流程或者对构建或者依赖项进行了修改 ci: ;
  • 对内部项目或者依赖库进行了修改导致版本号发生改变 build: ;

commits格式

一个标准的 commits 包的格式规范如下:

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

其中:

  • type:本次 commit 的类型,比如 featfixtest 等等。
  • subject:本次 commit 的简要说明。

示例:

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

进行版本号管理

commits 包会根据规范的 commit message 自动生成版本号。

package.json 文件中,可以配置版本号初始值和生成规则。

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

以上配置表示:

  • noCommit: true:表示不创建提交记录。
  • increment: minor:表示版本号按照 minor(小版本号)进行自动升级。

我们可以使用以下命令来生成新版本号:

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

执行后,commits 包将根据项目中的 commit message 自动生成新的版本号,同时修改 package.json 文件的版本号。

发布 npm 包

发布 npm 包可以使用 npm 官方工具,如下:

--- -------

以上命令会将当前目录下的 package.json 发布到 npm 上。但在发布之前,我们通常会先执行以下命令进行测试:

--- --- ----

如果测试都通过了,就可以执行发布命令。发布之后,其他开发者就可以在自己的项目中使用你的 npm 包了。

结论

通过 commmits 包,我们可以规范 commit message,让我们更加专注于代码开发,不用去想版本号管理和发布等事情。这对于一个好的代码开发体系结构是必不可少的一部分,有了 commmits,我们可以更好的协作和发布代码。

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


猜你喜欢

  • npm 包 xyz-switch 使用教程

    xyz-switch 是一个实现开关切换功能的 npm 包,它可以帮助前端开发人员快速构建出美观实用的开关按钮。在本篇文章中,我们将深入学习 xyz-switch 的使用方法,并探究其在实际开发中的应...

    3 年前
  • npm 包 angular-virtual-list 使用教程

    在前端开发过程中,经常需要处理海量数据列表的展示问题。传统的列表渲染方式,一旦数据过多就会导致性能和用户体验问题。为了解决这个问题,本文将介绍一种常用的前端技术 —— 虚拟滚动列表(Virtual S...

    3 年前
  • npm包 @npm-polymer/app-media 使用教程

    随着前端技术的发展,开发人员需要使用越来越多的工具来提高效率和开发质量。其中,npm是一个非常重要的工具,它能够帮助开发人员快速、方便地管理项目中的依赖包。@npm-polymer/app-media...

    3 年前
  • npm 包 @npm-polymer/font-roboto 使用教程

    在前端开发中,一种漂亮的字体设置能够让网站更加吸引人,提高用户体验。其中一种非常流行的字体是 Roboto。在这篇文章中,我们将介绍如何使用 npm 包 @npm-polymer/font-robot...

    3 年前
  • npm 包 @npm-polymer/gold-cc-expiration-input 使用教程

    在前端开发中,用到表单控件时,经常会需要使用到信用卡过期时间的控件。本文介绍一个 npm 包 @npm-polymer/gold-cc-expiration-input,它提供了一个可配置的简洁、易用...

    3 年前
  • npm 包 @ozylog/ui-tooltip 使用教程

    介绍 @ozylog/ui-tooltip 是一个 React组件库,用于创建工具提示或带有悬停文本或信息的交互式UI元素。 使用该组件库可以轻松地创建您需要的各种工具提示,并且提供了丰富的配置选项,...

    3 年前
  • npm 包 eslint-config-kaplankomputing 使用教程

    前言 在前端开发中,我们经常需要保证代码的质量和规范性,特别是在团队开发或者大项目中,要保证代码风格的统一性很重要。 常用的代码规范工具包括 JSLint、JSHint、ESLint 等,其中 esl...

    3 年前
  • npm 包 template-stamp 使用教程

    什么是 template-stamp? Template-stamp 是一个可以根据定义的模板创建 HTML 片段的工具,它可以让你更加轻松地在前端开发中创建 HTML 模板。

    3 年前
  • npm 包 @tomchentw/istanbul-lib-instrument 使用教程

    在前端开发中,测试时覆盖率检查是十分重要的。 Istanbul 是前端常用的测试覆盖率检查工具,而 @tomchentw/istanbul-lib-instrument 是 Istanbul 的一个子...

    3 年前
  • npm 包 changearraymapkeys 使用教程

    在前端开发中,我们常常需要对数组或对象进行操作,而其中一个常见的操作就是修改数组或对象的键值。然而,在 JavaScript 中,我们无法直接修改一个对象或数组的键名。

    3 年前
  • npm 包 simple-fancy-logger 使用教程

    前言 在前端开发中,我们经常需要在控制台输出各种信息来协助我们调试代码和查看程序运行情况。这时候,使用一个好用的日志记录工具可以让我们更加高效地开发和调试。 简单好用的 npm 包 simple-fa...

    3 年前
  • npm 包 octoberry 使用教程

    Octoberry 是一个管理 GitHub 仓库的命令行工具,它支持快速创建、克隆、合并和发布仓库等操作。本篇文章将详细介绍如何使用 npm 包 Octoberry。

    3 年前
  • npm 包 @tomchentw/istanbul-api 使用教程

    前言 在前端开发过程中,测试覆盖率是非常重要的指标之一。而使用 Istanbul 工具可以很方便地生成测试覆盖率报告。而通过 @tomchentw/istanbul-api 包,我们可以在 Node....

    3 年前
  • npm 包 webpack-plugin-critical-customize-css 使用教程

    Web 页面性能优化是前端工程师一直要关注的话题,而关键渲染路径(Critical Rendering Path)则是 Web 页面性能优化的重要一环。其中,CSS 样式文件的优化是提高性能的重要一步...

    3 年前
  • npm 包 gy-cli 使用教程

    在前端开发中,使用 npm 包可以让我们更快速、高效地完成项目。其中好用的工具有很多,比如 gy-cli 这个 npm 包,它可以帮助开发者快速生成项目骨架。 本文将介绍 gy-cli 的使用教程,包...

    3 年前
  • npm 包 feng3dnpmtest 使用教程

    前言 feng3dnpmtest 是一款基于 npm 的前端工具包,可以快速搭建 3D 场景开发的环境。该工具包集成了一些常见的三维模型文件格式解析器、3D 场景渲染引擎、物理引擎等,可以大大提高前端...

    3 年前
  • npm 包 ngx-image-panel 使用教程

    什么是 ngx-image-panel ngx-image-panel 是一个基于 angular 框架的 npm 包,能够对图片进行裁剪、旋转、缩放、拖动等操作,并且能够添加水印等效果。

    3 年前
  • npm 包 react-text-parser 使用教程

    在前端开发中,我们经常需要对文本内容进行解析和处理。而使用 npm 包 react-text-parser 可以轻松地对文本进行处理并将其嵌入到 React 组件中。

    3 年前
  • npm 包 ng-requester 使用教程

    npm 包 ng-requester 使用教程 在前端开发中,我们经常需要发送 HTTP 请求来获取数据或者与服务器进行交互。ng-requester 是一个使用 AngularJS 编写的 npm ...

    3 年前
  • npm 包 o-ajax 使用教程

    在前端开发中,经常需要向后端取回数据,为此我们需要使用 AJAX 技术。而 o-ajax 是一个强大的 Ajax 库,可以帮助我们更方便的进行 Ajax 编程。本文将教大家如何使用 o-ajax 库。

    3 年前

相关推荐

    暂无文章