Passez à EditorConfig, ne vous souciez plus des styles

⏲️ ~2 min de lecture

Publié le par Frank

Vous avez bien mieux à faire que de vous quereller sur les choix de style d'indentation avec votre équipe. Définissez une fois pour toute vos conventions et tenez-vous y.

EditorConfig à la rescousse #

L'objectif d'Editorconfig est de garantir  la cohérence des styles d'édition dans vos projets. Il vous permet de spécifier dans un fichier de configuration :

Et s'il venait à votre équipe l'envie de changer de style d'indentation, une seule modification et tous les fichiers de votre projet seront mis à jour.

Exemple de fichier EditorConfig #

# Pas de fichier .editorconfig au dessus du dossier racine
root = true

# Valable pour tous types de fichiers
[*]

# Style d'indentation : Tabulation
indent_style = tab

# Encodage de caractères
charset = utf-8

# Fin de ligne (Unix)
end_of_line = lf

# Insérer une ligne de fin
insert_final_newline = true

# Suppression des espaces de fin
trim_trailing_whitespace = true

Les principaux éditeurs sont supportés, et les membre de notre équipe utilisent au grès de leur humeur Vim, SublimeText ou PHPStorm, sans que les styles des projets soient modifiés.

Nous considérons l'utilisation d'EditorConfig comme une très bonne pratique, que l'on retrouve appliquée sur beaucoup de projets open-source (CakePHP, Croogo, Symfony, etc ...) et que nous avons à notre tour petit à petit appliquée à tous nos projets.

Tant que votre code ne se lit pas comme de la prose, que l'indentation n'est pas cohérente, ne perdez pas de temps avec le choix des conventions et allez plutôt extraire une méthode, renommer une variable ou diviser une classe.

Pour plus d'informations, vous pouvez vous rendre sur le site d'EditorConfig ou bien voir les slides de Trey Hunner (Contributeur officiel d'EditorConfig)

Cet article vous a plu ? Sachez que nous recrutons !

← Accueil