linasram/ecs-gitlab-format

easy-coding-standard 的 GitLab 输出格式化工具。

1.1.0 2024-05-20 11:57 UTC

This package is auto-updated.

Last update: 2024-09-20 12:49:21 UTC


README

GitLab 提供的 easy-coding-standard 输出格式化工具。以 GitLab 代码质量格式生成代码质量报告,因此您可以在 GitLab UI 中查看。

安装

使用 Composer 安装此包

composer require linasram/ecs-gitlab-format --dev

配置您的 ecs.php 文件以使用格式化工具

对于 easy-coding-standard <11.0

<?php

use LinasRam\EcsGitlabFormat\Console\Output\GitlabOutputFormatter;
// ...

return static function (ContainerConfigurator $containerConfigurator): void {
    // ...

    $containerConfigurator->services()->set(GitlabOutputFormatter::class);
};

对于 easy-coding-standard >=11.0

<?php

use LinasRam\EcsGitlabFormat\Console\Output\GitlabOutputFormatter;
// ...

return static function (ECSConfig $config): void {
    // ...

    $config->services()->set(GitlabOutputFormatter::class)
        ->autowire()
        ->tag(OutputFormatterInterface::class);
};

使用方法

使用 ecs 命令并带 --output-format=gitlab 选项运行。

vendor/bin/ecs --output-format=gitlab

GitLab CI

将以下任务包含到您的 .gitlab-ci.yml 文件中

ecs:
    script:
        - vendor/bin/ecs --output-format=gitlab > ecs-quality-report.json
    artifacts:
        reports:
            codequality: ecs-quality-report.json