CS Fixer : mise en place et utilisation

CS Fixer est un outil développé par Symfony dont le but est la mise en conformité du code source d’un projet PHP et optimisé pour Symfony. Il repose sur un ensembles de règles adoptées par Symfony, mais également de la norme PSR-2 instaurée par le collectif PHP-FIG. C’est un outil indispensable en création de Site Internet en PHP par exemple.

L’utilisation d’un tel outil est indispensable pour disposer d’un code propre, compréhensible. Ces critères permettront à un autre développeur ou vous-même de faire évoluer votre projet.

Prérequis

Il est supposé que l’outil Composer est installé et accessible en ligne de commande sur la machine. De très nombreux outils et paquets pour PHP sont disponible avec Composer. Par ailleurs Composer est indispensable à l’utilisation du Framework Symfony.

Installation de CS Fixer

Il est recommandé de l’installer en global via composer afin de pouvoir l’exécuter sans contrainte.

# installation
composer global require friendsofphp/php-cs-fixer

# export dans les variables d'environnement si besoin
export PATH="$PATH:$HOME/.composer/vendor/bin"

Utilisation avec PHPStorm

L’idéal est de le configurer avec PHPStorm en suivant le guide d’installation recommandé dans la documentation officielle : How to configure PHPStorm to use PHP-CS-Fixer.

Une fois la configuration de PHPStorm terminée, vous devriez pouvoir exécuter automatiquement CS Fixer à l’aide du raccourci Alt + F, voici la configuration External Tool recommandée.

Program: C:\Users\<NOM UTILISATEUR>\AppData\Roaming\Composer\vendor\bin\php-cs-fixer.bat

Arguments: fix src --verbose --rules=@Symfony

Working directory: $ProjectFileDir$

Exécution manuelle de CS Fixer

Vous pouvez l’exécuter manuellement à la racine de votre projet Symfony. LA commande suivante va arranger votre code selon les règles de Symfony. A la fin, vous disposez d’un rapport des actions effectuées.

php-cs-fixer fix src --verbose --rules=@Symfony