EditorConfig
25 Juillet 2013
Travailler en équipe avec plusieurs systèmes d’exploitation, plusieurs éditeurs peut être rapidement devenir prise de tête. Les capacités des OS ne sont pas identiques, les éditeurs ne sont pas configurés de la même manière, les gouts et les couleurs des développeurs changent en fonction des saisons, etc. EditorConfig permet de ne plus se prendre la tête avec ses basses considérations et de facilement partager une configuration pour tous les membres de l’équipe…
EditorConfig est un outil qui permet de «stabiliser» un environnement de dev commun, particulièrement pratique quand toute la team n’a pas le même OS. Par exemple, vous voulez que tous les nouveaux fichiers soit encodés au format UTF-8 sauf les fichiers yaml ou vous voulez que vos fichiers soient indentés avec des tabulations mais que certains fichiers le soient avec des espaces et que les fin de lignes soient au format Unix… EditorConfig va permettre cela de manière quasi-transparente pour toute l’équipe.
Le principe d’EditorConfig est d’ajouter un fichier .editorconfig à la racine de votre projet, le partager grâce à votre VCS préféré et de configurer des règles que l’on veut appliquer à son projet, la configuration est très simple à comprendre et bien pensée (voir la documentation).
Pour tirer parti d’EditorConfig, il faut que toute l’équipe utilise l’un des éditeurs qui dispose du plugin dans la liste ci-dessous et l’installe le dit plugin :
J’ai utilisé EditorConfig pour un projet récemment et le faible investissement (installation & configuration) que cela représente en vaut largement la chandelle. Fini les retours chariots «à-la-windows» dans le code, les fichiers encodés en ISO-XXXX mais surtout c’est que tous les fichiers étaient formattés avec le même charactère (espace ou tab) et que cela est grandement appréciable.
Bref, EditorConfig est un petit outil sympatique et simple à mettre en place, le seul petit reproche que je peux lui faire c’est qu’il n’y a pas de plugin pour certains éditeur de texte qui sont quand même pas mal utilisé mais sinon c’est du tout bon…