npm 包 danger-plugin-complete-pr 使用教程-JavaScript中文网-JavaScript教程资源分享门户

前言

在今天的软件开发过程中，保证代码质量是非常重要的。而代码评审是确保代码质量的一项重要手段。在开发过程中，一个经过完整的评审流程的 pull request 并不容易。然而，即使 pull request 经过了评审和测试，还有一些细节和常见错误会被忽视，这些错误可能会对整个项目产生负面影响。相信如果你是一个在开发中习惯使用 pull request 的前端开发者，你一定也面临过这样的问题。

而 danger-plugin-complete-pr 这个 npm 包就是为了解决这个问题而诞生的，本文将深入介绍如何使用它。

什么是 danger-plugin-complete-pr

Danger 是一个基于 JavaScript 的库，它可以让你在 Pull Request 中添加检查规则，以检查代码中的潜在错误。它支持多个平台，包括 GitHub、GitLab 和 Bitbucket，非常适合用于代码审查、代码格式化等方面。

danger-plugin-complete-pr 是 danger 一个有用的插件，它可以自动化检查 complersion 和 CHANGELOG.md 文件是否更新到对应的版本号、以及检查 PR 是否包含了必要的字段：issue number、重新提交的 PR、以及对于 Bug 修复是否存在对应的问题号等。

如何使用 danger-plugin-complete-pr

步骤一：安装 danger-plugin-complete-pr

在你的项目根目录下执行以下命令安装 danger-plugin-complete-pr：

npm install --save-dev danger-plugin-complete-pr

安装完成后，在你的 dangerfile.js 中引入它：

import completePr from 'danger-plugin-complete-pr';

步骤二：添加 Danger 规则

在 dangerfile.js 中，添加以下代码

danger.gitlab.onChangeLog({
  failureMessage: '请更新 CHANGELOG.md 文件'
});

completePr();

这里使用了 danger.gitlab.onChangeLog 规则规则来检查 CHANGELOG.md 文件是否被更新。如果文件没有被更新，它会报错，打印一个自定义的失败消息。

步骤三：运行 Danger

安装完依赖并设置了 Danger 规则后，运行 danger 命令就可以对你的 Pull Request 进行自动化检查了。

yarn danger pr

示例代码

完整代码如下：

import completePr from 'danger-plugin-complete-pr';

danger.gitlab.onChangeLog({
  failureMessage: '请更新 CHANGELOG.md 文件'
});

completePr();

总结

相比于手动审查 PR 是否有相应页面链接和 issueode，danger-plugin-complete-pr 可以自动化完成这些流程，并在必要的时候，通过失败消息提示用户更新 CHANGELOG.md 文件，省去了繁琐的流程，增强了代码审查的可靠性，提高了代码的质量，可以有效的防止一些细节被漏掉。

需要注意的是，danger-plugin-complete-pr 默认是针对 GitLab 的，本文示例也为 GitLab 。如果你的项目使用的是 GitHub 或 BitBucket，请确保你的 Dangerfile.js 中使用的是相应的 API。

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