Atom est un IDE fascinant.

Voyons ensemble aujourd’hui comment reformater son code.

reformater avec atom ? atom-beautify !

Je veux reformater mon code, comment faire ?

Atom embarque nativement le plugin atom-beautify. Ce dernier permet de reformater votre code en respectant des standards établis pour chaque language.

En fonction du language avec lequel vous codez, il sera peut-être nécessaire de procéder à des installations complémentaires pour profiter de la puissance d’atom-beautify.

Voyons un exemple avec le langage PHP et php-cs-fixer.

Nous allons devoir installer le paquer php-cs-fixer. Pour cela, on peut aller voir la page du projet sur GitHub. Le documentation d’installation nous propose plusieurs possibilité d’installation. Nous choisirons cette faisant appel à Composer.

Vu qu’il s’agit d’une installation globale, je vous recommande de mettre à jour votre composer afin d’éviter le type d’erreur suivant :

composer erreur de dépendances

Vous pouvez consulter notre article Composer mise à jour « global » pour remédier à ce genre d’erreur.

Si votre composer est à jour ou que vous venez de le mettre à jour, vous pouvez alors lancer :

composer global require friendsofphp/php-cs-fixer

Si tout se passe bien, vous aurez peu ou prou l’affichage suivant :

composer require friendsofphp/php-cs-fixer done !
composer require friendsofphp/php-cs-fixer done !

A présent, vous pouvez retourner dans Atom, ouvrir une page de code php et soit :

  • effectuer la combinaison de touche ctrl + alt + B
  • cliquer dans le menu Packages > Atom Beautify > Beautify
  • cliquer à droite sur votre code et choisir Beautify

Un exemple ?

Voici un exemple de ce qu’il ne faut pas faire :

Du code PHP illisible !
Du code PHP illisible !

Sur ce code, un simple ctrl + alt + B, vous reformatera le code selon les standards :

Du code PHP lisible et répondant au standard PEAR
Le code reformaté avec Atom-beautify

Bon c’est super en effet, mais je vais vite me lasser de faire sans arrêt un CTRL + ALT + B moi 🙁

Holala, ce que vous êtes fainéant ! Cela dit être fainéant pour un développeur c’est se consacrer sur les choses essentielles comme développer du code plutôt que de le reformater.

Après cette argumentation, je n’ai d’autre choix que de vous indiquer comment automatiser tout cela !

Le reformatage automatique

Dans les options d’Atom-Beautify, vous pouvez pour chaque langage supporté, indiquer si vous souhaitez le reformater à la sauvegarde. Là cela devient génial, car le CTRL + S fait partie intégrante de notre ADN. Donc d’une pierre, deux coups.

Allez je vous montre :

  • Allez dans les settings de Beautify
Accéder au settings de Beautify
Accéder au settings de Beautify
  • Choisissez le langage pour lequel vous souhaitez activer le « beautify » à la sauvegarde du fichier
Activer le reformatage du code à la sauvegarde
Activer le reformatage du code à la sauvegarde

Et voilà !

Lors de la prochaine sauvegarde des fichiers PHP, votre code sera remis en forme. Ce n’est pas top, tout ça ?

Et si je veux choisir mon standard de codage PHP (PHP coding standard) ?

C’est possible. Toujours dans les options du langage PHP, vous trouverez une ligne nommée : PHPCBF Standard.

PHPCBF pour PHP Code Beautifier and Fixer. Vous pouvez voir sur la capture ci-dessous qu’actuellement sont supportés les standards suivants :

Choix des PHP Coding Standard

Je code avec Laravel, Blade est supporté ?

Oui ! Mais seulement depuis la version 0.32.3. Le reformatage de Blade est porté par le moteur JS Beautify.

Conclusion

Atom permet de se soulager de la relecture de code pour produire un code propre et répondant aux standards de notre métier. Il permet également d’automatiser cette tâche lors de la sauvegarde de notre travail.

Vous n’avez plus d’excuse pour ne pas utiliser cette fonctionnalité.

Tous les commentaires et précisions sont les bienvenus !