marcelsud/diffcs

在 pull requests 中运行 PHP 代码规范检查器

v0.2.1 2017-10-01 22:31 UTC

README

一个在 Github 上对您的 pull requests 执行代码规范检查的工具。

如何安装

您可以通过以下方式之一获取 marcelsud/diffcs 的副本

作为 Phar (推荐)

您可以简单地下载一个预先编译并准备好使用的 Phar 版本,并将其放置在任何目录中。只需从我们的 发布页面 下载最新的 diffcs.phar 文件即可

curl -LO https://github.com/marcelsud/diffcs/releases/download/v0.2.1/diffcs.phar
php diffcs.phar --help

可选地,您可以通过将其添加到您的 bin 文件夹中来全局安装它

chmod +x diffcs.phar
mv diffcs.phar /usr/local/bin/diffcs

通过 composer

composer global require "marcelsud/diffcs":"dev-master"
sudo ln -nfs ~/.composer/vendor/bin/diffcs /usr/local/bin/diffcs

通过 docker

docker run --rm -it marcelsud/diffcs --help

如何使用

对于公共仓库

运行以下命令: diffcs <source>/<project> <pull request id>,其中

  • <source> 是项目背后的公司/用户;
  • <project> 是 Github 上的项目名称;
  • <pull request id> 是由 Github 创建的 pull request ID。

示例:

diffcs symfony/symfony 13342

对于私有仓库

使用用户名和密码进行身份验证

执行以下命令:diffcs <source>/<project> <pull request id> --github-user=<github username>,其中

  • <github username> 是您的 Github 用户名。
  • 之后将要求输入密码,并且仅用于检查私有仓库。

示例:

diffcs symfony/symfony 13342 --github-user=yourusername

使用 Github token 进行身份验证

执行以下命令:diffcs <source>/<project> <pull request id> --github-token=<github token>,其中

示例:

diffcs symfony/symfony 13342 --github-token=256199c24f9132f84e9bb06271ff65a3176a2f05

Image