README

安装与使用

需要 PHP 5.5+ 或 HHVM 3.6+。

要获取 Hippo 的最新版本，只需使用 Composer 引入项目

$ composer require hippophp/hippo

如果您想开发 Hippo，您需要在系统上安装 Git 以及 >= PHP 5.5。

将代码库克隆到本地环境

$ git clone git@github.com:hippophp/hippo.git

然后安装依赖项

$ cd hippo
$ composer install

使用方法

一旦 Hippo 在目录中，您可以使用以下命令运行它

$ ./bin/hippo ./src

默认情况下，Hippo 将所有内容输出到 STDOUT。您可以使用以下命令获取帮助信息

$ ./bin/hippo --help
Hippo 0.1.0 by James Brooks, Marcin Kurczewski

Usage: hippo [switches] <directory>
  -h, --help                Prints this usage information
  -v, --version             Print version information
  -l, --log LOGLEVELS       Sets which severity levels should be logged
                            (default: "info,warning,error")
  -s, --strict 1|0          Enables or disables strict mode (default: 0)
                            Strict mode will exit with code 1 on any violation.
  -q, --quiet 1|0           Same as --log ""
      --verbose 1|0         Same as --log "info,warning,error"
  -c, --config PATH         Use specific config (default: "base")
  --report-xml PATH         Output a Checkstyle-compatible XML to PATH

Available configs:
  - base
  - PEAR
  - PGS-2
  - PSR-1
  - PSR-2

测试

我们对 Hippo 建立了一个测试系统。对于每个拉取请求，都会在 Travis CI 上运行测试。

关于

Hippo 最初是从 PHPCheckstyle 分叉而来，然而，在意识到需要进行完整重写后，核心思想发生了变化，因此 Hippo 诞生了。

Hippo 是一个开源工具，帮助 PHP 程序员遵循某些编码约定。该工具检查输入的 PHP 源代码，并报告任何违反给定标准的情况。

兼容 PHP 5.5 及以上版本。

目标

• 创建合适的测试套件。
• 检查应该能够实现不同类型的检查，为每个检查提供更多自由度。
• 集成 PHP-Parser 用于 AST。检查可以扩展 AST 节点树类。
• 将默认标准设置为 PSR 2。
  • 标准和配置应该能够扩展。
  • PSR-1
  • PSR-2
  • PGS-2
  • Zend
  • PEAR
• 配置键应允许命名模式的灵活性，只要它是有效的名称即可。
  • camelCase
  • snake_case
  • PascalCase
• 作为二进制文件运行，具有控制台输出，也可以作为库使用。
• 切换到 semver 版本控制。

许可证

Hippo 在 MIT 许可证 (MIT) 下授权。