PHP-CS-Fixer - mise en forme automatique du code PHP¶
L'outil php-cs-fixer permet la mise en forme automatique du code en fonction de règles de codage. Son utilisation évitera d'avoir un code mixant des styles différents dans le formatage du code, dans l'initialisation des tableaux ($tableau = []
ou $tableau = array()
),...
Mise en garde¶
- Avoir une version trop récente de PHP peut poser problème pour utiliser cet outil (il leur faut naturellement un peu de temps pour traiter les nouvelles syntaxes PHP)
- Voir PHP-CS-Fixer - Supported PHP Versions (
PHP_CS_FIXER_IGNORE_ENV
requis en avril 2025 pour PHP 8.4)
Installation¶
# Pour tous les projets (php-cs-fixer --help)
composer global require friendsofphp/php-cs-fixer
# En dépendance de dev d'un projet (vendor/bin/php-cs-fixer --help)
composer require --dev friendsofphp/php-cs-fixer
Utilisation en ligne de commande¶
Si on choisit de s'appuyer sur les règles de codage de Symfony, il suffit de lancer la commande suivante pour forcer l'application des règles dans le dossier src
:
php-cs-fixer fix src --rules @Symfony
Pour se contenter de valider les règles, il suffit de lancer la commande suivante :
php-cs-fixer fix src --rules $(PHP_CS_RULES) -v --dry-run --diff
Ressources¶
- github.com - mborne/remote-git - Makefile : exemple de makefile facilitant la mise en oeuvre d'une intégration continue (c.f. .github/workflows/ci.yml)