Aller au contenu

Le code

Réutiliser, ne rien dupliquer, écrire un code honnête, garder le dépôt lisible.

Voir en Markdown

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.

Pourquoi. Un double finit par diverger : le jour où l’un change, deux écrans montrent deux valeurs pour la même donnée.

À éviter
// app/factures/liste.tsx
export function ListeFactures() {
// tableau réécrit : tri, filtres, défilement
}
À faire
// app/factures/liste.tsx
import { 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.

À éviter
// dans un écran
const enRetard = ligne.echeance < new Date() && ligne.statut !== "payee";
À faire
// 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.

Pourquoi. Si ajouter une valeur demande de toucher cinq fichiers, le vocabulaire est écrit en dur.

À éviter
const ETATS = ["a_demarrer", "en_cours", "a_facturer"]; // dans l'écran
À faire
const etats = await lireLesEtats(); // table etat_operation

Relecture 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 »
À éviter
const compteur = lignes.filter((l) => l.nouvelle).length;
const liste = lignes.filter((l) => l.date > hier); // une autre règle
À faire
const 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.

Pourquoi. Une valeur par défaut est un mensonge silencieux : le problème reste caché jusqu’à ce qu’il coûte.

À éviter
const delai = ligne.delai ?? 30; // personne ne saura qu'il manquait
À faire
if (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.

À éviter
if (jours > 30) relancer(client);
À faire
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.

À éviter
// 12/10 : demandé par le bureau, passé à 30 jours
// incrémente i
i++;
À faire
// 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.

Pourquoi. Un commit qui mélange tout ne se relit pas, ne se défait pas, et cache le vrai changement.

À éviter
fix(facturation): corrige le total, déplace trois fichiers, passe Prettier
À faire
refactor(facturation): déplace le calcul du total dans lib/total.ts
style(facturation): passe Prettier sur lib/total.ts
fix(facturation): ne plus compter deux fois une facture partagée

Outil 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 »
À éviter
commit 1 : découpe tableau.tsx ET corrige le tri
À faire
commit 1 : déplace, sans changer une ligne, le tri dans tableau-tri.ts (compile, tests inchangés)
commit 2 : corrige le tri

Outil ESLint refuse un fichier de plus de sept cents lignes.

Relecture La longueur d’une fonction se relit.

À éviter
export function ancienCalcul() { /* gardé « au cas où » */ }
À faire
// supprimée ; son texte reste dans un dossier à part (sous-le-coude/) s'il vient de la base

Outil Knip refuse l’export que rien n’importe.

Pourquoi. Une fonction renommée casse à la compilation, pas en production.

À éviter
type Rappel = { id: string; echeance: string }; // copie écrite à la main
À faire
import 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è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