README

一旦你的PHPUnit测试通过，自动检查代码质量。

安装

安装通过Composer执行。

composer require --dev drawmyattention/phpunit-code-quality

在你的phpunit.xml文件中注册测试监听器

<listeners>
    <listener class="DrawMyAttention\CodeQuality\Listeners\ComplexityAnalysisListener">
        <arguments>
            <object class="DrawMyAttention\CodeQuality\ComplexityAnalyser"/>
            <bool>true</bool>
        </arguments>
    </listener>
</listeners>

配置项目设置

你可以定义要扫描哪些目录以检查代码质量，以及哪些目录和文件将被排除。默认值是合理的。默认情况下，存储在src目录中的代码将被检查，而存储在tests目录中的代码将被排除。

你可以在项目的根目录中创建一个complexity-analyser-config.php文件来指定替代设置。请参阅提供的配置文件，或者复制并粘贴以下示例

return [

    // Directories which should be checked for code quality
    'scan_directories' => [
        'src',
    ],

    // Directories which should not be checked
    'excluded_directories' => [
        'app/Support',
        'tests',
    ],

    // Files which should not be checked
    'excluded_files' => [
        'app/Http/Controllers/SomeController.php',
    ],

];

由于这个应用程序使用PHP Mess Detector来检查代码质量，因此你可以定义在检查代码质量时应应用哪些规则。规则的全列表在此。

贡献

如果你发现了一个错误或者想为此包的开发做出贡献，请提交一个pull-request（如果可能的话，包括测试）。

drawmyattention / phpunit-code-quality

维护者

详细信息

README

安装

配置项目设置

贡献