Comment ajuster les règles de phpcs
J'utilise Syntastic pour vérifier mon code à chaque fois que je sauve dans Vim.
Pour PHP, Syntastic lance entre autres PHP_CodeSniffer, phpcs, pour la propreté du code.
Le problème, c'est que les règles par défaut sont un peu extrêmes.
Par exemple, les règles PSR2 interdisent les noms sans camel case tels que function send_mail(...)
.
On pourrait dire « Dans ce cas, n'utilise pas PSR2 ». Mais ce sont les règles les plus intéressantes, donc je voudrais juste les assouplir un peu pour supporter le code ancien.
Heureusement, on peut ajuster les règles de phpcs comme ceci :
- Copier le fichier
/usr/share/php/PHP/CodeSniffer/src/Standards/PSR2/ruleset.xml
dans~/CodeSniffer/Standards/PSR2/ruleset.xml
- Ajouter par exemple :
<rule ref="PSR1"> <exclude name="PSR1.Files.SideEffects"/> <exclude name="PSR1.Classes.ClassDeclaration.MissingNamespace"/> <exclude name="Squiz.Classes.ValidClassName.NotCamelCaps"/> </rule>
(pour la liste des règles :phpcs -e --standard=PSR2
, pour voir le détail d'une règle :grep -nri SideEffects /usr/share/php/PHP/CodeSniffer/
) - Mettre dans .vimrc
let g:syntastic_php_phpcs_args = '--standard=~/CodeSniffer/Standards/PSR2/ruleset.xml'