npm 包 commit-and-pr 使用教程

阅读时长 4 分钟读完

介绍

在前端开发过程中,我们通常需要提交代码到版本管理平台,如 GitHub 或 GitLab 等。而使用 commit-and-pr 工具,可以让我们更方便地进行代码提交和 PR 发起。

commit-and-pr 是一个 npm 包,它使我们能够快速提交代码并直接打开一份新的 PR 请求,同时还能够自动生成对应的 commit message,大大简化了代码提交和 PR 发起的流程。

在本文中,我将介绍如何使用 commit-and-pr 工具来进行代码提交和 PR 发起。

安装

在安装 commit-and-pr 之前,需要确保已经安装了 Git 和 Node.js 。

使用 npm 安装 commit-and-pr :

使用

执行以下命令,开始使用 commit-and-pr 工具:

该命令将帮助你完成以下步骤:

  1. 创建一个新的 git 分支 feature/my-new-feature
  2. 使用 npm version patch 命令自动更新 package.json 文件,并生成一段新的版本号(仅在 package.json 中指明 version 字段时才会执行);
  3. 生成一段默认的 commit message;
  4. 打开一个新的 PR 页面,允许你查看并编辑新建的 PR。

在打开的 PR 页面中,你可以查看与修改新建的 PR 信息、关注 review、打标记和提交代码并合并 PR 等操作。

配置

commit-and-pr 还允许我们进行一些简单的配置,以更好地满足个人或团队的需求。

默认情况下,commit-and-pr 会生成包含类似以下内容的 commit message :

其中:

  • feat 指代本次提交的类型;
  • #2 表示关联的 issue 或 PR 编号;
  • [feature/my-new-feature] 表示所在的分支;
  • add new feature 是简短的摘要,表明本次提交的内容;
  • - some more detailed message here 是可选的详细说明。

如果需要更改默认的提交信息格式或添加其他功能(如自动发布),可以通过添加 .commit-and-pr.js 文件来实现。

以下是一个 .commit-and-pr.js 配置示例:

-- -------------------- ---- -------
-------------- - -
  ------- -
    -------------- --------- -- -
      ----- - ----- ------- ------- - - --------
      ------ -------------------- ------------
    -
  --
  --------- --------- ------ -- -
    --------------- ----------
  -
-
  • config 对象可以配置用于覆盖默认生成的 commit message。在示例中,我们使用 type(分支名): 简要说明 的格式来生成新的 commit message 。
  • postpush 方法允许我们在 git push 完成之后执行自定义的 shell 命令。在示例中,我们使用 npm publish 来执行一个自动发布的命令。

有了这样的配置,只需轻轻按一下按钮,我们就可以自动更新 version 并将新版本发布到 npm 上。

结论

commit-and-pr 工具是一款非常实用的 npm 包,它可以极大地简化我们在 github 上提交代码和发起 PR 的流程,简洁明了的 commit message 也让整个代码提交过程更加规范化。希望本文的教程可以帮助你更好地了解和使用 commit-and-pr 工具,同时希望你可以尝试使用 commit-and-pr 工具来提高你的团队协作效率和代码规范程度。

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

纠错
反馈