ktamas77/remotecs

PHP远程编码标准验证

维护者

详情

github.com/ktamas77/remotecs

主页

源代码

问题

安装: 8

依赖项: 0

建议者: 0

安全: 0

星标: 1

关注者: 0

分支: 1

开放问题: 0

类型：项目

1.0.0 2016-05-29 06:46 UTC

Requires

MIT 244cdc4892a9d3f5f672da8b08ca0a2e3d6765fd

  • Tamas Kalman <ktamas77.woop@gmail.com>

validatorphpcscoding standards

This package is auto-updated.

Last update: 2024-09-06 06:53:49 UTC

README

为GitHub提供便捷的编码标准验证

RemoteCS是针对GitHub仓库的远程编码标准验证器。与常规的编码标准验证器不同，它不需要在客户端进行任何修改（不需要IDE插件，也不需要为GIT设置pre-commit钩子）。无需在每位开发者的机器上设置，只需在一个中央位置即可。

特性

  • RemoteCS是GitHub WebHook - 每次提交后激活
  • 在每次提交后扫描提交分支上新添加和修改的文件（不是整个仓库）
  • 目前支持PHP：PHP lint用于语法检查和PHPCS用于编码标准验证
  • 在提交后发送电子邮件给提交者关于结果（如果有任何结果）

未来方向

  • 在每个仓库中扫描忽略列表文件（例如：/.remotecs-ignore）
  • 将编码标准验证消息作为内联注释发送到GitHub的提交中
  • 多语言支持（Java、Ruby、Python等）
  • 根据开发者的代码整洁度给予开发者积分，并发送每周总结/排行榜
  • 网络界面

先决条件

  • PHP
  • GIT
  • PHPCS（PEAR/PHP_CodeSniffer）
  • 具有足够权限运行所有上述内容的网络服务器
  • 用于接收电子邮件的Amazon Simple Email Service凭据

快速安装

  • 将remotecs文件复制到您的网络服务器目录或使用composer进行安装
composer require ktamas77/remotecs
  • 将脚本的HTTP URL添加到Github -> 您的项目 -> 设置 -> 服务钩子 -> WebHook URL
  • 确保在Payload.class.php文件中路径正确，并且您的网络服务器具有足够的权限
  • 将config.sample.php复制到config.php，并设置您的Amazon Simple Email Service凭据以接收电子邮件
  • 点击测试钩子或提交并推送文件
  • 如果遇到问题，请在index.php中启用调试：$payload->debug(true);
  • 享受！=)

参考

作者