在前端开发中，我们经常需要进行代码审阅，以达到规范代码风格、提高代码质量的目的。而 npm 包 easy_review 就是一个轻量级的代码审查工具。本文将详细介绍 easy_review 的使用方法，并附上实用示例代码。
安装
在命令行中输入以下代码即可安装 easy_review：
--- ------- ----------- ----------
初始化
在安装好 easy_review 后，我们需要进行初始化。在项目的根目录下创建一个名为 .easy_review 的文件夹，然后在该文件夹下创建一个名为 easy_review.js 的文件，并添加以下代码：
-------------- - -
------------ ------------- ------------ -------------
-------- -
-
-------- ---------
------------ -------------
--
-
-------- ---------- ---------
-------- -
------------------ ---
--------------- ----
--
------------ -------------
--
-
-------- -----------
-------- -
--- --------- -----
---------------- ----
--
------------ -------------
-
-
--其中，reviewers 属性是一个数组，存放所有的审查人员；rules 属性是一个对象数组，存放每个规则的配置项。上述示例中共定义了三个规则。
审查代码
在初始化之后，我们就可以开始对代码进行审查了。在命令行中执行以下代码：
--- -----------
easy_review 将会自动遍历规则中定义的文件，并对文件进行审查。例如，对于以下代码片段：
-- ------
--- - - --
- - --
- - --如果按照示例中的规则进行审查，easy_review 会给出以下提示：
- ------
- --- --- ----------- --- ---- ---------
-- ---- - ---- --
- --- - - --
-----------示例代码
以下示例代码展示了 easy_review 的完整使用方法：
-- ------ ------------------ --------- -- --------- -- ---- --------- -- ---------- ------ - ------ --- ----------- -
按照规则进行审查：
-- ---------------------------
-------------- - -
------------ -------- -------- --------
-------- -
-
-------- ---------
-------- -
------- --------- ----------
--------- --------- ---------
--
------------ --------
--
-
-------- ---------
-------- -
------------------------- -
--
------------ ---------
--
-
-------- -----------
-------- -
--------------- -------
--
------------ --------
-
-
--执行 easy_review：
--- -----------
输出：
- ------
- ------- --------- ------
-- ---- - ---- ---
- ------------------ --------
-----------------
- ------- ---- --- ----------- --------
-- ---- - ---- ---
- ------------------ --------
-----------------
- ---------
- ------- ------ --- ---- -------- ----------- ------------------------
-- ---- - --- --
- -- ----
---
- ----------
- ----- ----- ---------- --------------
-- ---- - --- ---
- ------ --- -----------
-----------
- -------- -- - ------- ----- -- ------- ---------- ----- --- - ---- ----------
---------- ----- ------ ----
-------- --- --- --可以看出，在按照规则进行审查之后，easy_review 检测到了三个错误，分别对应了三个文件的不合规代码。
结语
easy_review 是一个非常方便和实用的代码审查工具，它减轻了代码审查人员的工作负担，提高了代码开发的效率。希望本文能够对大家的前端开发工作有所帮助。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/60066dad7108f76aa73ecabe