Avec l’édtieur de code Sublime Text, il est possible de rajouter des plugins vérifiant des règles de formattage vous assurant un code propre et cohérent en PHP ou en JS (et autres, non traités ici).

Ainsi, votre éditeur vous préviendra dès que vos règles de style (indentation, camelCase, indicateur de fin de commande, …) ne serons pas appliquées, et vous pourrez les corriger rapidement et ainsi produire un code « propre », au moins sur la syntaxe.
Si c’est pratique à titre individuel, ça devient indispensable sur des projets à plusieurs pour que tout le monde suive les mêmes guidelines.

Prérequis

Quelques prérequis sont nécessaires sur votre poste client, à savoir les outils qui en soit réalisent la validation de votre code.

phpCS

Installer php-cli si ce n’est déjà fait

sudo apt-get install php-cli

Puis installer codeSniffer qui se chargera de valider votre code

sudo apt-get install php-pear
sudo pear install PHP_CodeSniffer

jsHint

Installez jsHint à l’aide de npm (si vous ne l’avez pas… non mais vous êtes sérieux, vous ne l’avez pas ? Bref, jfag).

sudo npm install -g jshint

Installation dans SublimeText

Utilisez le gestionnaire de paquet en l’appellant avec « Ctrl + Shift + P » => Install Package.
Installez alors les paquets suivants :

  • SublimeLinter
  • SublimeLinter-phpcs
  • SublimeLinter-jshint

Configuration

Pour configurer les linters php et jshint, utilisez l’entrée classique du menu Preferences > Packages Settings > SublimeLinter > Settings – User

Vous pourrez alors spécifier les paramètres utiles, à savoir :

  • le chemin de votre règles phpcs.xml;
  • le style d’affichage à la detection d’une erreur (paramètre « mark_style » – voir les différents styles possibles ici);
  • l’affichage des erreurs au moment de la sauvegarde (« show_errors_on_save »: true)
  • … (plein d’autres paramètres mais la conf par défaut fonctionne bien).

A noter :

  • à l’install, si le fichier de configuration est vide, le copier depuis le fichier de configuration Default
  • la configuration de phpcs nécessite le reboot de sublime (Ctrl+Q, vous permettant de rouvrir la session et toutes les fenêtres que vous avez).

Retrouvez mon fichier de conf au besoin sur gist.

Article d’après les notes de mon collègues Christophe.