mi-schi / php-code-checker
执行测试并检查PHP代码
Requires
- php: >=5.6.0
- df/php-coverfish: @stable
- mi-schi/phpmd-symfony2: @stable
- move-elevator/symfony-coding-standard: @stable
- pdepend/pdepend: @stable
- phploc/phploc: @stable
- phpmd/phpmd: @stable
- sebastian/phpcpd: @stable
- squizlabs/php_codesniffer: @stable
README
功能
使用
创建指标
此脚本是配置jenkins上ant的更好替代方案。Python脚本更灵活,也可以用于本地开发机器。您可以在项目的composer.json
中定义所有设置,但不必这么做。脚本也支持排除多个文件夹。
脚本已在Python 2.6
和Python 3.5
上进行了测试。
安装
通过git
git clone git@github.com:mi-schi/php-code-checker.git
通过composer
composer require mi-schi/php-code-checker
用法
使用Python在项目文件夹中执行脚本
checker.py all
checker.py check
checker.py metric
all
参数执行check
和metric
参数。您可以将第二个参数设置为项目路径
checker.py all /path/to/your/project
checker.py all relative/path
如果您想无论配置如何都执行带有覆盖率的测试,则使用checker.py coverage
参数。您可以使用update.py path/to/php
更新所有内部依赖。
配置
配置很简单。只需查看default_configuration.json以获取使用说明。向您的项目的composer.json
中添加一个额外的属性,如果需要,则覆盖默认配置。php-code-checker
自带对phpunit
、phpcs
等的依赖。如果您想使用另一个phpunit
,您可以定义bin-dir
属性并在composer要求中添加phpunit
。如果php-code-checker
找到path/to/your/project/bin/phpunit
,则将使用此二进制文件。否则,您的测试将使用php-code-checker
附带的phpunit
版本执行。
Jenkins集成
处理所有这些报告都需要在Jenkins上进行大量配置。首先,您必须安装以下插件
此外还有用
然后,创建一个名为default-job
的新空作业。将default-jenkins-config.xml复制到您的Jenkins上的/var/lib/jenkins/jobs/default-job/config.xml
。就是这样!从现在开始附加配置并复制default-job
。