README

一键分析PHP代码。

要求

• PHP >= 5.4.0
• xsl 扩展用于 HTML 报告

为什么？

每个分析器都有不同的参数和选项，格式各异（在PHP世界中不足为奇 :)）。如果你曾经尝试过让忽略目录工作，你就会明白我的意思。另一方面，CLI工具很酷，因为你可以分析任何目录或文件。不幸的是，Jenkins、Travis、Scrutiziner需要特殊的配置文件。如果你想分析你的Symfony应用程序中的每个捆绑包呢？你会为每个捆绑包创建Jenkins项目/任务吗？

• 我希望在不进行复杂配置和创建额外文件/任务的情况下分析选定的目录
• 我不关心在phploc、phpmd、...中的忽略目录的格式
• 我不想在QA工具更新或找到像PHPMetrics这样的酷工具时更新所有项目
• 我不想分析XML文件→工具应该能够构建HTML报告
• 我希望执行时间快→工具应该并行运行(感谢Robo)

可用的工具

建议的工具

新添加的工具未预安装。如果您想使用它们，您必须安装相关的composer包。

提示：使用bin/suggested-tools.sh install安装工具。

安装

克隆 + composer

# install phpqa
git clone https://github.com/EdgedesignCZ/phpqa.git && cd phpqa && composer install --no-dev

# make phpqa globally accessible
## you can symlink binary
sudo ln -s /path-to-phpqa-repository/phpqa /usr/bin/phpqa
## or add this directory to your PATH in your ~/.bash_profile (or ~/.bashrc)
export PATH=~/path-to-phpqa-repository-from-pwd:$PATH

Composer

# global installation
composer global require edgedesign/phpqa --update-no-dev
# Make sure you have ~/.composer/vendor/bin/ in your PATH.

# local installation
composer require edgedesign/phpqa --dev

当然，您可以在您的composer.json中的require-dev部分添加依赖。但我不会推荐这样做。根据我的经验，一个分析N个项目的QA工具比N个项目带有N个分析器要好。您可以根据需要更新多少个存储库来决定。

Symfony3组件

Symfony3自版本1.7起支持。安装至少版本~3.0的sebastian/phpcpd，否则您将收到错误The helper "progress" is not defined.

{
    "require-dev": {
        "edgedesign/phpqa": ">=1.7",
        "sebastian/phpcpd": "~3.0"
    }
}

在本地项目中假全局安装

您在依赖关系方面有麻烦，无法全局安装phpqa吗？在子目录中安装phpqa。

#!/bin/sh

if [ ! -f qa/phpqa ];
then
    echo "installing phpqa"
    (git clone https://github.com/EdgedesignCZ/phpqa.git ./qa  && cd qa && composer install --no-dev)
fi

qa/phpqa

Docker

官方Docker镜像为：https://hub.docker.com/r/zdenekdrahos/phpqa/。该镜像可用于Gitlab CI。请注意，该镜像尽可能精简，这可能会在运行PHPUnit测试时出现问题。在这种情况下，您可能会缺少数据库等PHP扩展（您可以在另一个php image中安装phpqa）。

docker run --rm -it zdenekdrahos/phpqa:v1.23.3 phpqa tools
# using a tool without phpqa
docker run --rm -it zdenekdrahos/phpqa:v1.23.3 phploc -v

还有其他可用的镜像：eko3alpha/docker-phpqa 和 sparkfabrik/docker-phpqa。 phpqa 被用作入口点（我在Gitlab CI中无法使用这些镜像）。

docker run --rm -u $UID -v $PWD:/app eko3alpha/docker-phpqa --report --ignoredDirs vendor,build,migrations,test

分析

提示： CLI选项可以在.phpqa.yml中定义

输出模式

退出代码

phpqa 从版本1.6开始可以返回非零退出代码。这是一个可选功能，默认情况下是关闭的。您必须在--tools中定义phpcpd、phpcs、phpmd允许的错误数量。

例如，您的Travis CI 或 Circle CI 构建应该在引入新错误时失败。定义每个工具允许的错误数量，并监视构建

phpqa --report --tools phpcs:0,phpmd:0,phpcpd:0,parallel-lint:0,phpstan:0,phpmetrics,phploc,pdepend

允许的错误数量也可以在.phpqa.yml中定义。

phpqa:
    # can be overriden by CLI: phpqa --tools phpcs:1
    tools:
        - phpcs:0

文件模式

提示： 如果您只想计算错误而不是phpcs警告，则覆盖phpcs.ignoreWarnings。

CLI模式

提示： 使用echo $?显示退出代码。

高级配置 - .phpqa.yml

从.phpqa.yml提供CLI选项

使用.phpqa.yml覆盖工具设置

.phpqa.yml将在当前工作目录中自动检测，但您可以通过选项指定目录

# use .phpqa.yml from defined directory
phpqa --config path-to-directory-with-config

您不必指定完整的配置。缺失或空值将替换为我们的默认值.phpqa.yml。以下是最小配置示例，仅定义了CodeSniffer标准

phpcs:
    standard: Zend

提示： 使用PHP Coding Standard Generator生成phpcs/phpmd标准。

您可以指定多个配置目录（用,分隔）。它们将按定义的顺序加载。如果您有一个要在多个项目中使用的公共配置文件，但仍然希望有每个项目的配置，这可能会很有用。此外，配置文件中的路径相对于配置文件的位置，因此如果您有一个包含自定义工具的包，该包中的.phpqa.yml可以引用其内部的文件。

phpqa --config ~/phpqa/,my-config/,$(pwd)

HTML报告

如果您没有Jenkins或其他CI服务器，则可以使用HTML报告。当您添加--report选项时，将构建HTML文件。请参阅phpqa报告。

# build html reports
phpqa --report

自定义模板

如果您不喜欢默认模板，请定义自定义模板。默认模板。您必须在您的.phpqa.yml中定义xsl文件的路径。

# use different template for PHPMD, use default for other tools
report:
    phpmd: my-templates/phpmd.xsl

请注意，所有路径都是相对于.phpqa.yml的。如果您没有自定义模板，请不要复制粘贴report部分！

要求

要导出HTML报告，必须安装并启用xsl扩展。否则，您将得到错误PHP致命错误：未找到类 'XSLTProcessor'。

# install xsl extension in Ubuntu
sudo apt-get update
sudo apt-get install php5-xsl
sudo service apache2 restart

持续集成

在Edgedesign中，我们使用Jenkins-CI。以下是一些Phing、Robo和bash任务的示例。

单目录项目

在Symfony项目中，通常您有一个包含所有代码和测试的src目录。因此，您不需要忽略 vendors、web 目录等。

Phing - build.xml

<target name="ci-phpqa">
    <exec executable="phpqa" passthru="true">
        <arg value="--analyzedDirs=./src" />
        <arg value="--buildDir=./build/logs" />
        <arg value="--report" />
    </exec>
</target>

Robo - RoboFile.php

public function ciPhpqa()
{
    $this->taskExec('phpqa')
        ->option('analyzedDirs', './src')
        ->option('buildDir', './build/logs')
        ->option('report')
        ->run();
}

多目录项目（src、tests等）

当您分析项目根目录时，不要忘记忽略 vendors 和其他非代码目录。否则，分析可能会非常耗时。

自版本1.8起，phpqa 支持分析多个目录。除了仅分析第一个目录的 phpmetrics 之外。如果您依赖于 phpmetrics 报告，请分析根目录并忽略其他目录。

Phing - build.xml

<target name="ci-phpqa">
    <exec executable="phpqa" passthru="true">
        <arg value="--analyzedDirs=./" />
        <arg value="--buildDir=./build/logs" />
        <arg value="--ignoredDirs=app,bin,build,vendor,web" />
        <arg value="--ignoredFiles= " />
        <arg value="--verbose" />
        <arg value="--report" />
    </exec>
</target>

Robo - RoboFile.php

public function ciPhpqa()
{
    $this->taskExec('phpqa')
        ->option('verbose')
        ->option('report')
        ->option('analyzedDirs', './')
        ->option('buildDir', './build')
        ->option('ignoredDirs', 'build,bin,vendor')
        ->option('ignoredFiles', 'RoboFile.php,error-handling.php')
        ->run();
}

Bash

phpqa --verbose --report --analyzedDirs ./ --buildDir ./var/CI --ignoredDirs=bin,log,temp,var,vendor,www

Circle.ci - 艺术品 + 全局安装

machine:
    php:
        version: 7.0.4

dependencies:
    cache_directories:
        - ~/.composer/cache
    post:
        - 'git clone https://github.com/EdgedesignCZ/phpqa.git ./qa && cd qa && composer install --no-dev'

test:
    override:
        - vendor/bin/phpunit --testdox-html ./var/tests/testdox.html --testdox-text ./var/tests/testdox.txt --log-junit $CIRCLE_TEST_REPORTS/phpunit/junit.xml
        - qa/phpqa --report --verbose --buildDir var/QA --ignoredDirs vendor --tools=phpcs:0,phpmd:0,phpcpd:0,phploc,pdepend,phpmetrics
    post:
        - cp -r ./var/QA $CIRCLE_ARTIFACTS
        - cp -r ./var/tests $CIRCLE_ARTIFACTS

Gitlab.ci - docker 安装 + composer 缓存 + 艺术品

stages:
  - test

test:
  stage: test
  image: zdenekdrahos/phpqa:v1.23.3
  variables:
    BACKEND_QA: "*/backend/var/QA"
    BACKEND_CACHE: $CI_PROJECT_DIR/.composercache
  cache:
    paths:
    - $BACKEND_CACHE
  script:
    - 'export COMPOSER_CACHE_DIR=$BACKEND_CACHE'
    - 'composer install --ignore-platform-reqs --no-progress --no-suggest'
    - 'phpqa --report --tools phpcs:0,phpunit:0 --buildDir var/QA --analyzedDirs ./ --ignoredDirs var,vendor'
  artifacts:
    when: always
    paths:
    - $BACKEND_QA

贡献

非常欢迎其他人的贡献！请发送pull request/issue。谢谢！

许可证

版权（c）2015，2016，2017，2018 Edgedesign.cz。MIT许可，有关详细信息，请参阅LICENSE。