README.md

Ce dépôt contient la configuration par défaut de quelques outils utiles pendant le développement.

Installation

Cloner le dossier dans $HOME/.config/devtools.

git clone git@gitlab-ssh.irstea.fr:pole-is/devtools-config.git $HOME/.config/devtools

Utilisation

Globale

Créer des liens symboliques dans $HOME pour .editorconf et phpcs.xml.dist:

ln -snf $HOME/.config/devtools/php/phpcs.xml.dist $HOME/phpcs.xml.dist
ln -snf $HOME/.config/devtools/.editorconfig $HOME/.editorconfig

Enfin, configurer PHPStorm pour utiliser les fichiers $HOME/.config/devtools/php/phpcs.xml.dist et $HOME/.config/devtools/php/phpmd-ruleset.xml pour phpcs et phpmd respectivement.

Par projet

php-cs-fixer nécessite de copier le fichier directement dans le projet :

cp $HOME/.config/devtools/php/.php_cs.dist chemin/vers/mon/projet

Pour phpcs et phpmd, c'est également nécessaire pour l'intégration continue.

Outils

• editorconfig: permet de configurer globalement l'encodage, l'indentation et la gestion des espaces.

• phpcs: vérification du style de codage.

• php-cs-fixer: cousin de phpcs, mais qui permet de corriger les fichiers et inclut également des aide pour migrer d'une version de PHP à une autre.

• phpmd: détection de bugs potentielles, de fonctions/classes trop complexes, ...