linasram/ecs-gitlab-format

GitLab output formatter for easy-coding-standard.

1.1.0 2024-05-20 11:57 UTC

Requires

• php: >=7.4
• ext-json: *
• symplify/easy-coding-standard: ^10.1 || ^11.0 || ^12.0

Requires (Dev)

• dg/bypass-finals: ^1.6
• phpstan/phpstan: ^1.11
• phpunit/phpunit: ^9.6

MIT

• Linas Ramanauskas

• static analysis
• gitlab
• Code style
• artifacts

README

A GitLab output formatter for easy-coding-standard. Generates code quality report in GitLab Code Quality format, so, you can see it in GitLab UI.

Installation

Install the package via Composer:

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

Configure your ecs.php file to use the formatter

For easy-coding-standard <11.0:

<?php

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

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

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

For 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);
};

Usage

Run the ecs command with the --output-format=gitlab option.

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

GitLab CI

Include the following job in your .gitlab-ci.yml file:

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