contao/easy-coding-standard

EasyCodingStandard configurations for Contao

3.1.1 2021-04-26 09:23 UTC

README

This package includes the EasyCodingStandard configurations for Contao.

Installation

You can install the package with Composer:

composer require contao/easy-coding-standard

Usage

Create a file named ecs.php in the root directory of your project.

<?php

declare(strict_types=1);

use PhpCsFixer\Fixer\Comment\HeaderCommentFixer;
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
use Symplify\EasyCodingStandard\ValueObject\Option;

return static function (ContainerConfigurator $containerConfigurator): void {
    $containerConfigurator->import(__DIR__.'/vendor/contao/easy-coding-standard/config/set/contao.php');

    $parameters = $containerConfigurator->parameters();
    $parameters->set(Option::LINE_ENDING, "\n");

    $services = $containerConfigurator->services();
    $services
        ->set(HeaderCommentFixer::class)
        ->call('configure', [[
            'header' => "This file is part of contao.org.\n\n(c) Leo Feyer\n\n@license proprietary",
        ]])
    ;
};

Adjust the header comment to your needs and then run the script like this:

vendor/bin/ecs check src tests

License

Contao is licensed under the terms of the LGPLv3.

Getting support

Visit the support page to learn about the available support options.