npm 包 decorate-gh-pr 使用教程-JavaScript中文网-JavaScript教程资源分享门户

简介

decorate-gh-pr 是 Node.js 打造的一个小工具包。它可以在 GitHub 的 Pull Request 中呈现代码的差异并高亮显示它们之间的区别。该包主要用于代码审查，提高代码可读性及流畅性，并减少代码冲突引起的问题。

安装

安装 decorate-gh-pr 有两种方法。您可以在您的代码库中安装它，也可以全局安装它，所以您可以在所有的工程中使用它。

全局安装
执行以下命令：
```
npm install -g decorate-gh-pr
```
局部安装
进入您的代码库并执行以下命令：
```
npm install decorate-gh-pr
```

安装完成后，您可以通过在命令行中输入 decorate-gh-pr -h 检查是否安装成功。

使用方法

在您的代码库中使用 decorate-gh-pr 也有两种方法：使用命令行或集成在您的 Git 操作中。

命令行

进入您的代码库的本地副本。
将您的更改提交并推入您的分支。
运行以下命令：
```
decorate-gh-pr [options]  
```
在浏览器中打开 GitHub Pull Request 的页面。

默认情况下，decorate-gh-pr 将自动检测您的所在仓库并呈现您当前分支与基分支之间的差异。但是，您也可以通过以下选项来指定分支和仓库：

-u, --url         URL to a specific Pull Request
-r, --repository  GitHub repository (in 'owner/repository' format)
-b, --base        Base branch (default: 'master')
-h, --head        Head branch (default: current branch)

Git 集成

您也可以使用 decorate-gh-pr 集成到您的 Git 操作中。例如，在您将更改推入您的分支之后，在您运行 git push 命令之前，您可以运行以下命令来自动在浏览器中打开 Pull Request 页面：

$ decorate-gh-pr -u "$(git config --get remote.origin.url | sed 's/.git$//').pull/new/$(git symbolic-ref --short HEAD | sed 's_[^a-zA-Z0-9]*__g')"

功能展示

当您安装和使用 decorate-gh-pr 之后，您会注意到 GitHub 的 Pull Request 页面上代码的格式发生了变化，代码的差异被用红色和绿色的象征性的颜色标注出来，使您更容易知道做出改变和哪里做出了改变。

举个例子，在您的分支中更改部分代码，则代码审查时的代码片段将看起来像这样：

这使您可以更轻松地确定更改在哪里，以及更改情况的细节等。

结论

decorate-gh-pr 使代码审查更容易、合并代码更快捷，减少代码冲突的问题，提高代码准确性和质量。其功能简单易用，使用便捷，相信您在使用中会得到极佳的体验和收益。

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