logicbrush/metrics

检查项目的Clover指标,并将提供的源文件中的方法Docblocks更新为`@Metric`注释。

v1.0.0 2024-09-27 16:31 UTC

README

这是一个命令行工具,用于更好地利用PHP中的覆盖率指标。主要功能是允许您使用表示方法覆盖率/复杂度的docblock注释更新源代码。与CI流程一起使用,可以在开发过程中保持指标在前端。

安装

composer require --dev logicbrush/metrics

用法

php ./vendor/bin/metrics annotate «path to coverage.xml» «path to source file»

这将使用@Metrics注释注释您的代码,例如

/**
 * You must have an existing docblock comment on your method for this to work.  
 * We won't add it for you.
 * 
 * @Metrics( crap = 10.2, uncovered = true )
 */
 public function someMethod() : void {
    ...
 }