irstea/php-cs-fixer-config

Configuration pour PHP-CS-Fixer.

Installation

composer require --dev irstea/php-cs-fixer-config

Configuration

La configuration se fait dans un fichier .php_cs.dist comme avec PHP-CS-Fixer, mais en utilisant la classe Irstea\CS\Config.

Exemple :

<?php

$finder = PhpCsFixer\Finder::create()
    ->exclude('vendor')
    ->exclude('var')
    ->files()
    ->name('*.php')
    ->in('.');

return Irstea\CS\Config::create()
    ->setRiskyAllowed(true) // recommandé pour les nouveaux projets, à tester avec de vieux projets.
    ->setIndent('    ')
    ->setLineEnding("\n")
    ->setFinder($finder);

Pour plus de détails, cf. https://cs.symfony.com/#usage

En-tête de fichiers

Un modèle d'en-tête (cf. règle header_comment) peut être défini dans un fichier .docheader. Les tags %package% et %yearRange% sont remplacés automatiquement à partir des informations du dépôt git et de composer.json.

Exemple :

This file is part of "%package%".
(c) %yearRange% Irstea <dsi.poleis@irstea.fr>

For the full copyright and license information, please view the LICENSE
file that was distributed with this source code.

Usage

vendor/bin/php-cs-fixer fix

cf. https://cs.symfony.com/#usage