Le code
Réutiliser, ne rien dupliquer, écrire un code honnête, garder le dépôt lisible.
Ces règles valent pour toute personne ou tout agent qui écrit du code dans Ironlane. Une règle qu’un outil peut tenir est tenue par l’outil ; les autres se relisent.
Réutiliser et ne rien dupliquer
Section intitulée « Réutiliser et ne rien dupliquer »CODE-01 · Réutilisez avant d’écrire
Section intitulée « CODE-01 · Réutilisez avant d’écrire »Pourquoi. Un double finit par diverger : le jour où l’un change, deux écrans montrent deux valeurs pour la même donnée.
// app/factures/liste.tsxexport function ListeFactures() { // tableau réécrit : tri, filtres, défilement}// app/factures/liste.tsximport { TableauFiltrable } from "@/app/tableau-filtrable";
export function ListeFactures() { return <TableauFiltrable colonnes={colonnes} lignes={lignes} />;}Outil ESLint refuse de réécrire un composant partagé ; la détection des copies refuse un bloc de dix lignes écrit deux fois.
Relecture Le compte rendu nomme ce qui a été réutilisé.
CODE-02 · Calculez une définition métier à un seul endroit, côté serveur
Section intitulée « CODE-02 · Calculez une définition métier à un seul endroit, côté serveur »Pourquoi. Une règle écrite deux fois dit deux choses dès qu’on en change une.
// dans un écranconst enRetard = ligne.echeance < new Date() && ligne.statut !== "payee";// l'écran lit ce que la base a calculéconst { en_retard } = ligne;Outil Un contrôle compare deux écrans qui montrent le même chiffre.
Relecture Ce qui trahit une copie : la même condition dans plusieurs fichiers.
CODE-03 · Prenez le vocabulaire dans une table
Section intitulée « CODE-03 · Prenez le vocabulaire dans une table »Pourquoi. Si ajouter une valeur demande de toucher cinq fichiers, le vocabulaire est écrit en dur.
const ETATS = ["a_demarrer", "en_cours", "a_facturer"]; // dans l'écranconst etats = await lireLesEtats(); // table etat_operationRelecture Une liste de codes ou de libellés écrite dans un écran est refusée.
CODE-04 · Faites venir un compteur et sa liste de la même définition
Section intitulée « CODE-04 · Faites venir un compteur et sa liste de la même définition »const compteur = lignes.filter((l) => l.nouvelle).length;const liste = lignes.filter((l) => l.date > hier); // une autre règleconst compteur = lignes.filter((l) => l.nouvelle).length;const liste = lignes.filter((l) => l.nouvelle);Outil Un contrôle compare les chiffres entre écrans.
Relecture Le compteur touché égale la liste.
Écrire un code honnête
Section intitulée « Écrire un code honnête »CODE-05 · Dites que vous ne savez pas
Section intitulée « CODE-05 · Dites que vous ne savez pas »Pourquoi. Une valeur par défaut est un mensonge silencieux : le problème reste caché jusqu’à ce qu’il coûte.
const delai = ligne.delai ?? 30; // personne ne saura qu'il manquaitif (ligne.delai == null) { return { erreur: "Le délai n'est pas renseigné pour cette ligne." };}Outil Les tests de refus rejouent les erreurs de la base.
Relecture Une erreur se voit, avec son motif.
CODE-06 · Ne mettez rien en dur
Section intitulée « CODE-06 · Ne mettez rien en dur »if (jours > 30) relancer(client);if (jours > reglages.delaiDeRelance) relancer(client);Relecture Aucun outil ne voit un seuil écrit dans le code.
CODE-07 · Écrivez un commentaire qui dit ce que le code ne dit pas
Section intitulée « CODE-07 · Écrivez un commentaire qui dit ce que le code ne dit pas »Pourquoi. Le lecteur ne connaît ni l’histoire ni les gens du projet. L’histoire et la décision vont dans le message de commit.
// 12/10 : demandé par le bureau, passé à 30 jours// incrémente ii++;// Les montants sont en centimes : le serveur ne reçoit jamais de décimales.const centimes = Math.round(euros * 100);Outil Une règle ESLint refuse date, nom de personne et pictogramme dans un commentaire ; un contrôle équivalent passe sur le SQL.
Garder le dépôt lisible
Section intitulée « Garder le dépôt lisible »CODE-08 · Faites un commit par chose
Section intitulée « CODE-08 · Faites un commit par chose »Pourquoi. Un commit qui mélange tout ne se relit pas, ne se défait pas, et cache le vrai changement.
fix(facturation): corrige le total, déplace trois fichiers, passe Prettierrefactor(facturation): déplace le calcul du total dans lib/total.tsstyle(facturation): passe Prettier sur lib/total.tsfix(facturation): ne plus compter deux fois une facture partagéeOutil Un crochet vérifie la forme du message.
Relecture « Un commit, une chose » n’est vérifié que par la relecture.
Voir aussi. Les messages de commit
CODE-09 · Découpez un long fichier par déplacement pur
Section intitulée « CODE-09 · Découpez un long fichier par déplacement pur »commit 1 : découpe tableau.tsx ET corrige le tricommit 1 : déplace, sans changer une ligne, le tri dans tableau-tri.ts (compile, tests inchangés)commit 2 : corrige le triOutil ESLint refuse un fichier de plus de sept cents lignes.
Relecture La longueur d’une fonction se relit.
CODE-10 · Supprimez le code mort
Section intitulée « CODE-10 · Supprimez le code mort »export function ancienCalcul() { /* gardé « au cas où » */ }// supprimée ; son texte reste dans un dossier à part (sous-le-coude/) s'il vient de la baseOutil Knip refuse l’export que rien n’importe.
CODE-11 · Générez les types de la base
Section intitulée « CODE-11 · Générez les types de la base »Pourquoi. Une fonction renommée casse à la compilation, pas en production.
type Rappel = { id: string; echeance: string }; // copie écrite à la mainimport type { Database } from "@/lib/base.types";type Rappel = Database["public"]["Tables"]["rappel"]["Row"];Outil La compilation (tsc) échoue si un type ne correspond plus.
Référence rapide
Section intitulée « Référence rapide »| Règle | À retenir | Tenue par |
|---|---|---|
| CODE-01 | Réutilisez avant d’écrire | Outil, Relecture |
| CODE-02 | Calculez une définition métier à un seul endroit, côté serveur | Outil, Relecture |
| CODE-03 | Prenez le vocabulaire dans une table | Relecture |
| CODE-04 | Faites venir un compteur et sa liste de la même définition | Outil, Relecture |
| CODE-05 | Dites que vous ne savez pas | Outil, Relecture |
| CODE-06 | Ne mettez rien en dur | Relecture |
| CODE-07 | Écrivez un commentaire qui dit ce que le code ne dit pas | Outil |
| CODE-08 | Faites un commit par chose | Outil, Relecture |
| CODE-09 | Découpez un long fichier par déplacement pur | Outil, Relecture |
| CODE-10 | Supprimez le code mort | Outil |
| CODE-11 | Générez les types de la base | Outil |