jbrooksuk/phpcheckstyle

PHPCheckstyle 是一款开源工具，帮助 PHP 程序员遵循某些编码规范

维护者

详细信息

github.com/PHPCheckstyle/phpcheckstyle

主页

源代码

问题

维基

安装: 399

依赖项: 0

建议者: 0

安全: 0

星标: 164

关注者: 15

分支: 31

开放问题: 18

V0.14.8 2018-08-10 07:47 UTC

Requires

  • php: >=5.0.0

Requires (Dev)

OSL-2.1 86fbbac419468c52d000fe0e0743c555fac8a42a

standardconventioncheckstyle

This package is auto-updated.

Last update: 2024-09-09 11:34:07 UTC

README

Build Status

概览

PHPCheckstyle 是一款开源工具，帮助 PHP 程序员遵循某些编码规范。该工具检查输入的 PHP 源代码，并报告任何与编码规范的偏差。

工具使用 PEAR 编码规范作为默认编码规范。但允许您配置以适应您的编码规范。

请访问 https://github.com/PHPCheckstyle/phpcheckstyle/wiki 获取更多信息和相关文档

要求

  • PHP 5.0 或更高版本。
  • Web 浏览器查看 checkstyle 报告（仅限 HTML 查看）
  • 以上就是所有内容。

安装

使用 Composer 进行安装

composer require phpcheckstyle/phpcheckstyle

或将 phpcheckstyle/phpcheckstyle 添加到 composer.json 中的依赖项

{
    "require": {
        "phpcheckstyle/phpcheckstyle": "dev-master"
    }
}

使用 composer update 更新您的包，或者如果您是从头安装，请使用 composer install。

手动安装

只需下载 https://github.com/PHPCheckstyle/phpcheckstyle/archive/master.zip 并解压发行版。

$> unzip PhpCheckstyle.zip

这将创建一个名为 phpcheckstyle 的目录，并展开其中的所有文件。

使用 Vagrant 进行测试

  • 安装 VirtualBox

  • 安装 Vagrant

  • 在项目根目录中启动 vagrant up 以启动虚拟机

  • 如果遇到“guest additions”问题，请启动

vagrant plugin install vagrant-vbguest

  • 要运行 PHPCheckstyle 本身，请输入 vagrant provision --provision-with run_phpcheckstyle
  • 要运行 PHPUnit，请输入 vagrant provision --provision-with run_phpunit
  • 要登录到虚拟机中，请输入 vagrant ssh

使用

  • 更改到 PHPCheckstyle 安装目录。

    $> cd phpcheckstyle

  • 执行 run.php 脚本并提供 --src 选项。

    $> php run.php --src <php source directory/file>

  • 使用 --help 选项查看更多选项

    $> php run.php --help

许可

见 LICENSE