Utiliser ECS

SPIP propose un jeu de règles pour Easy Coding Standard (https://github.com/easy-coding-standard/easy-coding-standard) via le dépôt spip-league/easy-coding-standard.

L’utiliser permet de s’assurer de respecter les conventions d’écriture PHP utilisées dans la communauté SPIP.

Préalable

Il faut un fichier composer.json à la racine du plugin, dans lequel on déclare le dépôt composer propre à SPIP :

{
    "repositories": {  
        "spip": {  
            "type": "composer",  
            "url": "https://get.spip.net/composer"  
        }  
    }
}

Installation

L’installation se fait avec la commande :

composer require --dev spip-league/easy-coding-standard

Configuration

Créez le fichier ecs.php à la racine de votre plugin :

<?php  
  
use SpipLeague\EasyCodingStandard\Set\SetList;  
use Symplify\EasyCodingStandard\Config\ECSConfig;  
  
return ECSConfig::configure()  
    ->withSets([SetList::SPIP])  
    ->withPaths([__DIR__])  
    ->withRootFiles()  
    ->withSkip([__DIR__ . '/lang', __DIR__ . '/vendor'])  
;

Usage

Pour en faciliter l’usage, on peut ajouter des "alias" dans les scripts du fichier composer.json :

    "scripts": {  
        "check-cs": "vendor/bin/ecs check --ansi",  
        "fix-cs": "vendor/bin/ecs check --fix --ansi"  
    }  

composer fix-cs
composer fix-cs inc/inc.inc

Auteur bricebou Publié le :