npm 包 hubot-review 使用教程

在日常工作中，我们经常需要进行代码的 Review，而 hubot-review 是一个非常方便的 npm 包，能够帮助我们自动化代码的 Review。

安装

在进行使用之前，我们需要先安装该 npm 包。在命令行中输入以下指令即可：

npm install hubot-review --save

配置

安装成功之后，我们还需要配置一些参数以确保该 npm 包能够正确运行。我们需要在 ./bin/hubot 文件中添加以下代码：

process.env.HUBOT_REVIEW_IGNORES = 'style';

同时，在 ./scripts 文件夹中添加一个 review.coffee 文件，其中包含以下代码：

module.exports = (robot) ->
  robot.router.post '/hubot/review', (req, res) ->
    { body: { review, ...restBody } } = req
    match = review.match /(^[^\n]*?\n)((?:\s{4}.+?\n)+)$/
    if !match then res.json {} else
      message = "#{match[1]}}\n#{reviewers}@@@\n#{match[2]}}"
      robot.messageRoom restBody.channel, message
      res.json {}

使用

现在，我们就可以在命令行中使用 hubot review 命令来进行代码的自动化 Review 了。在该命令后面，我们需要输入我们要 Review 的代码，然后选择 Reviewer 进行正式的代码 Review。

以下是一个例子：

hubot review

function sum(a, b) {
  return a + b;
}

如果我们希望排除某些代码，可以在命令行中添加 --ignore 参数，例如：

hubot review --ignore=style

function sum(a, b) {
  return a + b;
}

其中，--ignore 参数后面的参数即为需要排除的代码类型，例如 style、debug 等。

总结

通过使用 hubot-review 这个 npm 包，我们可以非常方便地自动化代码 Review，从而提高我们的开发效率和代码质量。同时，该 npm 包的代码也提供了非常好的学习和指导意义，我们可以根据其代码结构和实现方式来进一步优化和完善我们自己的代码。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055cbf81e8991b448da571