Comment lire un codebase inconnu en 30 minutes

Une méthode en 5 étapes pour ne plus être perdu face à un repo que tu n'as jamais vu — applicable dès aujourd'hui.

Tu arrives sur un nouveau projet. Le repo a 200 fichiers, 0 commentaire, et ton collègue est en vacances. Comment tu t’en sors ?

Voilà la méthode que j’utilise.

Étape 1 — Comprendre le contexte (5 min)

Avant de lire une ligne de code, comprends ce que le système fait :

  • README : existe-t-il ? Qu’est-ce qu’il dit ?
  • package.json : quelles sont les dépendances principales ? Un ORM ? Un framework d’état ? Un client HTTP ?
  • Les noms des dossiers : api/, services/, domain/ — l’organisation raconte une intention

Étape 2 — Trouver l’entry point (5 min)

Cherche où tout commence :

  • src/index.ts, src/main.ts, src/app.ts
  • Dans package.json : le champ "main" ou le script "start"
  • Pour un monorepo : cherche le package.json racine et les workspaces

L’entry point te montre l’ordre d’initialisation : DB, serveur, middlewares, routes.

Étape 3 — Cartographier les routes ou les features (10 min)

Pour une API : liste les routes. Pour une app : liste les pages ou les features. Ce sont les points d’entrée fonctionnels — ce que le système expose.

# Pour une API Express, cherche tous les .get/.post/.put/.delete
grep -r "router\.\(get\|post\|put\|delete\)" src/ --include="*.ts"

Tu n’as pas besoin de comprendre l’implémentation. Tu as besoin de savoir ce qui existe.

Étape 4 — Suivre un chemin critique (8 min)

Choisis la feature la plus centrale (souvent celle qui donne le nom au projet) et suis son exécution de bout en bout :

  1. Route → Handler
  2. Handler → Service / Use Case
  3. Service → Repository / DB
  4. Retour de la réponse

Ce chemin te donnera une vue complète de l’architecture réelle — pas celle prévue, celle qui existe.

Étape 5 — Identifier les patterns et les anomalies (2 min)

Avec tout ça, tu peux répondre à ces questions :

  • Quelle architecture est utilisée ? (MVC, hexagonale, flat…)
  • Y a-t-il de la cohérence ou des zones de chaos ?
  • Quelles sont les couches les plus complexes ?
  • Où sont les tests, s’ils existent ?

Ce que cette méthode ne remplace pas

Cette méthode te donne une carte du territoire — pas le territoire. Pour comprendre les détails, le contexte métier, les décisions historiques, il faut du temps.

Mais 30 minutes de lecture structurée valent mieux que 3 heures à dériver dans les helpers.