什么是 consensass？
consensass 是一款基于区块链技术的去中心化协议，旨在帮助开发团队更加高效地协作，实现代码质量和安全性的共识。consensass 包含三个主要的模块：代码审查、代码统计和代码安全。
如何使用 consensass？
1. 安装 consensass
在 Terminal 中输入以下命令：
--- ------- ----------
2. 导入 consensass
在需要使用 consensass 的文件中，导入 consensass：
----- ---------- - ----------------------
3. 运行 consensass
使用以下命令来启动 consensass：
------------------------
其中，options 是一个对象，包含以下属性：
dir：必须指定，代表需要被审查的代码所在的目录。output：可选，代表审查结果的输出方式，可以是text或json。ruleset：可选，代表规则集的名称，目前支持的规则集有standard、strict和light。
示例代码：
----- ---------- - ---------------------- ---------------- ---- -------------------------- ------- ------- -------- ---------- ---
4. 审查结果解读
consensass 的审查结果分为两种输出方式：text 和 json。
text 输出方式
text 输出方式即为文本输出，输出格式如下：
---- ------ ------ ------------------- ----- ------ -- ------- - --------- - -------- -- ------ ------ -- ------------------ - ------ ------- --------- - -------- ------ -------- - ------- ---- ------- -------- --- ---- -- ------------------ - ------ ----- ------ -------- - ------- ---- ------- --------- ------- -- ---
其中，第一行代表总体审查结果，包括文件数量、错误、警告和提示等信息。从第二行开始，依次列出每个被审查的文件的审查结果，包括错误、警告和提示等信息。
json 输出方式
json 输出方式即为 JSON 格式输出，示例代码如下：
-
---------- -
-------- ---
--------- --
----------- --
---------- --
--
--------- -
-
----------- --------------------
-------- -
-------- ----------
--
---------- -
------- ---------
--
--------- -
----- ------- -------- --- -----
-
--
-
----------- --------------------
-------- -
------ ------ ---------
--
--------- -
----- ------- --------- --------
-
--
---
-
-其中，summary 属性是总体审查结果，detail 属性是每个文件的审查结果。
规则集
目前，consensass 支持以下规则集：
standard：标准的规则集，包括常见的代码错误、代码风格和常见的代码缺陷等检查项。strict：严格的规则集，在standard的基础上增加了一些更加严格的检查项，包括安全性问题等。light：轻量级的规则集，在standard的基础上去掉了一些比较严格的检查项，主要用于快速检查代码质量。
你可以通过以下方式来指定规则集：
---------------- ---- -------------------------- ------- ------- -------- ---------- ---
总结
consensass 是一款非常实用的工具，可以帮助我们更好地审查代码，提高代码质量和安全性。在使用 consensass 时，我们需要注意指定审查的目录、输出方式和规则集等参数，从而得到更加满意的审查结果。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/600566c381e8991b448e3237