简介
review.js 是一个适用于前端开发的 JavaScript 库，用于创建和管理代码评审、审查和讨论。它可以在开发过程中帮助团队减小错误率，提高代码可读性和可维护性。
本文将介绍如何使用 review.js 进行代码评审，包括安装、初始化、配置和具体使用。同时，也会阐述一些在使用 review.js 过程中需要注意的细节问题。
安装
使用 npm 安装 review.js：
--- ------- --------- ------
初始化
在项目的根目录中创建 review.config.js 文件，并添加以下基本配置内容：
----- ------ - --------------------- -------------- - --- -------- ---------- --------- --------- -- ----- -------- -- -- ------- ------------------------ --- -- ---------- ---------- ----------- --------- -- ---- ---
配置
评审者及限制
在 review.config.js 中，可以通过 reviewers 选项来配置需要参与评审的用户列表，通过 maxUser 选项来限制每个评审会话中的最大用户数量。
-------------- - --- -------- ---------- --------- -------- -------- --------- -- ------- -------- -- -- -------- -- --- ---
投票类型
在 review.config.js 中，还可以通过 voteTypes 选项来配置用于投票的类型。
-------------- - --- -------- -- --- ---------- ----------- --------- ----------------- ---
需要票数百分比
为通过评审的代码所需的票数百分比，在 review.config.js 中通过 requiredVotesPercentage 选项进行配置。
-------------- - --- -------- -- --- ------------------------ --- ---
自定义代码源
review.js 通过 Git 命令来获取代码数据源。默认情况下，review.js 会使用当前仓库作为源。如果需要从其他仓库获取源，可以通过以下方式配置：
-------------- - --- --------
-- ---
----------- -
----- ------
---- ---------------------------------------
------- ----------
---- ------
--
---type: 数据源类型，默认为giturl: 仓库的 URLbranch: 需要获取内容的分支名称dir: 仓库中包含需要评审的代码的目录名称
使用
开始评审
安装成功、初始化配置好以及在 review.config.js 中指定代码源后，可以通过以下方式启动代码评审会话：
----- ------ - --------------------- ----- ------ - --- --------- ---------------
这将为当前代码源启动一个评审会话，将评审者列表中的用户添加到评审队列中。
提交评审
代码评审需要提交要评审 的代码变更，在评审过程中提交的变更将受到评审队列中的评审者的评审。
----- ------ - ---------------------
----- ------ - --- ---------
---------------
-- ----
---------------
------- -
------- -
----- --------
--
-------- ------ --- --- ---------
--- -----------
--------- -----------------------
--
----- -
- -- ---- --- ----
- -- ---- --- ----
--
---在提交评审时，需要提供包含代码所做变更的 Git 提交数据，以及变更的差异。这些参数可以构建一个提交对象。示例代码中演示了如何创建基本提交对象。
提交对象参数如下：
commit.author.name: 提交作者的名称commit.message: 提交的消息commit.id: 提交的 IDcommit.datetime: 提交的时间diff: 变更的差异
投票评审
一旦评审会话开始，评审者将收到一条通知。他们可以通过以下方式进行投票评审：
----- ------ - ---------------------
----- ------ - --- ---------
---------------
-- --------
------------------
------- -
------- -
----- --------
--
-------- ------ --- --- ---------
--- -----------
--------- -----------------------
--
----- -
- -- ---- --- ----
- -- ---- --- ----
--
---
-------------------- -----------在投票时，需要提供评审者用户名和投票类型。
注意事项
- 如果需要使用 review.js 进行评审，代码提交者需要跟进代码源的变更，以确保他们提交的代码修改在评审会话开始前与代码源保持一致。
- review.js 使用 Git 命令来获取代码数据源。因此，你需要配置 Git 环境。
- review.js 不会更改代码源。它仅用于通过评审/拒绝投票以及提交评审的总票数评审评审者代码审查和讨论。
- 你需要知道如何使用 Git，在 review.js 中定制自己的代码源。
总结
review.js 可以通过集中化的方式管理团队的代码评审，减小错误率，提高代码可读性和可维护性。我们可以通过安装、初始化和配置 review.js，以及提交评审和投票评审，管理我们的代码审查和讨论。
在使用 review.js 时需要注意一些细节问题，如跟进代码源变更、Git 环境配置以及自定义代码源。
我们相信 review.js 可以帮助团队更好地管理代码评审、审查和讨论，以便高效地交付项目。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/60067355890c4f7277583a6e