README

此扩展旨在运行所有必要的工具来检查代码是否违反composer（例如工具 - PHP Mess Detector、PHP Code Sniffer、PHP Dead Code Detector、PHP Copy Paste）。

安装

composer require piotrpasich/code-quality-threshold:dev-master --dev

配置

您可能需要将以下内容添加到您的composer.json文件中

"scripts": {
    "quality-test": [
        "piotrpasich\\CodeQualityThreshold\\Composer\\ScriptHandler::checkThresholds"
    ]
},

然后执行以下命令

composer quality-test

您还可以将此脚本添加到现有的脚本中，例如 post-update-cmd。

报告

如果测试抛出异常，您始终可以请求报告

composer quality-test -v

高级配置

此插件默认检查应用程序文件夹，但您可以通过创建yml文件来更改此行为。这可能放在您希望的位置，例如 app/Config/cqt.yml。

然后您需要将以下额外选项添加到您的composer.json文件中

"extra": {
    "cqt-parameters": {
        "file": "app/Config/cqt.yml"
    }
}

示例yml文件可能如下所示

phpmd:
    class: piotrpasich\CodeQualityThreshold\Tool\Phpmd
    options:
        threshold: 42
        directory: src
        rules: Config/Phpmd/ruleset.xml

phpcs:
    class: piotrpasich\CodeQualityThreshold\Tool\Phpcs
    options:
        threshold: 42
        rules: Config/Phpcs/ruleset.xml
        directory: src

phpcpd:
    class: piotrpasich\CodeQualityThreshold\Tool\Phpcpd
    options:
        threshold: 42
        directory: src

Phpdcd:
    class: piotrpasich\CodeQualityThreshold\Tool\Phpdcd
    options:
        directory: src
        threshold: 21

添加新工具

要添加新工具，您需要在yml文件中指定新的记录（查看高级配置章节）并创建一个扩展插件中抽象类Tool的类。

piotrpasich / code-quality-threshold

维护者

详细信息

README

安装

配置

报告

高级配置

添加新工具