Documentation

Exports publics

Comment traiter les exports packages comme contrat public.

Le champ exports du package.json de chaque package definit son contrat public. Importez via les entry points packages comme @plumile/router ou via les sous-chemins documentes uniquement.

Regles

  • Utiliser les entry points et sous-chemins documentes.
  • Ne pas atteindre les fichiers prives src/ d’un autre package.
  • Lorsqu’un export public est ajoute, mettre a jour l’entry point et le README du package dans le meme changement.
  • Lorsqu’un export change ou disparait, mettre a jour tests, exemples README et guides lies.

Fichiers utiles

  • packages/*/package.json pour les exports packages.
  • packages/*/src/index.ts pour les exports racine.
  • README packages pour les exemples publics.
  • TypeDoc pour la reference generee par symbole.