dzunke/panaly-baseline-plugin

一个提供各种质量工具基线指标的Panaly插件

dev-main 2024-08-13 18:00 UTC

This package is auto-updated.

Last update: 2024-09-13 18:08:11 UTC


README

该插件为Panaly项目分析器提供开发生态系统中各种工具基线的指标。在引入新的质量工具或规则时,并不总是能够立即修复所有错误。大多数工具都提供“基线”功能,以在特定时间存储现有错误,然后在检查期间忽略这些错误。这允许开发者在一段时间内逐步修复这些问题,同时确保新代码符合质量标准,防止产生新的技术债务。

可用的指标

PHPMD基线计数

标识符:phpmd_baseline_count

返回一个包含PHPMD基线文件中条目数量的Integer结果,可以按主题进行过滤。

PHPStan基线计数

标识符:phpstan_baseline_count

返回一个包含PHPStan基线文件中条目总和的Integer结果,总结每个条目的数量。

Psalm基线计数

标识符:psalm_baseline_count

返回一个包含所有代表单个错误的类中code条目总和的Integer结果。

示例配置

# panaly.dist.yaml
plugins:
    DZunke\PanalyBaseline\BaselinePlugin: ~ # no options available

groups:
    baselines:
        title: "Baseline Overview"
        metrics:
            phpmd_baseline_count:
                baseline: ./path/to/my/baseline.xml
            phpmd_baseline_count_cyclomatic:
                title: PHPMD Cyclomatic Complexity Baseline Count
                baseline: ./path/to/my/baseline.xml
                filter: [ 'CyclomaticComplexity' ]

感谢和许可

Panaly项目分析器 - 基线插件 © 2024+, Denis Zunke。在MIT许可证下发布。

GitHub @dzunke  ·  Twitter @DZunke