Fatigué de Débattre du Style de Code ? Automatisez Votre Chemin vers la Cohérence

Chaque développeur est passé par là. Vous êtes en train de relire une pull request (PR), prêt à plonger dans la logique… mais tout ce que vous voyez, ce sont des millions de modifications de mise en forme.

Une ligne un peu trop longue, des imports en désordre, ou un bloc de déclarations de variables qui ne s’aligne pas correctement.

Voici à quoi ça peut ressembler dans un langage comme Go :

Code moche et incohérent :

 1 package main
 2
 3import "time"
 4import "fmt"
 5
 6func aVeryLongFunction(paramOne string, paramTwo int, paramThree bool, paramFour float64) {
 7    longList := []string{fmt.Sprintf("paramOne is %s", paramOne), fmt.Sprintf("paramTwo is %d", paramTwo), fmt.Sprintf("paramThree is %t", paramThree), fmt.Sprintf("paramFour is %f", paramFour)};
 8    anotherVariable := 1
 9    short := 2
10  doSomethingWith(long_list, anotherVariable, short, time.Now())
11}

Code propre, lisible et bien formaté :

 1package main
 2
 3import (
 4  "fmt"
 5  "time"
 6)
 7
 8func aVeryLongFunction(
 9  paramOne string,
10  paramTwo int,
11  paramThree bool,
12  paramFour float64,
13) {
14  longList := []string{
15    fmt.Sprintf("paramOne is %s", paramOne), 
16    fmt.Sprintf("paramTwo is %d", paramTwo), 
17    fmt.Sprintf("paramThree is %t", paramThree), 
18    fmt.Sprintf("paramFour is %f", paramFour)
19  };
20  anotherVariable    := 1
21  short              := 2
22  doSomethingWith(long_list, anotherVariable, short, time.Now())
23}

Ce n’est pas juste une question d’esthétique : c’est aussi une question de charge mentale que vous imposez à vous-même et à votre équipe.

​

Le Problème de l’Incohérence

Quand les styles de code varient, cela crée des frictions inutiles. Les revues de code se transforment en débats sur les points-virgules et l’indentation.

La fusion de branches devient plus compliquée, car les diffs sont pleins de bruit au lieu de vrais changements.

L’intégration des nouveaux développeurs devient une leçon sur des règles de style non écrites plutôt qu’une explication de la logique métier.

​

La Puissance de l’Automatisation

La solution ? Arrêtez de faire ça à la main. Les formateurs de code automatisés existent pour presque tous les langages modernes.

Ils sont conçus pour appliquer un style cohérent en analysant votre code et en le réimprimant selon un ensemble strict de règles.

Cela apporte des bénéfices immédiats :

• Des PRs claires et pertinentes : Les revues peuvent se concentrer sur la logique et l’architecture, pas sur le style.
• Moins de Frictions : Les débats « tabs vs espaces » ou sur l’emplacement des accolades disparaissent.
• Intégration plus rapide : Les nouveaux développeurs peuvent contribuer immédiatement sans apprendre un guide de style complexe.
• Une Source de Vérité Unique : Votre base de code devient cohérente, peu importe qui écrit le code.

​

Le Bon Outil pour le Bon Langage

La plupart des langages ont un outil unique, accepté par la communauté. Vous pouvez les exécuter manuellement ou les configurer pour s’exécuter automatiquement à l’enregistrement dans votre éditeur.

​

Intégrez-le dans votre CI/CD

La dernière étape pour garantir la cohérence est d’intégrer ces outils dans votre pipeline CI/CD.

Ajoutez une vérification simple ou une étape de formatage automatique. Vous pouvez les intégrer dans vos hooks de pre-commit ou dans vos workflows de pull request. Cela garantit que chaque ligne de code est bien formatée.

Pas besoin d’écrire un script CI complexe. La plupart des plateformes DevOps ont une documentation complète. Il existe aussi des modèles fournis par la communauté pour démarrer rapidement.

Voici quelques ressources utiles pour intégrer le formatage automatique :

• GitHub Actions : Créer un workflow GitHub Actions pour le formatage de code
• GitLab CI/CD : Utiliser les rapports de qualité de code dans GitLab CI/CD
• Bitbucket Pipelines : Exemple de pipeline Bitbucket avec dotnet format
• Azure DevOps : Utiliser l’extension “Format Check” dans Azure Pipelines

Arrêtez de perdre du temps à débattre sur la mise en forme. Automatisez les tâches ennuyeuses et concentrez-vous sur l’essentiel : écrire du bon code.